Top Description Inners Fields Constructors Methods
com.amazon.ion.impl

public final Class _Private_IonConstants

extends Object
Class Inheritance
Imports
com.amazon.ion.IonException

NOT FOR APPLICATION USE!

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Field Summary

Modifier and TypeField and Description
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final byte[]
BINARY_VERSION_MARKER_1_0

The byte sequence indicating use of Ion 1.0 binary format.

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
MAX_LONG_TEXT_SIZE

maximum size of textual representation of a long.

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final String
UNKNOWN_SYMBOL_TEXT_PREFIX

Prefix string used in IonStructs' equality checks.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static final int
getLowNibble(int td)

public static final int

Returns:

the high nibble of the input byte, between 0x00 and 0x0F.
getTypeCode
(int
must be a positive int between 0x00 and 0xFF.
td
)

Extract the type code (high nibble) from a type descriptor.

public static final boolean
public static final boolean
public static final boolean
isSurrogate(int c)

public static final int
makeHighSurrogate(int unicodeScalar)

public static final int
makeLowSurrogate(int unicodeScalar)

public static final int

Returns:

the combined nibbles, between 0x00 and 0xFF.
makeTypeDescriptor
(int
must be a positive int between 0x00 and 0x0F.
highNibble
,
int
must be a positive int between 0x00 and 0x0F.
lowNibble
)

Make a type descriptor from two nibbles; all of which are represented as ints.

public static final int
makeUnicodeScalar(int high_surrogate, int low_surrogate)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ARRAY_MAXIMUM_SIZEback to summary
public static final int ARRAY_MAXIMUM_SIZE
BB_INT64_LEN_MAXback to summary
public static final int BB_INT64_LEN_MAX
BB_MAX_7BIT_INTback to summary
public static final int BB_MAX_7BIT_INT
BB_TOKEN_LENback to summary
public static final int BB_TOKEN_LEN
BB_VAR_INT32_LEN_MAXback to summary
public static final int BB_VAR_INT32_LEN_MAX
BB_VAR_INT64_LEN_MAXback to summary
public static final int BB_VAR_INT64_LEN_MAX
BB_VAR_LEN_MINback to summary
public static final int BB_VAR_LEN_MIN
BINARY_VERSION_MARKER_1_0back to summary
public static final byte[] BINARY_VERSION_MARKER_1_0

The byte sequence indicating use of Ion 1.0 binary format.

BINARY_VERSION_MARKER_SIZEback to summary
public static final int BINARY_VERSION_MARKER_SIZE

The number of bytes in BINARY_VERSION_MARKER_1_0.

Falseback to summary
public static final int False
high_surrogate_valueback to summary
public static final int high_surrogate_value
INT32_SIZEback to summary
public static final int INT32_SIZE
lnBooleanFalseback to summary
public static final int lnBooleanFalse
lnBooleanTrueback to summary
public static final int lnBooleanTrue
lnIsEmptyContainerback to summary
public static final int lnIsEmptyContainer
lnIsNullback to summary
public static final int lnIsNull
lnIsNullAtomback to summary
public static final int lnIsNullAtom
lnIsNullSequenceback to summary
public static final int lnIsNullSequence
lnIsNullStructback to summary
public static final int lnIsNullStruct
lnIsOrderedStructback to summary
public static final int lnIsOrderedStruct
lnIsVarLenback to summary
public static final int lnIsVarLen
lnNumericZeroback to summary
public static final int lnNumericZero
low_surrogate_valueback to summary
public static final int low_surrogate_value
MAX_LONG_TEXT_SIZEback to summary
public static final int MAX_LONG_TEXT_SIZE

maximum size of textual representation of a long.

surrogate_maskback to summary
public static final int surrogate_mask
surrogate_utf32_offsetback to summary
public static final int surrogate_utf32_offset
surrogate_utf32_shiftback to summary
public static final int surrogate_utf32_shift
surrogate_value_maskback to summary
public static final int surrogate_value_mask
tidBlobback to summary
public static final int tidBlob
tidBooleanback to summary
public static final int tidBoolean
tidClobback to summary
public static final int tidClob
tidDATAGRAMback to summary
public static final int tidDATAGRAM
tidDecimalback to summary
public static final int tidDecimal
tidFloatback to summary
public static final int tidFloat
tidListback to summary
public static final int tidList
tidNegIntback to summary
public static final int tidNegInt
tidNopPadback to summary
public static final int tidNopPad
tidNullback to summary
public static final int tidNull
tidPosIntback to summary
public static final int tidPosInt
tidSexpback to summary
public static final int tidSexp
tidStringback to summary
public static final int tidString
tidStructback to summary
public static final int tidStruct
tidSymbolback to summary
public static final int tidSymbol
tidTimestampback to summary
public static final int tidTimestamp
tidTypedeclback to summary
public static final int tidTypedecl
tidUnusedback to summary
public static final int tidUnused
Trueback to summary
public static final int True
UNKNOWN_SYMBOL_TEXT_PREFIXback to summary
public static final String UNKNOWN_SYMBOL_TEXT_PREFIX

