com.intersys.objects.reflect
Interface CacheDescription

All Known Subinterfaces:
CacheArgument, CacheField

public interface CacheDescription

This interface represents common information about Cache concepts like Property definition or Method arguments definitions.

See Also:
CacheField, CacheMethod

Method Summary
 Object getDefaultValue()
          Returns the default value if it is defined represented by an Object of appropriate type.
 String getDefaultValueString()
          Returns the default value if it is defined in String representation.
 String getElementTypeName()
          This method is meaningful only if the essense is of collection type.
 String getJavaTypeName()
          Returns the name of corresponding Java class.
 int getModifiers()
          Returns modifier flags which can be used to determine whether the described essence is literal or object, static or per instance, has default value or not, etc.
 String getName()
          Returns the name of the essence
 CacheClass getType()
          Returns the CacheClass corresponding to the type of this essense.
 String getTypeName()
          Returns the name of the Cache class corresponding to the type of this essense.
 

Method Detail

getName

public String getName()
Returns the name of the essence

Returns:
Name of the Cache essence represented as String

getDefaultValueString

public String getDefaultValueString()
Returns the default value if it is defined in String representation.

Returns:
the default value represented as String.

getDefaultValue

public Object getDefaultValue()
Returns the default value if it is defined represented by an Object of appropriate type.

Returns:
the default value represented as Object.

getType

public CacheClass getType()
                   throws CacheException
Returns the CacheClass corresponding to the type of this essense. Invocation of this method will cause Java client to request loading corresponding class from the Database. Use getTypeName to avoid loading CacheClass.

Returns:
type of the essence represented as CacheClass object.
Throws:
CacheException

getTypeName

public String getTypeName()
Returns the name of the Cache class corresponding to the type of this essense.

Returns:
type name of the essence represented as String.

getElementTypeName

public String getElementTypeName()
This method is meaningful only if the essense is of collection type. In this case it will return the name of the type of elements in the collection.

Returns:
Name of type of elements in collection if the essense is of collection type.

getJavaTypeName

public String getJavaTypeName()
Returns the name of corresponding Java class.

Returns:
Name of corresponding Java class represented as String.

getModifiers

public int getModifiers()
Returns modifier flags which can be used to determine whether the described essence is literal or object, static or per instance, has default value or not, etc. The CacheModifier class should be used to decode the modifiers.

Returns:
modifiers represented as an int.
See Also:
CacheModifier