com.sleepycat.persist.impl

Class EnumFormat

java.lang.Object

com.sleepycat.persist.impl.Format

com.sleepycat.persist.impl.EnumFormat

All Implemented Interfaces:

RawType, Serializable

public class EnumFormat
extends Format

Format for all enum types. In this class we resort to using reflection to allocate arrays of enums. If there is a need for it, reflection could be avoided in the future by generating code as new array formats are encountered.

Author:

Mark Hayes

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
List<String>	getEnumConstants() Returns an unmodifiable list of the names of the enum instances, or null if this is not an enum type.
boolean	isEnum() Returns whether this is an enum type.
Object	newInstance(EntityInput input, boolean rawAccess) Creates a new instance of the target class using its default constructor.
Object	readObject(Object o, EntityInput input, boolean rawAccess) Called after newInstance() to read the rest of the data bytes and fill in the object contents.

Methods inherited from class com.sleepycat.persist.impl.Format

allowEvolveFromProxy, getAccessor, getClassMetadata, getClassName, getComponentType, getDimensions, getEntityMetadata, getFields, getId, getOldKeyName, getPreviousVersion, getSuperType, getVersion, initializeReader, isArray, isDeleted, isPrimitive, isSimple, readPriKey, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

isEnum

public boolean isEnum()

Description copied from interface: RawType

Returns whether this is an enum type.

If true is returned, a value of this type is a RawObject and the enum constant String is available via RawObject.getEnum().

If false is returned, then this is a complex type, an array type (see RawType.isArray()), or a simple type (see RawType.isSimple()).

Specified by:

isEnum in interface RawType

Overrides:

isEnum in class Format

Returns:

whether this is a enum type.

getEnumConstants

public List<String> getEnumConstants()

Description copied from interface: RawType

Returns an unmodifiable list of the names of the enum instances, or null if this is not an enum type.

Specified by:

getEnumConstants in interface RawType

Overrides:

getEnumConstants in class Format

Returns:

the list of enum names.

newInstance

public Object newInstance(EntityInput input,
                          boolean rawAccess)

Description copied from class: Format

Creates a new instance of the target class using its default constructor. Normally this creates an empty object, and readObject() is called next to fill in the contents. This is done in two steps to allow the instance to be registered by EntityInput before reading the contents. This allows the fields in an object or a nested object to refer to the parent object in a graph. Alternatively, this method may read all or the first portion of the data, rather than that being done by readObject(). This is required for simple types and enums, where the object cannot be created without reading the data. In these cases, there is no possibility that the parent object will be referenced by the child object in the graph. It should not be done in other cases, or the graph references may not be maintained faithfully. Is public only in order to implement the Reader interface. Note that this method should only be called directly in raw conversion mode or during conversion of an old format. Normally it should be called via the getReader method and the Reader interface.

Specified by:

newInstance in class Format

readObject

public Object readObject(Object o,
                         EntityInput input,
                         boolean rawAccess)

Description copied from class: Format

Called after newInstance() to read the rest of the data bytes and fill in the object contents. If the object was read completely by newInstance(), this method does nothing. Is public only in order to implement the Reader interface. Note that this method should only be called directly in raw conversion mode or during conversion of an old format. Normally it should be called via the getReader method and the Reader interface.

Specified by:

readObject in class Format