Ion Java 1.11.10 · com.amazon.ion.impl.IonReaderContinuableApplication

Method Summary

Modifier and Type	Method and Description
public String	getFieldName() Return the field name of the current value.
public SymbolToken	Returns: null if there is no current value or if the current value is not a field of a struct. getFieldNameSymbol() Gets the current value's field name as a symbol token (text + ID).
public SymbolTable	getSymbolTable() Returns the symbol table that is applicable to the current value.
public String[]	Returns: the (ordered) annotations on the current value, or an empty array (not `null`) if there are none. getTypeAnnotations() Return the annotations of the current value as an array of strings.
public SymbolToken[]	Returns: the (ordered) annotations on the current value, or an empty array (not `null`) if there are none. getTypeAnnotationSymbols() Gets the current value's annotations as symbol tokens (text + ID).
public Iterator<String>	Returns: not null. iterateTypeAnnotations() Return the annotations on the curent value as an iterator.
public SymbolToken	Returns: null if `isNullValue()` symbolValue() Returns the current value as a symbol token (text + ID).

Method Detail

getFieldName	back to summary
public String getFieldName() Return the field name of the current value. Or null if there is no valid current value or if the current value is not a field of a struct. Exceptions UnknownSymbolException: if the field name has unknown text.

getFieldName

back to summary

public String getFieldName()

Return the field name of the current value. Or null if there is no valid current value or if the current value is not a field of a struct.

Exceptions

UnknownSymbolException:: if the field name has unknown text.

getFieldNameSymbol back to summary

getFieldNameSymbol	back to summary
public SymbolToken getFieldNameSymbol() Gets the current value's field name as a symbol token (text + ID). If the text of the token isn't known, the result's `SymbolToken#getText()` will be null. If the symbol ID of the token isn't known, the result's `SymbolToken#getSid()` will be `SymbolTable#UNKNOWN_SYMBOL_ID`. At least one of the two fields will be defined. Returns:SymbolToken null if there is no current value or if the current value is not a field of a struct.

public SymbolToken getFieldNameSymbol()

Gets the current value's field name as a symbol token (text + ID). If the text of the token isn't known, the result's SymbolToken#getText() will be null. If the symbol ID of the token isn't known, the result's SymbolToken#getSid() will be SymbolTable#UNKNOWN_SYMBOL_ID. At least one of the two fields will be defined.

Returns:SymbolToken: null if there is no current value or if the current value is not a field of a struct.

getSymbolTable	back to summary
public SymbolTable getSymbolTable() Returns the symbol table that is applicable to the current value. This may be either a system or local symbol table.

getTypeAnnotations back to summary

getTypeAnnotations	back to summary
public String[] getTypeAnnotations() Return the annotations of the current value as an array of strings. Returns:String[] the (ordered) annotations on the current value, or an empty array (not `null`) if there are none. Exceptions UnknownSymbolException: if any annotation has unknown text.

public String[] getTypeAnnotations()

Return the annotations of the current value as an array of strings.

Returns:String[]

the (ordered) annotations on the current value, or an empty array (not null) if there are none.

Exceptions

UnknownSymbolException:: if any annotation has unknown text.

getTypeAnnotationSymbols back to summary

getTypeAnnotationSymbols	back to summary
public SymbolToken[] getTypeAnnotationSymbols() Gets the current value's annotations as symbol tokens (text + ID). Returns:SymbolToken[] the (ordered) annotations on the current value, or an empty array (not `null`) if there are none.

public SymbolToken[] getTypeAnnotationSymbols()

Gets the current value's annotations as symbol tokens (text + ID).

Returns:SymbolToken[]: the (ordered) annotations on the current value, or an empty array (not null) if there are none.

iterateTypeAnnotations back to summary

iterateTypeAnnotations	back to summary
public Iterator<String> iterateTypeAnnotations() Return the annotations on the curent value as an iterator. The iterator is empty (hasNext() returns false on the first call) if there are no annotations on the current value. Implementations may throw `UnknownSymbolException` from this method if any annotation contains unknown text. Alternatively, implementations may provide an Iterator that throws `UnknownSymbolException` only when the user navigates the iterator to an annotation with unknown text. Note the iterator returned by this method is only valid while the reader remains positioned on the current value (i.e., before next, step in, or step out). Use cases that require storing a value's annotations after advancing past that value should either copy them from the iterator or call `getTypeAnnotations()`. Returns:Iterator<String> not null.

public Iterator<String> iterateTypeAnnotations()

Return the annotations on the curent value as an iterator. The iterator is empty (hasNext() returns false on the first call) if there are no annotations on the current value.

Implementations *may* throw UnknownSymbolException from this method if any annotation contains unknown text. Alternatively, implementations may provide an Iterator that throws UnknownSymbolException only when the user navigates the iterator to an annotation with unknown text.

Note

the iterator returned by this method is only valid while the reader remains positioned on the current value (i.e., before next, step in, or step out). Use cases that require storing a value's annotations after advancing past that value should either copy them from the iterator or call getTypeAnnotations().

Returns:Iterator<String>: not null.

symbolValue back to summary

symbolValue	back to summary
public SymbolToken symbolValue() Returns the current value as a symbol token (text + ID). This is only valid when `getType()` returns `IonType#SYMBOL`. Returns:SymbolToken null if `isNullValue()`

public SymbolToken symbolValue()

Returns the current value as a symbol token (text + ID). This is only valid when getType() returns IonType#SYMBOL.

Returns:SymbolToken: null if isNullValue()

pack-priv Interface IonReaderContinuableApplication

Method Summary

Method Detail