software.amazon.ion

Interface IonText

All Superinterfaces:

Cloneable, IonValue

All Known Subinterfaces:

IonString, IonSymbol

public interface IonText
extends IonValue

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

Fields inherited from interface software.amazon.ion.IonValue

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
IonText	clone() Creates a copy of this value and all of its children.
void	setValue(String value) Changes the content.
String	stringValue() Gets the characters of this text value.

Methods inherited from interface software.amazon.ion.IonValue

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

Method Detail

stringValue

String stringValue()

Gets the characters of this text value.

Returns:

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

Throws:

UnknownSymbolException - if this is a symbol with unknown text.

See Also:

IonSymbol.symbolValue()

setValue

void setValue(String value)
       throws EmptySymbolException

Changes the content.

Parameters:

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

Throws:

EmptySymbolException - if this is an IonSymbol and value is the empty string.

clone

IonText 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 IonValue

Throws:

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