com.ibm.cos.v2.core.document.internal

Class BooleanDocument

java.lang.Object

com.ibm.cos.v2.core.document.internal.BooleanDocument

All Implemented Interfaces:

Document, Serializable

@Immutable
public final class BooleanDocument
extends Object
implements Document

Represents a Boolean Document.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cos.v2.core.document.Document

Document.ListBuilder, Document.MapBuilder

Field Summary

Fields inherited from interface com.ibm.cos.v2.core.document.Document

FALSE_DOCUMENT, NULL_DOCUMENT, TRUE_DOCUMENT

Constructor Summary

Constructors

Constructor and Description
BooleanDocument(boolean value) Create a New BooleanDocument with boolean value as passed in constructor

Method Summary

Modifier and Type	Method and Description
<R> R	accept(DocumentVisitor<? extends R> visitor) Accepts a visitor with the Document.
void	accept(VoidDocumentVisitor visitor) Accepts a visitor with the Document.
boolean	asBoolean() Gets the boolean value of the Document.
List<Document>	asList()
Map<String,Document>	asMap()
SdkNumber	asNumber()
String	asString()
boolean	equals(Object o)
int	hashCode()
boolean	isBoolean() Indicates this is a Boolean Document.
String	toString()
Object	unwrap() Unwraps the Document Boolean to a Boolean Object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.core.document.Document

fromBoolean, fromList, fromMap, fromNull, fromNumber, fromNumber, fromNumber, fromNumber, fromNumber, fromNumber, fromNumber, fromNumber, fromString, isList, isMap, isNull, isNumber, isString, listBuilder, mapBuilder

Constructor Detail

BooleanDocument

public BooleanDocument(boolean value)

Create a New BooleanDocument with boolean value as passed in constructor

Parameters:

value - boolean value.

Method Detail

unwrap

public Object unwrap()

Unwraps the Document Boolean to a Boolean Object.

Specified by:

unwrap in interface Document

Returns:

boolean value.

isBoolean

public boolean isBoolean()

Indicates this is a Boolean Document.

Specified by:

isBoolean in interface Document

Returns:

true since this is a Boolean Document.

asBoolean

public boolean asBoolean()

Gets the boolean value of the Document.

Specified by:

asBoolean in interface Document

Returns:

boolean value.

asString

public String asString()

Specified by:

asString in interface Document

Returns:

Returns the string value.

asNumber

public SdkNumber asNumber()

Specified by:

asNumber in interface Document

Returns:

Returns the SdkNumber.

asMap

public Map<String,Document> asMap()

Specified by:

asMap in interface Document

Returns:

Returns the Document map.

asList

public List<Document> asList()

Specified by:

asList in interface Document

Returns:

Returns the lists of Document.

accept

public <R> R accept(DocumentVisitor<? extends R> visitor)

Accepts a visitor with the Document.

Specified by:

accept in interface Document

Type Parameters:

R - visitor return type.

Parameters:

visitor - Visitor to dispatch to.

Returns:

Returns the accepted result by calling visitBoolean of visitor.

accept

public void accept(VoidDocumentVisitor visitor)

Accepts a visitor with the Document. Calls visitBoolean of visitor.

Specified by:

accept in interface Document

Parameters:

visitor - Visitor to dispatch to.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object