Package db

Class ByteField

  • All Implemented Interfaces:
    java.lang.Comparable<Field>

    public final class ByteField
    extends Field
    ByteField provides a wrapper for single signed byte data which is read or written to a Record.
    • Field Detail

      • MIN_VALUE

        public static final ByteField MIN_VALUE
        Minimum byte field value
      • MAX_VALUE

        public static final ByteField MAX_VALUE
        Maximum byte field value
      • ZERO_VALUE

        public static final ByteField ZERO_VALUE
        Zero byte field value
    • Constructor Detail

      • ByteField

        public ByteField()
        Construct a byte field with an initial value of 0.
      • ByteField

        public ByteField​(byte b)
        Construct a byte field with an initial value of b.
        Parameters:
        b - initial value
    • Method Detail

      • getByteValue

        public byte getByteValue()
        Description copied from class: Field
        Get field as a byte value.
        Overrides:
        getByteValue in class Field
        Returns:
        byte value
      • setByteValue

        public void setByteValue​(byte value)
        Description copied from class: Field
        Set field's byte value.
        Overrides:
        setByteValue in class Field
        Parameters:
        value - byte value
      • getValueAsString

        public java.lang.String getValueAsString()
        Description copied from class: Field
        Get field value as a formatted string
        Specified by:
        getValueAsString in class Field
        Returns:
        field value string
      • equals

        public boolean equals​(java.lang.Object obj)
        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 a PrimitiveField, with a null state, a value of zero (0) is used.
        Specified by:
        equals in class Field
        Parameters:
        obj - another object
        Returns:
        true if this field equals obj
      • compareTo

        public int compareTo​(Field o)
        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 comparing PrimitiveFields which have a zero (0) value.
        Specified by:
        compareTo in interface java.lang.Comparable<Field>
        Specified by:
        compareTo in class Field
        Parameters:
        o - another Field which is the same type as this Field
        Returns:
        field comparison result (see Comparable.compareTo(Object)).
      • copyField

        public ByteField copyField()
        Description copied from class: Field
        Create new instance of this field with the same value.
        Specified by:
        copyField in class Field
        Returns:
        new field instance with same value
      • newField

        public ByteField newField()
        Description copied from class: Field
        Create new instance of this field type.
        Specified by:
        newField in class Field
        Returns:
        new field instance with undefined initial value
      • getLongValue

        public long getLongValue()
        Description copied from class: Field
        Get field as a long value. All fixed-length field objects must implement this method
        Overrides:
        getLongValue in class Field
        Returns:
        long value
      • setLongValue

        public void setLongValue​(long value)
        Description copied from class: Field
        Set field's long value. All fixed-length field objects must implement this method
        Overrides:
        setLongValue in class Field
        Parameters:
        value - long value
      • getBinaryData

        public byte[] getBinaryData()
        Description copied from class: Field
        Get data as a byte array.
        Specified by:
        getBinaryData in class Field
        Returns:
        byte[]
      • setBinaryData

        public void setBinaryData​(byte[] bytes)
        Description copied from class: Field
        Set data from binary byte array. All variable-length fields must implement this method.
        Specified by:
        setBinaryData in class Field
        Parameters:
        bytes - field data
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in class Field
      • isNull

        public final boolean isNull()
        Description copied from class: Field
        Determine if the field has been set to a null-state or value.
        Specified by:
        isNull in class Field
        Returns:
        true if field has been set to a null state or value, else false
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object