Value (OJAI Core Library for Java v. 3.0-mapr-1808)

All Superinterfaces:: JsonString

@API.Public
 @API.NotThreadSafe
public interface Value
extends JsonString

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Value.Type

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Value.Type`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`TAG_BINARY`
`static String`	`TAG_BYTE`
`static String`	`TAG_DATE`
`static String`	`TAG_DECIMAL`
`static String`	`TAG_FLOAT`
`static String`	`TAG_INT`
`static String`	`TAG_INTERVAL`
`static String`	`TAG_LONG`
`static String`	`TAG_SHORT`
`static String`	`TAG_TIME`
`static String`	`TAG_TIMESTAMP`
`static byte`	`TYPE_CODE_ARRAY`
`static byte`	`TYPE_CODE_BINARY`
`static byte`	`TYPE_CODE_BOOLEAN`
`static byte`	`TYPE_CODE_BYTE`
`static byte`	`TYPE_CODE_DATE`
`static byte`	`TYPE_CODE_DECIMAL`
`static byte`	`TYPE_CODE_DOUBLE`
`static byte`	`TYPE_CODE_FLOAT`
`static byte`	`TYPE_CODE_INT`
`static byte`	`TYPE_CODE_INTERVAL`
`static byte`	`TYPE_CODE_LONG`
`static byte`	`TYPE_CODE_MAP`
`static byte`	`TYPE_CODE_NULL`
`static byte`	`TYPE_CODE_SHORT`
`static byte`	`TYPE_CODE_STRING`
`static byte`	`TYPE_CODE_TIME`
`static byte`	`TYPE_CODE_TIMESTAMP`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DocumentReader`	`asReader()` Returns a `DocumentReader` over the current document.
`ByteBuffer`	`getBinary()` Returns the value as a `ByteBuffer`.
`boolean`	`getBoolean()` Returns the value as a `boolean`.
`byte`	`getByte()` Returns the value as a `byte`.
`ODate`	`getDate()` Returns the value as a `ODate` object.
`int`	`getDateAsInt()` Returns a `int` representing the number of DAYS since Unix epoch.
`BigDecimal`	`getDecimal()` Returns the value as a `BigDecimal`.
`double`	`getDouble()` Returns the value as a `double`.
`float`	`getFloat()` Returns the value as a `float`.
`int`	`getInt()` Returns the value as an `int`.
`OInterval`	`getInterval()` Returns the value as a `OInterval` object.
`long`	`getIntervalAsLong()` Returns a `long` representing interval duration in milliseconds.
`List<Object>`	`getList()` Returns the value as a `List<Object>`.
`long`	`getLong()` Returns the value as a `long`.
`Map<String,Object>`	`getMap()` Returns the value as a `Map`.
`Object`	`getObject()` Returns the value as an `Object` of the underlying type.
`short`	`getShort()` Returns the value as a `short`.
`String`	`getString()` Returns the value as a `String`.
`OTime`	`getTime()` Returns the value as a `OTime` object.
`int`	`getTimeAsInt()` Returns a `int` representing the number of milliseconds since midnight.
`OTimestamp`	`getTimestamp()` Returns the value as a `OTimestamp` object.
`long`	`getTimestampAsLong()` Returns a long value representing the number of milliseconds since epoch.
`Value.Type`	`getType()`

Methods inherited from interface org.ojai.JsonString
asJsonString, asJsonString

- Field Detail
  - TYPE_CODE_NULL
```
static final byte TYPE_CODE_NULL
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_BOOLEAN
```
static final byte TYPE_CODE_BOOLEAN
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_STRING
```
static final byte TYPE_CODE_STRING
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_BYTE
```
static final byte TYPE_CODE_BYTE
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_SHORT
```
static final byte TYPE_CODE_SHORT
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_INT
```
static final byte TYPE_CODE_INT
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_LONG
```
static final byte TYPE_CODE_LONG
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_FLOAT
```
static final byte TYPE_CODE_FLOAT
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_DOUBLE
```
static final byte TYPE_CODE_DOUBLE
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_DECIMAL
```
static final byte TYPE_CODE_DECIMAL
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_DATE
```
static final byte TYPE_CODE_DATE
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_TIME
```
static final byte TYPE_CODE_TIME
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_TIMESTAMP
```
static final byte TYPE_CODE_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_INTERVAL
```
static final byte TYPE_CODE_INTERVAL
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_BINARY
```
static final byte TYPE_CODE_BINARY
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_MAP
```
static final byte TYPE_CODE_MAP
```
    See Also:
    
    Constant Field Values
  - TYPE_CODE_ARRAY
```
static final byte TYPE_CODE_ARRAY
```
    See Also:
    
    Constant Field Values
  - TAG_BINARY
```
static final String TAG_BINARY
```
    See Also:
    
    Constant Field Values
  - TAG_INTERVAL
```
static final String TAG_INTERVAL
```
    See Also:
    
    Constant Field Values
  - TAG_TIMESTAMP
```
static final String TAG_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - TAG_TIME
```
static final String TAG_TIME
```
    See Also:
    
    Constant Field Values
  - TAG_DATE
```
static final String TAG_DATE
```
    See Also:
    
    Constant Field Values
  - TAG_DECIMAL
```
static final String TAG_DECIMAL
```
    See Also:
    
    Constant Field Values
  - TAG_LONG
```
static final String TAG_LONG
```
    See Also:
    
    Constant Field Values
  - TAG_BYTE
```
static final String TAG_BYTE
```
    See Also:
    
    Constant Field Values
  - TAG_SHORT
```
static final String TAG_SHORT
```
    See Also:
    
    Constant Field Values
  - TAG_INT
```
static final String TAG_INT
```
    See Also:
    
    Constant Field Values
  - TAG_FLOAT
