Package org.apache.cayenne.access.types
Class ExtendedEnumType<T extends Enum<T>>
java.lang.Object
org.apache.cayenne.access.types.ExtendedEnumType<T>
- All Implemented Interfaces:
- ExtendedType<T>
public class ExtendedEnumType<T extends Enum<T>> extends Object implements ExtendedType<T>
An ExtendedType that handles a Java Enum based upon the Cayenne ExtendedEnumeration
 interface. The ExtendedEnumeration interface requires the developer to specify the
 database values for the Enum being mapped. This ExtendedType is used to auto-register
 those Enums found in the model.
- Since:
- 3.0
- 
Field SummaryFields inherited from interface org.apache.cayenne.access.types.ExtendedTypeTRIM_VALUES_THRESHOLD
- 
Constructor SummaryConstructors Constructor Description ExtendedEnumType(Class<T> enumerationClass)
- 
Method SummaryModifier and Type Method Description StringgetClassName()Returns a full name of Java class that this ExtendedType supports.Map<Object,Enum<T>>getEnumerationMappings()Returns the enumeration mapping for this enumerated data type.Object[]getValues()TmaterializeObject(CallableStatement rs, int index, int type)Reads an object from a stored procedure OUT parameter, converting it to class returned by 'getClassName' method.TmaterializeObject(ResultSet rs, int index, int type)Reads an object from JDBC ResultSet column, converting it to class returned by 'getClassName' method.voidsetJdbcObject(PreparedStatement statement, T value, int pos, int type, int precision)Initializes a single parameter of a PreparedStatement with object value.StringtoString(T value)Converts value of the supported type to a human-readable String representation.
- 
Constructor Details- 
ExtendedEnumType
 
- 
- 
Method Details- 
getClassNameDescription copied from interface:ExtendedTypeReturns a full name of Java class that this ExtendedType supports.- Specified by:
- getClassNamein interface- ExtendedType<T extends Enum<T>>
 
- 
materializeObjectDescription copied from interface:ExtendedTypeReads an object from JDBC ResultSet column, converting it to class returned by 'getClassName' method.- Specified by:
- materializeObjectin interface- ExtendedType<T extends Enum<T>>
- Throws:
- Exception- if read error occurred, or an object can't be converted to a target Java class.
 
- 
materializeObjectDescription copied from interface:ExtendedTypeReads an object from a stored procedure OUT parameter, converting it to class returned by 'getClassName' method.- Specified by:
- materializeObjectin interface- ExtendedType<T extends Enum<T>>
- Throws:
- Exception- if read error occurred, or an object can't be converted to a target Java class.
 
- 
setJdbcObjectpublic void setJdbcObject(PreparedStatement statement, T value, int pos, int type, int precision) throws ExceptionDescription copied from interface:ExtendedTypeInitializes a single parameter of a PreparedStatement with object value.- Specified by:
- setJdbcObjectin interface- ExtendedType<T extends Enum<T>>
- Throws:
- Exception
 
- 
toStringDescription copied from interface:ExtendedTypeConverts value of the supported type to a human-readable String representation.- Specified by:
- toStringin interface- ExtendedType<T extends Enum<T>>
- Parameters:
- value- a value to convert to String.
 
- 
getEnumerationMappingsReturns the enumeration mapping for this enumerated data type. The key is the database value, the value is the actual enum.
- 
getValues
 
-