Package db

Class BooleanField

java.lang.Object

db.Field

db.BooleanField

All Implemented Interfaces:

java.lang.Comparable<Field>

public final class BooleanField
extends Field

BooleanField provides a wrapper for boolean 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

Modifier and Type	Field	Description
static BooleanField	INSTANCE	Instance intended for defining a Table Schema
static BooleanField	MAX_VALUE	Maximum boolean field value (TRUE)
static BooleanField	MIN_VALUE	Minimum boolean field value (FALSE)

Fields inherited from class db.Field

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
BooleanField()	Construct a boolean data field with an initial value of false.
BooleanField(boolean b)	Construct a boolean data field with an initial value of b.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Field o)	Compares this Field with another Field for order.
BooleanField	copyField()	Create new instance of this field with the same value.
boolean	equals(java.lang.Object obj)	Determine if the specified Object is another Field which has the same type and value as this Field.
byte[]	getBinaryData()	Get data as a byte array.
boolean	getBooleanValue()	Get field as a boolean value.
long	getLongValue()	Get field as a long value.
java.lang.String	getValueAsString()	Get field value as a formatted string
int	hashCode()
boolean	isNull()	Determine if the field has been set to a null-state or value.
BooleanField	newField()	Create new instance of this field type.
void	setBinaryData(byte[] bytes)	Set data from binary byte array.
void	setBooleanValue(boolean b)	Set field's boolean value.
java.lang.String	toString()

Methods inherited from class db.Field

canIndex, getByteValue, getIntValue, getShortValue, getString, isSameType, isVariableLength, setByteValue, setIntValue, setLongValue, setShortValue, setString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MIN_VALUE

public static final BooleanField MIN_VALUE

Minimum boolean field value (FALSE)

MAX_VALUE

public static final BooleanField MAX_VALUE

Maximum boolean field value (TRUE)

INSTANCE

public static final BooleanField INSTANCE

Instance intended for defining a Table Schema

Constructor Detail

BooleanField

public BooleanField()

Construct a boolean data field with an initial value of false.

BooleanField

public BooleanField(boolean b)

Construct a boolean data field with an initial value of b.

Parameters:

b - initial value

Method Detail

getBooleanValue

public boolean getBooleanValue()

Description copied from class: Field

Get field as a boolean value.

Overrides:

getBooleanValue in class Field

Returns:

boolean value

setBooleanValue

public void setBooleanValue(boolean b)

Description copied from class: Field

Set field's boolean value.

Overrides:

setBooleanValue in class Field

Parameters:

b - boolean 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 BooleanField 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 BooleanField 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

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