Package db
Class BinaryField
java.lang.Object
db.Field
db.BinaryField
- All Implemented Interfaces:
Comparable<Field>
- Direct Known Subclasses:
BinaryCodedField
,FixedField10
BinaryField
provides a wrapper for variable length binary data which is read or
written to a Record.-
Nested Class Summary
Nested classes/interfaces inherited from class db.Field
Field.UnsupportedFieldException
-
Field Summary
Fields inherited from class db.Field
EMPTY_ARRAY
-
Constructor Summary
ConstructorDescriptionConstruct a binary data field with an initial value of null.BinaryField
(byte[] data) Construct a binary data field with an initial value of data. -
Method Summary
Modifier and TypeMethodDescriptionint
Compares this Field with another Field for order.Create new instance of this field with the same value.boolean
Determine if the specified Object is another Field which has the same type and value as this Field.byte[]
Get data as a byte array.Get field value as a formatted stringstatic String
getValueAsString
(byte[] data) Get format value string for byte arrayint
hashCode()
boolean
isNull()
Determine if the field has been set to a null-state or value.boolean
newField()
Create new instance of this field type.void
setBinaryData
(byte[] data) Set data from binary byte array.toString()
Methods inherited from class db.Field
canIndex, getBooleanValue, getByteValue, getIntValue, getLongValue, getShortValue, getString, isSameType, setBooleanValue, setByteValue, setIntValue, setLongValue, setShortValue, setString
-
Field Details
-
INSTANCE
-
data
protected byte[] data
-
-
Constructor Details
-
BinaryField
public BinaryField()Construct a binary data field with an initial value of null. -
BinaryField
public BinaryField(byte[] data) Construct a binary data field with an initial value of data.- Parameters:
data
- initial value
-
-
Method Details
-
isNull
public boolean isNull()Description copied from class:Field
Determine if the field has been set to a null-state or value. -
getBinaryData
public byte[] getBinaryData()Description copied from class:Field
Get data as a byte array.- Specified by:
getBinaryData
in classField
- Returns:
- byte[]
-
setBinaryData
public void setBinaryData(byte[] data) Description copied from class:Field
Set data from binary byte array. All variable-length fields must implement this method.- Specified by:
setBinaryData
in classField
- Parameters:
data
- field data
-
isVariableLength
public boolean isVariableLength()- Overrides:
isVariableLength
in classField
- Returns:
- true if a Field instance is variable length, else false.
-
compareTo
Description copied from class:Field
Compares this Field with another Field for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified Field.
NOTE: Field objects do not fully comply with the Comparable interface. Only the same Field implementations may be compared. In addition, the null state is not considered when comparingPrimitiveField
s which have a zero (0) value.- Specified by:
compareTo
in interfaceComparable<Field>
- Specified by:
compareTo
in classField
- Parameters:
o
- another Field which is the same type as this Field- Returns:
- field comparison result (see
Comparable.compareTo(Object)
).
-
copyField
Description copied from class:Field
Create new instance of this field with the same value. -
newField
Description copied from class:Field
Create new instance of this field type. -
equals
Description copied from class:Field
Determine if the specified Object is another Field which has the same type and value as this Field. When comparing aPrimitiveField
, with a null state, a value of zero (0) is used. -
hashCode
public int hashCode() -
toString
-
getValueAsString
Description copied from class:Field
Get field value as a formatted string- Specified by:
getValueAsString
in classField
- Returns:
- field value string
-
getValueAsString
Get format value string for byte array- Parameters:
data
- byte array- Returns:
- formatted value string
-