artefaktur
software engineer &        architecture

 
 
 
 

class Enumeration

Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

acdk::lang::reflect::Enumeration Class Reference

#include <Enumeration.h>

Inheritance diagram for acdk::lang::reflect::Enumeration:

acdk::lang::reflect::AccessibleObject acdk::lang::dmi::MetaObject acdk::lang::Object acdk::lang::ObjectBase acdk::lang::dmi::StdDispatch List of all members.

Detailed Description

Represents the Enumeration.


Public Member Functions

 Enumeration (const acdk::lang::dmi::ClazzEnumInfo *ei)
 internal constructor

RString getEnumNameForValue (int value)
 return the symbolic name (without namespace) for the given value.

virtual dmi::MetaInfogetMetaInfo ()
 implemented interface for MetaObject

const acdk::lang::dmi::ClazzEnumInfogetClazzEnumInfo ()
virtual RString getName ()
 returns the ClassName for this object by default

virtual bool equals (IN(RObject) obj)
 Normally check for equality (not identity) Object::equals() is true only if both objects are the same instance.

int compareTo (IN(REnumeration) other)
int compareTo (IN(RObject) other)
 compares t objects Object::compareTo() UnsupportedOperationException

virtual int hashCode ()
virtual RString toString ()
 return a string representation of this object Object::toString() return getName() by default

virtual RString toIndentifier ()
virtual RString toTypeString (int format=acdk::lang::dmi::TpFtFormatStandard)
 print the information

REnumerationValueArray getValues ()

Static Public Member Functions

REnumeration getEnumeration (IN(RString) enumName, IN(RString) namesp)
 return the Enumeration with given name.

REnumerationValue getEnumerationValue (IN(RString) enumName, IN(RString) namesp)
 return the Enumeration with given name.

RString getEnumNameForValue (IN(RString) enumName, int value)
 return the symbolic name (without namespace) for the given value.

REnumerationArray getEnumerations ()
 returns all registered Enumerations


Private Attributes

const acdk::lang::dmi::ClazzEnumInfo_enumInfo

Constructor & Destructor Documentation

acdk::lang::reflect::Enumeration::Enumeration const acdk::lang::dmi::ClazzEnumInfo ei  )  [inline]
 

internal constructor


Member Function Documentation

int acdk::lang::reflect::Enumeration::compareTo IN(RObject other  )  [inline, virtual]
 

compares t objects Object::compareTo() UnsupportedOperationException

Returns:
0 if equal 1 if this object is greater, -1 if ohter
Exceptions:
UnsupportedOperationException 

Reimplemented from acdk::lang::Object.

int acdk::lang::reflect::Enumeration::compareTo IN(REnumeration other  )  [inline]
 

virtual bool acdk::lang::reflect::Enumeration::equals IN(RObject obj  )  [virtual]
 

Normally check for equality (not identity) Object::equals() is true only if both objects are the same instance.

See also:
serialized_equals()

Reimplemented from acdk::lang::Object.

const acdk::lang::dmi::ClazzEnumInfo* acdk::lang::reflect::Enumeration::getClazzEnumInfo  )  [inline]
 

REnumeration acdk::lang::reflect::Enumeration::getEnumeration IN(RString enumName,
IN(RString namesp
[static]
 

return the Enumeration with given name.

Parameters:
enumName name of Enumeration in the form
namesp namespace of the enumeration, may be Nil
Returns:
Nil if given Enumeration is not registered

REnumerationArray acdk::lang::reflect::Enumeration::getEnumerations  )  [static]
 

returns all registered Enumerations

REnumerationValue acdk::lang::reflect::Enumeration::getEnumerationValue IN(RString enumName,
IN(RString namesp
[static]
 

return the Enumeration with given name.

Parameters:
enumName name of Enumeration in the form
namesp namespace of the enumeration, may be Nil
Returns:
Nil if given Enumeration is not registered

RString acdk::lang::reflect::Enumeration::getEnumNameForValue IN(RString enumName,
int  value
[static]
 

return the symbolic name (without namespace) for the given value.

return Nil if no information for enumName can be found or this enumeration has no such value getEnumNameForValue

RString acdk::lang::reflect::Enumeration::getEnumNameForValue int  value  ) 
 

return the symbolic name (without namespace) for the given value.

return Nil if this enumeration has no such value If an enumeration multiple enum values has the same integer value this method returns the first found.

virtual dmi::MetaInfo* acdk::lang::reflect::Enumeration::getMetaInfo  )  [inline, virtual]
 

implemented interface for MetaObject

Reimplemented from acdk::lang::dmi::MetaObject.

virtual RString acdk::lang::reflect::Enumeration::getName  )  [virtual]
 

returns the ClassName for this object by default

Reimplemented from acdk::lang::Object.

REnumerationValueArray acdk::lang::reflect::Enumeration::getValues  ) 
 

virtual int acdk::lang::reflect::Enumeration::hashCode  )  [inline, virtual]
 

See also:
serialized_hashCode

Reimplemented from acdk::lang::Object.

virtual RString acdk::lang::reflect::Enumeration::toIndentifier  )  [virtual]
 

virtual RString acdk::lang::reflect::Enumeration::toString  )  [inline, virtual]
 

return a string representation of this object Object::toString() return getName() by default

Reimplemented from acdk::lang::Object.

virtual RString acdk::lang::reflect::Enumeration::toTypeString int  format = acdk::lang::dmi::TpFtFormatStandard  )  [inline, virtual]
 

print the information

Parameters:
format combination of acdk::lang::dmi::TypeNameFormat

Implements acdk::lang::dmi::MetaObject.


Member Data Documentation

const acdk::lang::dmi::ClazzEnumInfo* acdk::lang::reflect::Enumeration::_enumInfo [private]
 

 
Last modified 2005-05-08 18:32 by SYSTEM By Artefaktur, Ing. Bureau Kommer