Java API ReferenceClass Hierarchy | All Classes | All Fields and Methods

com.ibm.xtools.patterns.framework

Class PatternMetatype

+-- Object
      +-- PatternMetatype

public Class PatternMetatype
extends Object

Represents the abstract class that is the common implementation for a pattern metatype that represents an EClass in an EMF metamodel.


Constructor summary
PatternMetatype(EClass type)

Constructs a pattern metatype given an EClass to represent the element type.

Method summary
ObjectensureType(Object value)

Retrieves the type value.

booleanequals(Object object)

Compares for equality through the default implementation of java.lang.Object.equals(Object).

ListgetAlternateTypes()

Retrieves the array of pattern type objects.

StringgetDescription()

Retrieves the pattern description.

EClassgetEClass()

Retrieves the EClass that represents the element type.

IEnumerationLiteralgetEnumerationLiterals()

Retrieves the IEnumerationLiteral objects.

StringgetId()

Retrieves the Id of the object.

StringgetImage(Object object)

Retrieves a string representing the image value.

EPackagegetMetamodel()

Retrieves the EPackage representing the metamodel name value.

StringgetMetamodelName()

Retrieves a string representing the metamodel name value.

StringgetName()

Retrieves the name of the object.

inthashCode()

Retrieves the hash code value of the parameter.

booleanisAssignableFrom(IPatternMetatype metatype)

Retrieves whether the object has a metatype.

booleanisEnumeration()

Retrieves whether the object is an enumeration.

booleanisValidValue(Object object)

Retrieves whether the object has a valid value.

StringtoString()

Retrieves the string value.

Constructor detail

PatternMetatype

public PatternMetatype(EClass type)

Constructs a pattern metatype given an EClass to represent the element type.

Parameters:

type
- The EClass for the element type.

Method detail

ensureType

public Object ensureType(Object value)

Retrieves the type value.

Parameters:

value
- The type value to ensure.

Returns:

A String representing the type value.

equals

public boolean equals(Object object)

Compares for equality through the default implementation of java.lang.Object.equals(Object).

Parameters:

object
- The object to be compared.

Returns:

A boolean value of true if the object is equal. Otherwise, it returns a value of false.

getAlternateTypes

public List getAlternateTypes()

Retrieves the array of pattern type objects.

Returns:

A List of IPatternMetatype objects representing the alternate type values.

getDescription

public String getDescription()

Retrieves the pattern description.

Returns:

A string representing the description value.

getEClass

public EClass getEClass()

Retrieves the EClass that represents the element type.

Returns:

The EClass value.

getEnumerationLiterals

public IEnumerationLiteral getEnumerationLiterals()

Retrieves the IEnumerationLiteral objects.

Returns:

An array of IEnumerationLiteral objects representing the enumeration literals value.

getId

public String getId()

Retrieves the Id of the object.

Returns:

The Id of the object.

getImage

public String getImage(Object object)

Retrieves a string representing the image value.

Parameters:

object
- The object for which to retrieve the image.

Returns:

A string representing the object image value.

getMetamodel

public EPackage getMetamodel()

Retrieves the EPackage representing the metamodel name value.

Returns:

An EPackage object representing the metamodel name value.

getMetamodelName

public String getMetamodelName()

Retrieves a string representing the metamodel name value.

Returns:

A string representing the metamodel name value.

getName

public String getName()

Retrieves the name of the object.

Returns:

A string representing the name value.

hashCode

public int hashCode()

Retrieves the hash code value of the parameter.

Returns:

An integer representing the value.

isAssignableFrom

public boolean isAssignableFrom(IPatternMetatype metatype)

Retrieves whether the object has a metatype.

Parameters:

metatype
- The metatype to search.

Returns:

A boolean value of true if the object has metatype. Otherwise, it returns a value of false.

isEnumeration

public boolean isEnumeration()

Retrieves whether the object is an enumeration.

Returns:

A boolean value of true if the object is an enumeration. Otherwise, it returns a value of false.

isValidValue

public boolean isValidValue(Object object)

Retrieves whether the object has a valid value.

Parameters:

object
- The object to search.

Returns:

A boolean value of true if the object has valid value. Otherwise, it returns a value of false.

toString

public String toString()

Retrieves the string value.

Returns:

A string representing the value.


Feedback