Module datarush.library

Package com.pervasive.datarush.tokens.scalar

Class BooleanRegister

java.lang.Object

com.pervasive.datarush.tokens.scalar.BooleanRegister

All Implemented Interfaces:

DataRegister, BooleanSettable, BooleanValued, ScalarRegister, ScalarSettable, ScalarValued, TokenSettable, TokenValued, ScalarTyped, TokenTyped, Serializable

public final class BooleanRegister
extends Object
implements ScalarRegister, BooleanSettable

A mutable BooleanValued object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BooleanRegister()	Creates a new null-valued register.

Method Summary

Modifier and Type	Method	Description
boolean	asBoolean()	Gets the contained boolean value.
ScalarTokenType	getType()	Gets the data type of the token.
boolean	isNull()	Indicates whether the token is null valued.
boolean	isZero()	Indicates whether the value is the zero value for the type.
void	set(boolean value)	Sets the container to the given boolean value.
void	set(TokenValued value)	Sets the contained value to the given token value.
void	setNull()	Sets the contained value to be null valued.
void	setZero()	Sets the contained value to be zero valued.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.pervasive.datarush.types.ScalarTyped

getType

Methods inherited from interface com.pervasive.datarush.tokens.scalar.ScalarValued

getType, isZero

Methods inherited from interface com.pervasive.datarush.tokens.TokenValued

isNull

Constructor Detail

BooleanRegister

public BooleanRegister()

Creates a new null-valued register.

Method Detail

setNull

public void setNull()

Description copied from interface: TokenSettable

Sets the contained value to be null valued.

Specified by:

setNull in interface TokenSettable

setZero

public void setZero()

Description copied from interface: TokenSettable

Sets the contained value to be zero valued.

Specified by:

setZero in interface TokenSettable

set

public void set(boolean value)

Description copied from interface: BooleanSettable

Sets the container to the given boolean value.

Specified by:

set in interface BooleanSettable

Parameters:

value - boolean value to which to set the container

set

public void set(TokenValued value)

Description copied from interface: TokenSettable

Sets the contained value to the given token value. The given value must have a type compatible with this object.

Specified by:

set in interface TokenSettable

Parameters:

value - the value to which to set the container

getType

public final ScalarTokenType getType()

Description copied from interface: TokenValued

Gets the data type of the token. This type will dictate the valid values that can be contained.

Specified by:

getType in interface ScalarTyped

Specified by:

getType in interface ScalarValued

Specified by:

getType in interface TokenTyped

Specified by:

getType in interface TokenValued

Returns:

the token type.

isZero

public final boolean isZero()

Description copied from interface: ScalarValued

Indicates whether the value is the zero value for the type. Zero values are not stored in sparse representation formats.

Specified by:

isZero in interface ScalarValued

Returns:

true if the value is the zero value, false otherwise.

asBoolean

public final boolean asBoolean()

Description copied from interface: BooleanValued

Gets the contained boolean value.

Specified by:

asBoolean in interface BooleanValued

Returns:

the contained value as a boolean. If null valued, as indicated by TokenValued.isNull(), false is returned.

toString

public String toString()

Overrides:

toString in class Object

isNull

public final boolean isNull()

Description copied from interface: TokenValued

Indicates whether the token is null valued. Tokens support null values analogous to SQL. Before accessing the value of the container, it is usually best to ensure it is not null valued using this method.

Specified by:

isNull in interface TokenValued

Returns:

true if the token is null valued, false otherwise