Module datarush.library

Package com.pervasive.datarush.tokens.scalar

Class IntRegister

java.lang.Object

com.pervasive.datarush.tokens.scalar.IntRegister

All Implemented Interfaces:

DataRegister, DoubleValued, FloatValued, IntSettable, IntValued, LongValued, NumericValued, ScalarRegister, ScalarSettable, ScalarValued, TokenSettable, TokenValued, ScalarTyped, TokenTyped, Serializable

public final class IntRegister
extends Object
implements ScalarRegister, IntSettable

A mutable IntValued object.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.pervasive.datarush.tokens.scalar.NumericValued

MAX_INFINITY, MIN_INFINITY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BigDecimal	asBigDecimal()	Gets the contained numeric value.
double	asDouble()	Gets the contained double value.
float	asFloat()	Gets the contained float value.
int	asInt()	Gets the contained integer value.
long	asLong()	Gets the contained long 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(int value)	Sets the container to the given integer 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

IntRegister

public IntRegister()

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(int value)

Description copied from interface: IntSettable

Sets the container to the given integer value.

Specified by:

set in interface IntSettable

Parameters:

value - integer 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.

asBigDecimal

public final BigDecimal asBigDecimal()

Description copied from interface: NumericValued

Gets the contained numeric value.

Specified by:

asBigDecimal in interface NumericValued

Returns:

the contained value as a java.math.BigDecimal. If null valued, as indicated by TokenValued.isNull(), null is returned.

asDouble

public final double asDouble()

Description copied from interface: DoubleValued

Gets the contained double value.

Specified by:

asDouble in interface DoubleValued

Returns:

the contained value as a double. If null valued, as indicated by TokenValued.isNull(), Double.NaN is returned.

asFloat

public final float asFloat()

Description copied from interface: FloatValued

Gets the contained float value.

Specified by:

asFloat in interface FloatValued

Returns:

the contained value as a float. If null valued, as indicated by TokenValued.isNull(), Float.NaN is returned.

asLong

public final long asLong()

Description copied from interface: LongValued

Gets the contained long value.

Specified by:

asLong in interface LongValued

Returns:

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

asInt

public final int asInt()

Description copied from interface: IntValued

Gets the contained integer value.

Specified by:

asInt in interface IntValued

Returns:

the contained value as an int. If null valued, as indicated by TokenValued.isNull(), 0 is returned.

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.

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