```
static final String TAG_FLOAT
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getType
```
Value.Type getType()
```
    Returns:
    
    the Type of this Value
  - getByte
```
byte getByte()
```
    Returns the value as a byte.
    
    Throws:
    
    TypeException - if this value is not one of the numeric types
  - getShort
```
short getShort()
```
    Returns the value as a short.
    
    Throws:
    
    TypeException - if this value is not one of the numeric types
  - getInt
```
int getInt()
```
    Returns the value as an int.
    
    Throws:
    
    TypeException - if this value is not one of the numeric types
  - getLong
```
long getLong()
```
    Returns the value as a long.
    
    Throws:
    
    TypeException - if this value is not one of the numeric types
  - getFloat
```
float getFloat()
```
    Returns the value as a float.
    
    Throws:
    
    TypeException - if this value is not one of the numeric types
  - getDouble
```
double getDouble()
```
    Returns the value as a double.
    
    Throws:
    
    TypeException - if this value is not one of the numeric types
  - getDecimal
```
BigDecimal getDecimal()
```
    Returns the value as a BigDecimal.
    
    Throws:
    
    TypeException - if this value is not one of the numeric types
  - getBoolean
```
boolean getBoolean()
```
    Returns the value as a boolean.
    
    Throws:
    
    TypeException - if this value is not of BOOLEAN type
  - getString
```
String getString()
```
    Returns the value as a String.
    
    Throws:
    
    TypeException - if this value is not of STRING type
  - getTimestamp
```
OTimestamp getTimestamp()
```
    Returns the value as a OTimestamp object.
    
    Throws:
    
    TypeException - if this value is not of TIMESTAMP type
  - getTimestampAsLong
```
long getTimestampAsLong()
```
    Returns a long value representing the number of milliseconds since epoch.
    
    Throws:
    
    TypeException - if this value is not of TIMESTAMP type
  - getDate
```
ODate getDate()
```
    Returns the value as a ODate object.
    
    Throws:
    
    TypeException - if this value is not of DATE type
  - getDateAsInt
```
int getDateAsInt()
```
    Returns a int representing the number of DAYS since Unix epoch.
    
    Throws:
    
    TypeException - if this value is not of DATE type
  - getTime
```
OTime getTime()
```
    Returns the value as a OTime object. Modifying the returned object does not alter the content of the Value.
    
    Throws:
    
    TypeException - if this value is not of TIME type
  - getTimeAsInt
```
int getTimeAsInt()
```
    Returns a int representing the number of milliseconds since midnight.
    
    Throws:
    
    TypeException - if this value is not of TIME type
  - getInterval
```
OInterval getInterval()
```
    Returns the value as a OInterval object. Modifying the returned object does not alter the content of the Value.
    
    Throws:
    
    TypeException - if this value is not of INTERVAL type
  - getIntervalAsLong
```
long getIntervalAsLong()
```
    Returns a long representing interval duration in milliseconds.
    
    Throws:
    
    TypeException - if this value is not of INTERVAL type
  - getBinary
```
ByteBuffer getBinary()
```
    Returns the value as a ByteBuffer. Modifying the returned object does not alter the content of the Value.
    
    Throws:
    
    TypeException - if this value is not of BINARY type
  - getMap
```
Map<String,Object> getMap()
```
    Returns the value as a Map. The returned Map could be mutable or immutable however, modifying the returned Map does not alter the content of the Value.
    
    Throws:
    
    TypeException - if this value is not of MAP type
  getList List<Object> getList() Returns the value as a List<Object>. The returned List could be mutable or immutable however, modifying the returned List does not alter the content of the Value. Throws: TypeException - if this value is not of ARRAY type getObject Object getObject() Returns the value as an Object of the underlying type. Type.NULL => null Type.BOOLEAN => Boolean Type.STRING => String Type.BYTE => Byte Type.SHORT => Short Type.INT => Integer Type.LONG => Long Type.FLOAT => Float Type.DOUBLE => Double Type.DECIMAL => BigDecimal Type.DATE => org.ojai.types.ODate Type.TIME => org.ojai.types.OTime Type.TIMESTAMP => org.ojai.types.OTimestamp Type.INTERVAL => org.ojai.types.OInterval Type.BINARY => java.nio.ByteBuffer Type.MAP => Map<String, Object> Type.ARRAY => List<Object> Modifying the returned object does not alter the content of the Value. asReader DocumentReader asReader() Returns a DocumentReader over the current document.

Interface Value

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface org.ojai.JsonString

Field Detail

TYPE_CODE_NULL

TYPE_CODE_BOOLEAN

TYPE_CODE_STRING

TYPE_CODE_BYTE

TYPE_CODE_SHORT

TYPE_CODE_INT

TYPE_CODE_LONG

TYPE_CODE_FLOAT

TYPE_CODE_DOUBLE

TYPE_CODE_DECIMAL

TYPE_CODE_DATE

TYPE_CODE_TIME

TYPE_CODE_TIMESTAMP

TYPE_CODE_INTERVAL

TYPE_CODE_BINARY

TYPE_CODE_MAP

TYPE_CODE_ARRAY

TAG_BINARY

TAG_INTERVAL

TAG_TIMESTAMP

TAG_TIME

TAG_DATE

TAG_DECIMAL

TAG_LONG

TAG_BYTE

TAG_SHORT

TAG_INT

TAG_FLOAT

Method Detail

getType

getByte

getShort

getInt

getLong

getFloat

getDouble

getDecimal

getBoolean

getString

getTimestamp

getTimestampAsLong

getDate

getDateAsInt

getTime

getTimeAsInt

getInterval

getIntervalAsLong

getBinary

getMap

getList

getObject

asReader