Top Description Fields Methods
com.amazon.ion

public Interface IonBool

extends IonValue
Known Direct Implementers
com.amazon.ion.impl.lite.IonBoolLite
An Ion bool 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 boolean

Returns:

the boolean value.
booleanValue()

Gets the value of this Ion bool as a Java boolean value.

public IonBool
clone()

Redeclares com.amazon.ion.IonValue.clone.

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

public void
setValue(boolean
the new value for this bool.
b)

Sets this instance to have a specific value.

public void
setValue(Boolean
the new value for this bool; may be null to make this null.bool.
b)

Sets this instance to have a specific value.

Inherited from com.amazon.ion.IonValue:
acceptaddTypeAnnotationclearTypeAnnotationsequalsgetContainergetFieldIdgetFieldNamegetFieldNameSymbolgetSymbolTablegetSystemgetTypegetTypeAnnotationsgetTypeAnnotationSymbolshashCodehasTypeAnnotationisNullValueisReadOnlymakeReadOnlyremoveFromContainerremoveTypeAnnotationsetTypeAnnotationssetTypeAnnotationSymbolstopLevelValuetoPrettyStringtoStringtoStringwriteTo

Method Detail

booleanValueback to summary
public boolean booleanValue() throws NullValueException

Gets the value of this Ion bool as a Java boolean value.

Returns:boolean

the boolean value.

Exceptions
NullValueException:
if this.isNullValue().
cloneback to summary
public IonBool 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(boolean b)

Sets this instance to have a specific value.

Parameters
b:boolean

the new value for this bool.

setValueback to summary
public void setValue(Boolean b)

Sets this instance to have a specific value.

Parameters
b:Boolean

the new value for this bool; may be null to make this null.bool.