- 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 mutableBooleanValued
object.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description BooleanRegister()
Creates a new null-valued register.
-
Method Summary
All Methods Instance Methods Concrete Methods 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
-
-
-
-
Method Detail
-
setNull
public void setNull()
Description copied from interface:TokenSettable
Sets the contained value to be null valued.- Specified by:
setNull
in interfaceTokenSettable
-
setZero
public void setZero()
Description copied from interface:TokenSettable
Sets the contained value to be zero valued.- Specified by:
setZero
in interfaceTokenSettable
-
set
public void set(boolean value)
Description copied from interface:BooleanSettable
Sets the container to the given boolean value.- Specified by:
set
in interfaceBooleanSettable
- 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 interfaceTokenSettable
- 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 interfaceScalarTyped
- Specified by:
getType
in interfaceScalarValued
- Specified by:
getType
in interfaceTokenTyped
- Specified by:
getType
in interfaceTokenValued
- 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 interfaceScalarValued
- 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 interfaceBooleanValued
- Returns:
- the contained value as a
boolean
. If null valued, as indicated byTokenValued.isNull()
,false
is returned.
-
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 interfaceTokenValued
- Returns:
true
if the token is null valued,false
otherwise
-
-