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

public Interface _Private_IonValue

extends IonValue
Known Direct Subinterfaces
com.amazon.ion.impl._Private_IonDatagram
Known Direct Implementers
com.amazon.ion.impl.lite.IonValueLite
Imports
com.amazon.ion.IonDatagram, .IonValue, .SymbolTable, .SymbolToken, java.io.PrintWriter

NOT FOR APPLICATION USE!

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
_Private_IonValue.SymbolTableProvider

Provides an IonValue's SymbolTable.

Field Summary

Inherited from com.amazon.ion.IonValue:
EMPTY_ARRAY

Method Summary

Modifier and TypeMethod and Description
public void
public int

Returns:

the index or -1.
findTypeAnnotation
(String
the annotation to find.
annotation
)

Returns the given annotation's index in the value's annotations list, or -1 if not present.

public SymbolTable
getAssignedSymbolTable()

Returns the symbol table that is directly associated with this value, without doing any recursive lookup.

public int

Returns:

int the offset of this value in its containers member list
getElementId
()

public SymbolToken

Returns:

the field name SymbolToken
getFieldNameSymbol
(_Private_IonValue.SymbolTableProvider
- provides this IonValue's symbol table
symbolTableProvider
)

Overrides IonValue#getFieldNameSymbol() for use when there exists a SymbolTableProvider implementation for this IonValue.

public SymbolToken[]

Returns:

the type annotation SymbolTokens
getTypeAnnotationSymbols
(_Private_IonValue.SymbolTableProvider
- provides this IonValue's symbol table
symbolTableProvider
)

Overrides IonValue#getTypeAnnotationSymbols() for use when there exists a SymbolTableProvider implementation for this IonValue.

public void
setSymbolTable(SymbolTable
must be local or system table. May be null.
symbols
)

Makes this symbol table current for this value.

public String
Inherited from com.amazon.ion.IonValue:
acceptaddTypeAnnotationclearTypeAnnotationscloneequalsgetContainergetFieldIdgetFieldNamegetFieldNameSymbolgetSymbolTablegetSystemgetTypegetTypeAnnotationsgetTypeAnnotationSymbolshashCodehasTypeAnnotationisNullValueisReadOnlymakeReadOnlyremoveFromContainerremoveTypeAnnotationsetTypeAnnotationssetTypeAnnotationSymbolstopLevelValuetoPrettyStringtoStringtoStringwriteTo

Method Detail

dumpback to summary
public void dump(PrintWriter out)
findTypeAnnotationback to summary
public int findTypeAnnotation(String annotation)

Returns the given annotation's index in the value's annotations list, or -1 if not present.

Parameters
annotation:String

the annotation to find.

Returns:int

the index or -1.

getAssignedSymbolTableback to summary
public SymbolTable getAssignedSymbolTable()

Returns the symbol table that is directly associated with this value, without doing any recursive lookup. Values that are not top-level will return null as they don't actually own their own symbol table.

Exceptions
UnsupportedOperationException:
if this is an IonDatagram.
getElementIdback to summary
public int getElementId()
Returns:int

int the offset of this value in its containers member list

getFieldNameSymbolback to summary
public SymbolToken getFieldNameSymbol(_Private_IonValue.SymbolTableProvider symbolTableProvider)

Overrides IonValue#getFieldNameSymbol() for use when there exists a SymbolTableProvider implementation for this IonValue.

Parameters
symbolTableProvider:_Private_IonValue.SymbolTableProvider

- provides this IonValue's symbol table

Returns:SymbolToken

the field name SymbolToken

See Also
IonValue#getFieldNameSymbol()
getTypeAnnotationSymbolsback to summary
public SymbolToken[] getTypeAnnotationSymbols(_Private_IonValue.SymbolTableProvider symbolTableProvider)

Overrides IonValue#getTypeAnnotationSymbols() for use when there exists a SymbolTableProvider implementation for this IonValue.

Parameters
symbolTableProvider:_Private_IonValue.SymbolTableProvider

- provides this IonValue's symbol table

Returns:SymbolToken[]

the type annotation SymbolTokens

See Also
IonValue#getTypeAnnotationSymbols()
setSymbolTableback to summary
public void setSymbolTable(SymbolTable symbols)

Makes this symbol table current for this value. This may directly apply to this IonValue if this value is either loose or a top level datagram member. Or it may be delegated to the IonContainer this value is a contained in.

Assigning null forces any symbol values to be resolved to strings and any associated symbol table will be removed.

Parameters
symbols:SymbolTable

must be local or system table. May be null.

Exceptions
UnsupportedOperationException:
if this is a datagram.
validateback to summary
public String validate()
com.amazon.ion.impl back to summary

public Interface _Private_IonValue.SymbolTableProvider

Known Direct Implementers
com.amazon.ion.impl.lite.IonValueLite.LazySymbolTableProvider, com.amazon.ion.util.Printer.BasicSymbolTableProvider

Provides an IonValue's SymbolTable.

Method Summary

Modifier and TypeMethod and Description
public SymbolTable

Method Detail

getSymbolTableback to summary
public SymbolTable getSymbolTable()