Top Description Fields Methods
com.amazon.ion

public Interface IonClob

extends IonValue, IonLob
Known Direct Implementers
com.amazon.ion.impl.lite.IonClobLite
Imports
java.io.Reader, java.nio.charset.Charset
An Ion clob value.

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

Redeclares com.amazon.ion.IonValue.clone, com.amazon.ion.IonLob.clone.

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

public Reader

Returns:

a new reader positioned at the start of the clob, or null if this.isNullValue().
newReader(Charset
must not be null.
cs)

Creates a new Reader that provides the value of this clob as text, decoding the raw bytes using a given character set.

public String

Returns:

the decoded text, or null if this.isNullValue().
stringValue(Charset
must not be null.
cs)

Gets the value of this clob as a Java String value, decoding the raw bytes using a given character set.

Inherited from com.amazon.ion.IonLob:
byteSizegetBytesnewInputStreamsetBytessetBytes
Inherited from com.amazon.ion.IonValue:
acceptaddTypeAnnotationclearTypeAnnotationsequalsgetContainergetFieldIdgetFieldNamegetFieldNameSymbolgetSymbolTablegetSystemgetTypegetTypeAnnotationsgetTypeAnnotationSymbolshashCodehasTypeAnnotationisNullValueisReadOnlymakeReadOnlyremoveFromContainerremoveTypeAnnotationsetTypeAnnotationssetTypeAnnotationSymbolstopLevelValuetoPrettyStringtoStringtoStringwriteTo

Method Detail

cloneback to summary
public IonClob clone() throws UnknownSymbolException

Redeclares com.amazon.ion.IonValue.clone, com.amazon.ion.IonLob.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.
newReaderback to summary
public Reader newReader(Charset cs)

Creates a new Reader that provides the value of this clob as text, decoding the raw bytes using a given character set.

Parameters
cs:Charset

must not be null.

Returns:Reader

a new reader positioned at the start of the clob, or null if this.isNullValue().

stringValueback to summary
public String stringValue(Charset cs)

Gets the value of this clob as a Java String value, decoding the raw bytes using a given character set. This is a convenience wrapper around newReader(Charset).

The behavior of this method when the clob bytes are not valid in the given charset is unspecified.

Parameters
cs:Charset

must not be null.

Returns:String

the decoded text, or null if this.isNullValue().