Package com.amazon.ion

Interface IonSymbol

All Superinterfaces:

java.lang.Cloneable, IonText, IonValue

All Known Subinterfaces:

_Private_IonSymbol

public interface IonSymbol
extends IonText

An Ion symbol value.

WARNING: This interface should not be implemented or extended by code outside of this library.

Field Summary

Fields inherited from interface com.amazon.ion.IonValue

EMPTY_ARRAY

Method Summary

Modifier and Type	Method	Description
IonSymbol	clone()	Creates a copy of this value and all of its children.
int	getSymbolId()	Deprecated. Use symbolValue() instead.
void	setValue(java.lang.String value)	Changes the value of this element.
java.lang.String	stringValue()	Gets the text content of this symbol.
SymbolToken	symbolValue()	Returns this value as a symbol token (text + ID).

Methods inherited from interface com.amazon.ion.IonValue

accept, addTypeAnnotation, clearTypeAnnotations, equals, getContainer, getFieldId, getFieldName, getFieldNameSymbol, getSymbolTable, getSystem, getType, getTypeAnnotations, getTypeAnnotationSymbols, hashCode, hasTypeAnnotation, isNullValue, isReadOnly, makeReadOnly, removeFromContainer, removeTypeAnnotation, setTypeAnnotations, setTypeAnnotationSymbols, topLevelValue, toPrettyString, toString, toString, writeTo

Method Detail

stringValue

java.lang.String stringValue()
                      throws UnknownSymbolException

Gets the text content of this symbol.

Specified by:

stringValue in interface IonText

Returns:

the text of the symbol, or null if this is null.symbol.

Throws:

UnknownSymbolException - if this symbol has unknown text.

See Also:

symbolValue()

getSymbolId

@Deprecated
int getSymbolId()
         throws NullValueException

Deprecated.

Use symbolValue() instead.

Gets the integer symbol id used in the binary encoding of this symbol.

Returns:

an integer greater than zero, if this value has an associated symbol table. Otherwise, return SymbolTable.UNKNOWN_SYMBOL_ID.

Throws:

NullValueException - if this is null.symbol.

symbolValue

SymbolToken symbolValue()

Returns this value as a symbol token (text + ID).

Returns:

null if IonValue.isNullValue()

setValue

void setValue(java.lang.String value)

Changes the value of this element.

Specified by:

setValue in interface IonText

Parameters:

value - the new value of this symbol; may be null to make this null.symbol.

clone

IonSymbol clone()
         throws UnknownSymbolException

Description copied from interface: IonValue

Creates a copy of this value and all of its children. The cloned value may use the same shared symbol tables, but it will have an independent local symbol table if necessary. The cloned value will be modifiable regardless of whether this instance IonValue.isReadOnly().

The cloned value will be created in the context of the same ValueFactory as this instance; if you want a copy using a different factory, then use ValueFactory.clone(IonValue) instead.

Specified by:

clone in interface IonText

Specified by:

clone in interface IonValue

Throws:

UnknownSymbolException - if any part of this value has unknown text but known Sid for its field name, annotation or symbol.