Package com.amazon.ion

Interface IonString

All Superinterfaces:

java.lang.Cloneable, IonText, IonValue

public interface IonString
extends IonText

An Ion string 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
IonString	clone()	Creates a copy of this value and all of its children.
void	setValue(java.lang.String value)	Changes the value of this string.
java.lang.String	stringValue()	Gets the characters of this string.

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()

Gets the characters of this string.

Specified by:

stringValue in interface IonText

Returns:

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

See Also:

IonSymbol.symbolValue()

setValue

void setValue(java.lang.String value)

Changes the value of this string.

Specified by:

setValue in interface IonText

Parameters:

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

clone

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