Package db
Class FixedField10
java.lang.Object
db.Field
db.BinaryField
db.FixedField10
- All Implemented Interfaces:
Comparable<Field>
FixedField10 provide an unsigned 10-byte fixed-length field value.
The most-significant byte corresponds to index-0 (i.e., data[0]).-
Nested Class Summary
Nested classes/interfaces inherited from class db.Field
Field.UnsupportedFieldException -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final FixedField10static FixedField10Maximum long field valuestatic FixedField10Minimum long field valuestatic final FixedField10Zero fixed10 field valueFields inherited from class db.BinaryField
dataFields inherited from class db.Field
EMPTY_ARRAY -
Constructor Summary
ConstructorsConstructorDescriptionConstruct a 10-byte fixed-length field with an initial value of 0.FixedField10(byte[] data) Construct a 10-byte fixed-length field with an initial value of data.FixedField10(byte[] data, boolean immutable) Construct a 10-byte fixed-length binary field with an initial value of data. -
Method Summary
Modifier and TypeMethodDescriptionintCompares this Field with another Field for order.db.FixedFieldCreate new instance of this field with the same value.booleanDetermine 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 stringinthashCode()final booleanisNull()Determine if the field has been set to a null-state or value.final booleandb.FixedFieldnewField()Create new instance of this field type.voidsetBinaryData(byte[] d) Set data from binary byte array.Methods inherited from class db.BinaryField
getValueAsString, toStringMethods inherited from class db.Field
canIndex, getBooleanValue, getByteValue, getIntValue, getLongValue, getShortValue, getString, isSameType, setBooleanValue, setByteValue, setIntValue, setLongValue, setShortValue, setString
-
Field Details
-
ZERO_VALUE
Zero fixed10 field value -
MIN_VALUE
Minimum long field value -
MAX_VALUE
Maximum long field value -
INSTANCE
-
-
Constructor Details
-
FixedField10
public FixedField10()Construct a 10-byte fixed-length field with an initial value of 0. -
FixedField10
public FixedField10(byte[] data) Construct a 10-byte fixed-length field with an initial value of data.- Parameters:
data- initial 10-byte binary value. A null corresponds to zero value and does not affect the null-state (seesetNull()andBinaryField.isNull()).- Throws:
IllegalArgumentException- thrown if data is not 10-bytes in length
-
FixedField10
public FixedField10(byte[] data, boolean immutable) Construct a 10-byte fixed-length binary field with an initial value of data.- Parameters:
data- initial 10-byte binary value. A null corresponds to zero value and does not affect the null-state (seesetNull()andBinaryField.isNull()).immutable- true if field value is immutable- Throws:
IllegalArgumentException- thrown if data is not 10-bytes in length
-
-
Method Details
-
compareTo
Description copied from class:FieldCompares 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 comparingPrimitiveFields which have a zero (0) value.- Specified by:
compareToin interfaceComparable<Field>- Overrides:
compareToin classBinaryField- Parameters:
o- another Field which is the same type as this Field- Returns:
- field comparison result (see
Comparable.compareTo(Object)).
-
copyField
public db.FixedField copyField()Description copied from class:FieldCreate new instance of this field with the same value.- Returns:
- new field instance with same value
-
newField
public db.FixedField newField()Description copied from class:FieldCreate new instance of this field type.- Returns:
- new field instance with undefined initial value
-
getBinaryData
public byte[] getBinaryData()Description copied from class:FieldGet data as a byte array.- Overrides:
getBinaryDatain classBinaryField- Returns:
- byte[]
-
setBinaryData
public void setBinaryData(byte[] d) Description copied from class:FieldSet data from binary byte array. All variable-length fields must implement this method.- Overrides:
setBinaryDatain classBinaryField- Parameters:
d- field data
-
hashCode
public int hashCode()- Overrides:
hashCodein classBinaryField
-
equals
Description copied from class:FieldDetermine 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.- Overrides:
equalsin classBinaryField- Parameters:
obj- another object- Returns:
- true if this field equals obj
-
getValueAsString
Description copied from class:FieldGet field value as a formatted string- Overrides:
getValueAsStringin classBinaryField- Returns:
- field value string
-
isVariableLength
public final boolean isVariableLength()- Overrides:
isVariableLengthin classBinaryField- Returns:
- true if a Field instance is variable length, else false.
-
isNull
public final boolean isNull()Description copied from class:FieldDetermine if the field has been set to a null-state or value.- Overrides:
isNullin classBinaryField- Returns:
- true if field has been set to a null state or value, else false
-