com.j256.ormlite.field.types

Class EnumStringType

java.lang.Object

com.j256.ormlite.field.BaseFieldConverter

com.j256.ormlite.field.types.BaseDataType

com.j256.ormlite.field.types.BaseEnumType

com.j256.ormlite.field.types.EnumStringType

All Implemented Interfaces:

DataPersister, FieldConverter

Direct Known Subclasses:

EnumToStringType

public class EnumStringType
extends BaseEnumType

Type that persists an enum as its name produced by call @{link Enum.name(). You can also use the EnumIntegerType to persist it's enum ordinal value. If you want to use the Enum.toString() instead, see the EnumToStringType.

Author:

graywatson

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_WIDTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnumStringType(SqlType sqlType, Class<?>[] classes) Here for others to subclass.

Method Summary

Modifier and Type	Method and Description
int	getDefaultWidth() Return the default width associated with this type or 0 if none.
protected String	getEnumName(Enum<?> enumVal)
static EnumStringType	getSingleton()
Object	javaToSqlArg(FieldType fieldType, Object obj) Convert a Java object and return the appropriate argument to a SQL insert or update statement.
Object	makeConfigObject(FieldType fieldType) This makes a configuration object for the data-type or returns null if none.
Object	parseDefaultString(FieldType fieldType, String defaultStr) Convert a default string object and return the appropriate argument to a SQL insert or update statement.
Object	resultToSqlArg(FieldType fieldType, DatabaseResults results, int columnPos) Return the SQL argument object extracted from the results associated with column in position columnPos.
Object	sqlArgToJava(FieldType fieldType, Object sqlArg, int columnPos) Return the object converted from the SQL arg to java.

Methods inherited from class com.j256.ormlite.field.types.BaseEnumType

enumVal, isValidForField

Methods inherited from class com.j256.ormlite.field.types.BaseDataType

convertIdNumber, dataIsEqual, generateId, getAssociatedClasses, getAssociatedClassNames, getPrimaryClass, getSqlOtherType, getSqlType, isAppropriateId, isArgumentHolderRequired, isComparable, isEscapedDefaultValue, isEscapedValue, isPrimitive, isSelfGeneratedId, isValidForVersion, isValidGeneratedType, moveToNextValue, resultStringToJava

Methods inherited from class com.j256.ormlite.field.BaseFieldConverter

isStreamType, resultToJava

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.j256.ormlite.field.FieldConverter

isStreamType, resultToJava

Field Detail

DEFAULT_WIDTH

public static int DEFAULT_WIDTH

Constructor Detail

EnumStringType

protected EnumStringType(SqlType sqlType,
                         Class<?>[] classes)

Here for others to subclass.

Method Detail

getSingleton

public static EnumStringType getSingleton()

resultToSqlArg

public Object resultToSqlArg(FieldType fieldType,
                             DatabaseResults results,
                             int columnPos)
                      throws SQLException

Description copied from interface: FieldConverter

Return the SQL argument object extracted from the results associated with column in position columnPos. For example, if the type is a date-long then this will return a long value or null.

Parameters:

fieldType - Associated FieldType which may be null.

Throws:

SQLException - If there is a problem accessing the results data.

sqlArgToJava

public Object sqlArgToJava(FieldType fieldType,
                           Object sqlArg,
                           int columnPos)
                    throws SQLException

Description copied from interface: FieldConverter

Return the object converted from the SQL arg to java. This takes the database representation and converts it into a Java object. For example, if the type is a date-long then this will take a long which is stored in the database and return a Date.

Specified by:

sqlArgToJava in interface FieldConverter

Overrides:

sqlArgToJava in class BaseFieldConverter

Parameters:

fieldType - Associated FieldType which may be null.

sqlArg - SQL argument converted with FieldConverter.resultToSqlArg(FieldType, DatabaseResults, int) which will not be null.

Throws:

SQLException - If there are problems with the conversion.

parseDefaultString

public Object parseDefaultString(FieldType fieldType,
                                 String defaultStr)

Description copied from interface: FieldConverter

Convert a default string object and return the appropriate argument to a SQL insert or update statement.

Returns:

Result object to insert if the field is not specified or null if none.

javaToSqlArg

public Object javaToSqlArg(FieldType fieldType,
                           Object obj)

Description copied from interface: FieldConverter

Convert a Java object and return the appropriate argument to a SQL insert or update statement.

Specified by:

javaToSqlArg in interface FieldConverter

Overrides:

javaToSqlArg in class BaseFieldConverter

makeConfigObject

public Object makeConfigObject(FieldType fieldType)
                        throws SQLException

Description copied from interface: FieldConverter

This makes a configuration object for the data-type or returns null if none. The object can be accessed later via FieldType.getDataTypeConfigObj().

Specified by:

makeConfigObject in interface FieldConverter

Overrides:

makeConfigObject in class BaseFieldConverter

Throws:

SQLException - If there are problems creating the config object. Needed for subclasses.

See Also:

FieldConverter.makeConfigObject(FieldType)

getDefaultWidth

public int getDefaultWidth()

Description copied from interface: DataPersister

Return the default width associated with this type or 0 if none.

Specified by:

getDefaultWidth in interface DataPersister

Overrides:

getDefaultWidth in class BaseDataType

getEnumName

protected String getEnumName(Enum<?> enumVal)