Package com.amazon.ion
Interface IonSymbol
- All Known Subinterfaces:
_Private_IonSymbol
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 TypeMethodDescriptionclone()
Creates a copy of this value and all of its children.int
Deprecated.void
Changes the value of this element.Gets the text content of this symbol.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 Details
-
stringValue
Gets the text content of this symbol.- Specified by:
stringValue
in interfaceIonText
- Returns:
- the text of the symbol, or
null
if this isnull.symbol
. - Throws:
UnknownSymbolException
- if this symbol has unknown text.- See Also:
-
getSymbolId
Deprecated.UsesymbolValue()
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 isnull.symbol
.
-
symbolValue
SymbolToken symbolValue()Returns this value as a symbol token (text + ID).- Returns:
- null if
IonValue.isNullValue()
-
setValue
Changes the value of this element. -
clone
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 instanceIonValue.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 useValueFactory.clone(IonValue)
instead.- Specified by:
clone
in interfaceIonText
- Specified by:
clone
in interfaceIonValue
- Throws:
UnknownSymbolException
- if any part of this value has unknown text but known Sid for its field name, annotation or symbol.
-
symbolValue()
instead.