Module datarush.library

Package com.pervasive.datarush.tokens.scalar

Interface NumericValued

All Superinterfaces:

ScalarTyped, ScalarValued, TokenTyped, TokenValued

All Known Subinterfaces:

DoubleInputField, DoubleValued, DoubleValuedIterator, FloatInputField, FloatValued, FloatValuedIterator, IntInputField, IntValued, IntValuedIterator, LongInputField, LongValued, LongValuedIterator, MoneyInputField, MoneyValued, MoneyValuedIterator, NumericInputField, NumericValuedIterator

All Known Implementing Classes:

DoubleRegister, DoubleToken, FloatRegister, FloatToken, IntRegister, IntToken, LongRegister, LongToken, MoneyRegister, MoneyToken, NullToken, NumericRegister, NumericToken

public interface NumericValued
extends ScalarValued

A TokenValued object containing a numeric value.

See Also:

TokenTypeConstant#NUMERIC

Field Summary

Fields

Modifier and Type	Field	Description
static BigDecimal	MAX_INFINITY	The value representing positive infinity.
static BigDecimal	MIN_INFINITY	The value representing negative infinity.

Method Summary

Modifier and Type	Method	Description
BigDecimal	asBigDecimal()	Gets the contained numeric value.

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

getType, isZero

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

isNull

Field Detail

MAX_INFINITY

static final BigDecimal MAX_INFINITY

The value representing positive infinity.

MIN_INFINITY

static final BigDecimal MIN_INFINITY

The value representing negative infinity.

Method Detail

asBigDecimal

BigDecimal asBigDecimal()

Gets the contained numeric value.

Returns:

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