com.amazon.ion

Interface IonClob

All Superinterfaces:

java.lang.Cloneable, IonLob, IonValue

public interface IonClob
extends IonValue, IonLob

An Ion clob 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 and Description
IonClob	clone() Creates a copy of this value and all of its children.
java.io.Reader	newReader(java.nio.charset.Charset cs) Creates a new Reader that provides the value of this clob as text, decoding the raw bytes using a given character set.
java.lang.String	stringValue(java.nio.charset.Charset cs) Gets the value of this clob as a Java String value, decoding the raw bytes using a given character set.

Methods inherited from interface com.amazon.ion.IonLob

byteSize, getBytes, newInputStream, setBytes, setBytes

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

newReader

java.io.Reader newReader(java.nio.charset.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 - must not be null.

Returns:

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

stringValue

java.lang.String stringValue(java.nio.charset.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 - must not be null.

Returns:

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

clone

IonClob 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 IonLob

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.