IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.framework.uml2
Class PatternMetatype.Enumeration

java.lang.Object
  extended bycom.ibm.xtools.patterns.framework.PatternMetatype
      extended bycom.ibm.xtools.patterns.framework.uml2.PatternMetatype
          extended bycom.ibm.xtools.patterns.framework.uml2.PatternMetatype.Enumeration
All Implemented Interfaces:
IPatternMetatype, ITransformationItem
Enclosing class:
PatternMetatype

public static class PatternMetatype.Enumeration
extends PatternMetatype

An enumeration metatype, defines enumeration literals as potential values.


Nested Class Summary
 
Nested classes inherited from class com.ibm.xtools.patterns.framework.uml2.PatternMetatype
PatternMetatype.Enumeration
 
Field Summary
 
Fields inherited from class com.ibm.xtools.patterns.framework.uml2.PatternMetatype
BOOLEAN_METATYPE, INTEGER_METATYPE, STRING_METATYPE
 
Fields inherited from class com.ibm.xtools.patterns.framework.PatternMetatype
metaClass
 
Method Summary
 boolean equals(Object object)
           
 String getDescription()
          Retrieve the localized description of the transformation item.
 org.eclipse.emf.ecore.EClass getEClass()
          Returns the EClass representing the metatype, if the associated metamodel is an EMF metamodel.
 IEnumerationLiteral[] getEnumerationLiterals()
          Returns the array of enumeration literals for an enumeration metatype.
 String getId()
          Retrieve the unique id of the transformation item.
 String getMetamodelName()
          Returns the name of the metamodel of the metatype.
 String getName()
          Retrieve the localized name of the transformation item.
 int hashCode()
           
 boolean isEnumeration()
          Indicates whether the metatype is an enumeration.
 boolean isValidValue(Object object)
          Indicates whether the given object is a valid value of the metatype.
 String toString()
           
 
Methods inherited from class com.ibm.xtools.patterns.framework.uml2.PatternMetatype
getImage
 
Methods inherited from class com.ibm.xtools.patterns.framework.PatternMetatype
getMetamodel, isAssignableFrom
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

equals

public boolean equals(Object object)
Overrides:
equals in class PatternMetatype

hashCode

public int hashCode()
Overrides:
hashCode in class PatternMetatype

getDescription

public String getDescription()
Description copied from interface: ITransformationItem
Retrieve the localized description of the transformation item.

Specified by:
getDescription in interface ITransformationItem
Overrides:
getDescription in class PatternMetatype

getEClass

public org.eclipse.emf.ecore.EClass getEClass()
Description copied from interface: IPatternMetatype
Returns the EClass representing the metatype, if the associated metamodel is an EMF metamodel.

Specified by:
getEClass in interface IPatternMetatype
Overrides:
getEClass in class PatternMetatype

getEnumerationLiterals

public IEnumerationLiteral[] getEnumerationLiterals()
Description copied from interface: IPatternMetatype
Returns the array of enumeration literals for an enumeration metatype.

Specified by:
getEnumerationLiterals in interface IPatternMetatype
Overrides:
getEnumerationLiterals in class PatternMetatype

getId

public String getId()
Description copied from interface: ITransformationItem
Retrieve the unique id of the transformation item.

Specified by:
getId in interface ITransformationItem
Overrides:
getId in class PatternMetatype

getMetamodelName

public String getMetamodelName()
Description copied from interface: IPatternMetatype
Returns the name of the metamodel of the metatype. If the metatype is an enumeration type defined by a pattern library, then the metamodel name is the library name.

Specified by:
getMetamodelName in interface IPatternMetatype
Overrides:
getMetamodelName in class PatternMetatype

getName

public String getName()
Description copied from interface: ITransformationItem
Retrieve the localized name of the transformation item.

Specified by:
getName in interface ITransformationItem
Overrides:
getName in class PatternMetatype

isEnumeration

public boolean isEnumeration()
Description copied from interface: IPatternMetatype
Indicates whether the metatype is an enumeration.

The metatype is an enumeration if the values of the type are a fixed set of enumeration literals. Use the getEnumerationLiterals method to retrieve the array of enumeration literals.

Specified by:
isEnumeration in interface IPatternMetatype
Overrides:
isEnumeration in class PatternMetatype

isValidValue

public boolean isValidValue(Object object)
Description copied from interface: IPatternMetatype
Indicates whether the given object is a valid value of the metatype.

Specified by:
isValidValue in interface IPatternMetatype
Overrides:
isValidValue in class PatternMetatype

toString

public String toString()
Overrides:
toString in class PatternMetatype

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.