com.j256.ormlite.field.types
Class ByteArrayType

java.lang.Object
  extended by com.j256.ormlite.field.BaseFieldConverter
      extended by com.j256.ormlite.field.types.BaseDataType
          extended by com.j256.ormlite.field.types.ByteArrayType
All Implemented Interfaces:
DataPersister, FieldConverter

public class ByteArrayType
extends BaseDataType

Type that persists a byte[] object.

Author:
graywatson

Constructor Summary
protected ByteArrayType(SqlType sqlType, Class<?>[] classes)
          Here for others to subclass.
 
Method Summary
 boolean dataIsEqual(Object fieldObj1, Object fieldObj2)
          Compare two fields of this type returning true if equals else false.
 Class<?> getPrimaryClass()
          Return the class most associated with this persister or null if none.
static ByteArrayType getSingleton()
           
 boolean isAppropriateId()
          Return true if this data type can be an id column in a class.
 boolean isArgumentHolderRequired()
          Must use ArgumentHolder when querying for values of this type.
 Object parseDefaultString(FieldType fieldType, String defaultStr)
          Convert a default string object and return the appropriate argument to a SQL insert or update statement.
 Object resultStringToJava(FieldType fieldType, String stringValue, int columnPos)
          Convert a string result value to the related Java field.
 Object resultToSqlArg(FieldType fieldType, DatabaseResults results, int columnPos)
          Return the SQL argument object extracted from the results associated with column in position columnPos.
 
Methods inherited from class com.j256.ormlite.field.types.BaseDataType
convertIdNumber, generateId, getAssociatedClasses, getAssociatedClassNames, getDefaultWidth, getSqlType, isComparable, isEscapedDefaultValue, isEscapedValue, isPrimitive, isSelfGeneratedId, isValidForField, isValidForVersion, isValidGeneratedType, makeConfigObject, moveToNextValue
 
Methods inherited from class com.j256.ormlite.field.BaseFieldConverter
isStreamType, javaToSqlArg, resultToJava, sqlArgToJava
 
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, javaToSqlArg, resultToJava, sqlArgToJava
 

Constructor Detail

ByteArrayType

protected ByteArrayType(SqlType sqlType,
                        Class<?>[] classes)
Here for others to subclass.

Method Detail

getSingleton

public static ByteArrayType getSingleton()

parseDefaultString

public Object parseDefaultString(FieldType fieldType,
                                 String defaultStr)
                          throws SQLException
Description copied from interface: FieldConverter
Convert a default string object and return the appropriate argument to a SQL insert or update statement.

Specified by:
parseDefaultString in interface FieldConverter
Specified by:
parseDefaultString in class BaseDataType
Throws:
SQLException

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.

Specified by:
resultToSqlArg in interface FieldConverter
Specified by:
resultToSqlArg in class BaseDataType
Parameters:
fieldType - Associated FieldType which may be null.
Throws:
SQLException - If there is a problem accessing the results data.

isAppropriateId

public boolean isAppropriateId()
Description copied from interface: DataPersister
Return true if this data type can be an id column in a class.

Specified by:
isAppropriateId in interface DataPersister
Overrides:
isAppropriateId in class BaseDataType

isArgumentHolderRequired

public boolean isArgumentHolderRequired()
Description copied from interface: DataPersister
Must use ArgumentHolder when querying for values of this type.

Specified by:
isArgumentHolderRequired in interface DataPersister
Overrides:
isArgumentHolderRequired in class BaseDataType

dataIsEqual

public boolean dataIsEqual(Object fieldObj1,
                           Object fieldObj2)
Description copied from interface: DataPersister
Compare two fields of this type returning true if equals else false.

Specified by:
dataIsEqual in interface DataPersister
Overrides:
dataIsEqual in class BaseDataType

resultStringToJava

public Object resultStringToJava(FieldType fieldType,
                                 String stringValue,
                                 int columnPos)
                          throws SQLException
Description copied from interface: FieldConverter
Convert a string result value to the related Java field.

Specified by:
resultStringToJava in interface FieldConverter
Overrides:
resultStringToJava in class BaseDataType
Throws:
SQLException

getPrimaryClass

public Class<?> getPrimaryClass()
Description copied from interface: DataPersister
Return the class most associated with this persister or null if none.

Specified by:
getPrimaryClass in interface DataPersister
Overrides:
getPrimaryClass in class BaseDataType


This documentation is licensed by Gray Watson under the Creative Commons Attribution-Share Alike 3.0 License.