Top Description Fields Methods
com.amazon.ion

public Interface IonText

extends IonValue
Known Direct Subinterfaces
com.amazon.ion.IonString, com.amazon.ion.IonSymbol
Known Direct Implementers
com.amazon.ion.impl.lite.IonTextLite
Common functionality of Ion string and symbol types.

Warning

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

Field Summary

Inherited from com.amazon.ion.IonValue:
EMPTY_ARRAY

Method Summary

Modifier and TypeMethod and Description
public IonText
clone()

Redeclares com.amazon.ion.IonValue.clone.

Creates a copy of this value and all of its children.

public void
setValue(String
the new value of this text value; may be null to make this an Ion null value.
value)

Changes the content.

public String

Returns:

the text of this Ion value, or null if this.isNullValue().
stringValue()

Gets the characters of this text value.

Inherited from com.amazon.ion.IonValue:
acceptaddTypeAnnotationclearTypeAnnotationsequalsgetContainergetFieldIdgetFieldNamegetFieldNameSymbolgetSymbolTablegetSystemgetTypegetTypeAnnotationsgetTypeAnnotationSymbolshashCodehasTypeAnnotationisNullValueisReadOnlymakeReadOnlyremoveFromContainerremoveTypeAnnotationsetTypeAnnotationssetTypeAnnotationSymbolstopLevelValuetoPrettyStringtoStringtoStringwriteTo

Method Detail

cloneback to summary
public IonText clone() throws UnknownSymbolException

Redeclares com.amazon.ion.IonValue.clone.

Doc from com.amazon.ion.IonValue.clone.

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 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.

Exceptions
UnknownSymbolException:
if any part of this value has unknown text but known Sid for its field name, annotation or symbol.
setValueback to summary
public void setValue(String value)

Changes the content.

Parameters
value:String

the new value of this text value; may be null to make this an Ion null value.

stringValueback to summary
public String stringValue()

Gets the characters of this text value.

Returns:String

the text of this Ion value, or null if this.isNullValue().

Exceptions
UnknownSymbolException:
if this is a symbol with unknown text.
See Also
IonSymbol#symbolValue()