software.amazon.smithy.model.node

Class BooleanNode

java.lang.Object

software.amazon.smithy.model.node.Node

software.amazon.smithy.model.node.BooleanNode

All Implemented Interfaces:

FromSourceLocation, ToNode

public final class BooleanNode
extends Node

Represents a boolean node.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.smithy.model.node.Node

Node.NonNumericFloat

Constructor Summary

Constructors

Constructor and Description
BooleanNode(boolean value, SourceLocation sourceLocation)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(NodeVisitor<R> visitor) Accepts a visitor with the node.
java.util.Optional<BooleanNode>	asBooleanNode() Gets the node as an BooleanNode if it is an boolean.
boolean	equals(java.lang.Object other)
BooleanNode	expectBooleanNode(java.lang.String errorMessage) Casts the current node to a BooleanNode, throwing ExpectationNotMetException when the node is the wrong type.
BooleanNode	expectBooleanNode(java.util.function.Supplier<java.lang.String> errorMessage) Casts the current node to a BooleanNode, throwing ExpectationNotMetException when the node is the wrong type.
NodeType	getType() Gets the type of the node.
boolean	getValue() Gets the true or false value of the boolean node.
int	hashCode()
java.lang.String	toString()

Methods inherited from class software.amazon.smithy.model.node.Node

arrayNode, arrayNode, asArrayNode, asNullNode, asNumberNode, asObjectNode, assertEquals, asStringNode, diff, expectArrayNode, expectArrayNode, expectArrayNode, expectBooleanNode, expectNullNode, expectNullNode, expectNullNode, expectNumberNode, expectNumberNode, expectNumberNode, expectObjectNode, expectObjectNode, expectObjectNode, expectStringNode, expectStringNode, expectStringNode, from, from, from, fromNodes, fromNodes, fromStrings, fromStrings, getSourceLocation, isArrayNode, isBooleanNode, isNullNode, isNumberNode, isObjectNode, isStringNode, loadArrayOfString, nullNode, objectNode, objectNode, objectNodeBuilder, parse, parse, parse, parse, parseJsonWithComments, parseJsonWithComments, prettyPrintJson, prettyPrintJson, printJson, toNode, withDeepSortedKeys, withDeepSortedKeys

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanNode

public BooleanNode(boolean value,
                   SourceLocation sourceLocation)

Method Detail

getValue

public boolean getValue()

Gets the true or false value of the boolean node.

Returns:

Returns true or false.

getType

public NodeType getType()

Description copied from class: Node

Gets the type of the node.

Specified by:

getType in class Node

Returns:

Returns the node type.

accept

public <R> R accept(NodeVisitor<R> visitor)

Description copied from class: Node

Accepts a visitor with the node.

Specified by:

accept in class Node

Type Parameters:

R - visitor return type.

Parameters:

visitor - Visitor to dispatch to.

Returns:

Returns the accepted result.

expectBooleanNode

public BooleanNode expectBooleanNode(java.lang.String errorMessage)

Description copied from class: Node

Casts the current node to a BooleanNode, throwing ExpectationNotMetException when the node is the wrong type.

Overrides:

expectBooleanNode in class Node

Parameters:

errorMessage - Error message to use if the node is of the wrong type.

Returns:

Returns a boolean node.

expectBooleanNode

public BooleanNode expectBooleanNode(java.util.function.Supplier<java.lang.String> errorMessage)

Description copied from class: Node

Casts the current node to a BooleanNode, throwing ExpectationNotMetException when the node is the wrong type.

Overrides:

expectBooleanNode in class Node

Parameters:

errorMessage - Error message supplier.

Returns:

Returns a boolean node.

asBooleanNode

public java.util.Optional<BooleanNode> asBooleanNode()

Description copied from class: Node

Gets the node as an BooleanNode if it is an boolean.

Overrides:

asBooleanNode in class Node

Returns:

Returns the optional BooleanNode.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object