software.amazon.ion

Interface IonBool

All Superinterfaces:

Cloneable, IonValue

public interface IonBool
extends IonValue

An Ion bool value.

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
boolean	booleanValue() Gets the value of this Ion bool as a Java boolean value.
IonBool	clone() Creates a copy of this value and all of its children.
void	setValue(boolean b) Sets this instance to have a specific value.
void	setValue(Boolean b) Sets this instance to have a specific 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

booleanValue

boolean booleanValue()
              throws NullValueException

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

Returns:

the boolean value.

Throws:

NullValueException - if this.isNullValue().

setValue

void setValue(boolean b)

Sets this instance to have a specific value.

Parameters:

b - the new value for this bool.

setValue

void setValue(Boolean b)

Sets this instance to have a specific value.

Parameters:

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

clone

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