public class EnumFormat extends Format
ID_BIGDEC, ID_BIGINT, ID_BOOL, ID_BOOL_W, ID_BYTE, ID_BYTE_W, ID_CHAR, ID_CHAR_W, ID_DATE, ID_DOUBLE, ID_DOUBLE_W, ID_FLOAT, ID_FLOAT_W, ID_INT, ID_INT_W, ID_LONG, ID_LONG_W, ID_NULL, ID_NUMBER, ID_OBJECT, ID_PREDEFINED, ID_SHORT, ID_SHORT_W, ID_SIMPLE_MAX, ID_SIMPLE_MIN, ID_STRING
Constructor and Description |
---|
EnumFormat(Catalog catalog,
java.lang.Class type) |
EnumFormat(Catalog catalog,
java.lang.Class type,
java.lang.String[] enumData)
For use in a deserialized CompositeKeyFormat.
|
Modifier and Type | Method and Description |
---|---|
(package private) void |
collectRelatedFormats(Catalog catalog,
java.util.Map<java.lang.String,Format> newFormats)
Calls catalog.createFormat for formats that this format depends on, or
that should also be persistent.
|
(package private) java.lang.Object |
convertRawObject(Catalog catalog,
boolean rawAccess,
RawObject rawObject,
IdentityHashMap converted)
Converts a RawObject to a current class object and adds the converted
pair to the converted map.
|
(package private) void |
copySecKey(RecordInput input,
RecordOutput output)
Called after skipToSecKey() to copy the data bytes of a singular
(XXX_TO_ONE) key field.
|
(package private) boolean |
evolve(Format newFormatParam,
Evolver evolver)
Called for an existing format that may not equal the current format for
the same class.
|
java.util.List<java.lang.String> |
getEnumConstants()
Returns an unmodifiable list of the names of the enum instances, or null
if this is not an enum type.
|
(package private) java.lang.String[] |
getFormatData()
Returns data needed for serialization of a CompositeKeyFormat.
|
(package private) void |
initialize(Catalog catalog,
EntityModel model,
int initVersion)
Initializes an uninitialized format, initializing its related formats
(superclass formats and array component formats) first.
|
boolean |
isEnum()
Returns whether this is an enum type.
|
(package private) java.lang.Object |
newArray(int len)
Creates an array of the format's class of the given length, as if
Array.newInstance(getType(), len) were called.
|
java.lang.Object |
newInstance(EntityInput input,
boolean rawAccess)
Creates a new instance of the target class using its default
constructor.
|
java.lang.Object |
readObject(java.lang.Object o,
EntityInput input,
boolean rawAccess)
Called after newInstance() to read the rest of the data bytes and fill
in the object contents.
|
(package private) void |
skipContents(RecordInput input)
Skips over the object's contents, as if readObject() were called, but
without returning an object.
|
(package private) void |
writeObject(java.lang.Object o,
EntityOutput output,
boolean rawAccess)
Writes a given instance of the target class to the output data bytes.
|
allowEvolveFromProxy, areNestedRefsProhibited, copySecMultiKey, evolveMetadata, getAccessor, getCatalog, getClassMetadata, getClassName, getComponentType, getDimensions, getEntityFormat, getEntityMetadata, getEvolveNeeded, getExistingType, getFields, getId, getLatestVersion, getNewStringFormat, getOldKeyName, getPreviousVersion, getProxiedFormat, getReader, getSequenceKeyFormat, getSuperFormat, getSuperType, getType, getVersion, getWrapperFormat, initCatalog, initializeIfNeeded, initializeReader, isArray, isAssignableTo, isCurrentVersion, isDeleted, isEntity, isInitialized, isModelClass, isNew, isPredefined, isPriKeyNullOrZero, isPrimitive, isSameClass, isSimple, migrateFromBeta, nullifySecKey, readPriKey, setDeleted, setEvolveNeeded, setId, setLatestVersion, setProxiedFormat, setReader, setSuperFormat, setUnused, skipToSecKey, toString, writePriKey
EnumFormat(Catalog catalog, java.lang.Class type)
EnumFormat(Catalog catalog, java.lang.Class type, java.lang.String[] enumData)
java.lang.String[] getFormatData()
public boolean isEnum()
RawType
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()
).
public java.util.List<java.lang.String> getEnumConstants()
RawType
getEnumConstants
in interface RawType
getEnumConstants
in class Format
void collectRelatedFormats(Catalog catalog, java.util.Map<java.lang.String,Format> newFormats)
Format
collectRelatedFormats
in class Format
void initialize(Catalog catalog, EntityModel model, int initVersion)
Format
initialize
in class Format
java.lang.Object newArray(int len)
Format
public java.lang.Object newInstance(EntityInput input, boolean rawAccess)
Format
newInstance
in interface Reader
newInstance
in class Format
public java.lang.Object readObject(java.lang.Object o, EntityInput input, boolean rawAccess)
Format
readObject
in interface Reader
readObject
in class Format
void writeObject(java.lang.Object o, EntityOutput output, boolean rawAccess)
Format
writeObject
in class Format
java.lang.Object convertRawObject(Catalog catalog, boolean rawAccess, RawObject rawObject, IdentityHashMap converted)
Format
convertRawObject
in class Format
void skipContents(RecordInput input)
Format
skipContents
in class Format
void copySecKey(RecordInput input, RecordOutput output)
Format
copySecKey
in class Format
boolean evolve(Format newFormatParam, Evolver evolver)
Format
If this method returns true, then it must have determined one of two things: - that the old and new formats are equal, and it must have called Evolver.useOldFormat; or - that the old format can be evolved to the new format, and it must have called Evolver.useEvolvedFormat.
If this method returns false, then it must have determined that the old format could not be evolved to the new format, and it must have called Evolver.addInvalidMutation, addMissingMutation or addEvolveError.
Copyright (c) 2004-2012 Oracle. All rights reserved.