Prefix string used in IonStructs' equality checks. When a IonValue's field name's text is unknown, this String is prepended to the field name's SID to coerce it to a string to be used as the key. This will eliminate collisions with IonValues with numbers as their field names.

For example, these two IonValues (nested in the IonStructs) will have distinct keys:

{"$99":random_value},
{$99:random_value}

TODO amazon-ion/ion-java/issues/23 However, there is still a potential failure if one of the IonStruct's nested value has a field name with text " -- UNKNOWN SYMBOL TEXT -- $123", and that another nested value of an IonStruct has a field name with unknown text and sid 123, these two values will be considered a match within IonStruct's equality checks, which is wrong.

See IonAssert for another use of this idiom.

Constructor Detail

_Private_IonConstantsback to summary
private _Private_IonConstants()

Method Detail

getLowNibbleback to summary
public static final int getLowNibble(int td)
getTypeCodeback to summary
public static final int getTypeCode(int td)

Extract the type code (high nibble) from a type descriptor.

Parameters
td:int

must be a positive int between 0x00 and 0xFF.

Returns:int

the high nibble of the input byte, between 0x00 and 0x0F.

isHighSurrogateback to summary
public static final boolean isHighSurrogate(int c)
isLowSurrogateback to summary
public static final boolean isLowSurrogate(int c)
isSurrogateback to summary
public static final boolean isSurrogate(int c)
makeHighSurrogateback to summary
public static final int makeHighSurrogate(int unicodeScalar)
makeLowSurrogateback to summary
public static final int makeLowSurrogate(int unicodeScalar)
makeTypeDescriptorback to summary
public static final int makeTypeDescriptor(int highNibble, int lowNibble)

Make a type descriptor from two nibbles; all of which are represented as ints.

Parameters
highNibble:int

must be a positive int between 0x00 and 0x0F.

lowNibble:int

must be a positive int between 0x00 and 0x0F.

Returns:int

the combined nibbles, between 0x00 and 0xFF.

makeUnicodeScalarback to summary
public static final int makeUnicodeScalar(int high_surrogate, int low_surrogate)
com.amazon.ion.impl back to summary

public final Enum _Private_IonConstants.HighNibble

extends Enum<_Private_IonConstants.HighNibble>
Class Inheritance

Field Summary

Modifier and TypeField and Description
private boolean
private boolean
private int
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble
public static final _Private_IonConstants.HighNibble

Constructor Summary

AccessConstructor and Description
private
HighNibble(int value, boolean lengthFollows, boolean isContainer)

Method Summary

Modifier and TypeMethod and Description
public static _Private_IonConstants.HighNibble
getHighNibble(int hn)

public boolean
public boolean
public int
public static _Private_IonConstants.HighNibble
public static _Private_IonConstants.HighNibble[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

_isContainerback to summary
private boolean _isContainer
_lengthFollowsback to summary
private boolean _lengthFollows
_valueback to summary
private int _value
hnBlobback to summary
public static final _Private_IonConstants.HighNibble hnBlob
hnBooleanback to summary
public static final _Private_IonConstants.HighNibble hnBoolean
hnClobback to summary
public static final _Private_IonConstants.HighNibble hnClob
hnDecimalback to summary
public static final _Private_IonConstants.HighNibble hnDecimal
hnFloatback to summary
public static final _Private_IonConstants.HighNibble hnFloat
hnListback to summary
public static final _Private_IonConstants.HighNibble hnList
hnNegIntback to summary
public static final _Private_IonConstants.HighNibble hnNegInt
hnNullback to summary
public static final _Private_IonConstants.HighNibble hnNull
hnPosIntback to summary
public static final _Private_IonConstants.HighNibble hnPosInt
hnSexpback to summary
public static final _Private_IonConstants.HighNibble hnSexp
hnStringback to summary
public static final _Private_IonConstants.HighNibble hnString
hnStructback to summary
public static final _Private_IonConstants.HighNibble hnStruct
hnSymbolback to summary
public static final _Private_IonConstants.HighNibble hnSymbol
hnTimestampback to summary
public static final _Private_IonConstants.HighNibble hnTimestamp
hnTypedeclback to summary
public static final _Private_IonConstants.HighNibble hnTypedecl
hnUnusedback to summary
public static final _Private_IonConstants.HighNibble hnUnused

Constructor Detail

HighNibbleback to summary
private HighNibble(int value, boolean lengthFollows, boolean isContainer)

Method Detail

getHighNibbleback to summary
public static _Private_IonConstants.HighNibble getHighNibble(int hn)
isContainerback to summary
public boolean isContainer()
lengthAlwaysFollowsback to summary
public boolean lengthAlwaysFollows()
valueback to summary
public int value()
valueOfback to summary
public static _Private_IonConstants.HighNibble valueOf(String name)
valuesback to summary
public static _Private_IonConstants.HighNibble[] values()