Package io.papermc.paper.command.brigadier.argument.predicate

Enum Class BlockInWorldPredicate.Result

java.lang.Object

java.lang.Enum<BlockInWorldPredicate.Result>

io.papermc.paper.command.brigadier.argument.predicate.BlockInWorldPredicate.Result

All Implemented Interfaces:

Serializable, Comparable<BlockInWorldPredicate.Result>, Constable

Enclosing interface:

BlockInWorldPredicate

public static enum BlockInWorldPredicate.Result
extends Enum<BlockInWorldPredicate.Result>

The predicate result is yielded by the BlockInWorldPredicate when applied to a block.

See Also:

• BlockInWorldPredicate.testBlock(Block)
• BlockInWorldPredicate.testBlock(Block, boolean)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FALSE	The block passed to the predicate does not match the predicate.
TRUE	The block passed to the predicate matches the predicate.
UNLOADED_CHUNK	The block passed to the predicate was in an unloaded chunk and the loadChunk flag was false.

Method Summary

Modifier and Type	Method	Description
boolean	asBoolean()	Converts the result into an approximated boolean representation.
static BlockInWorldPredicate.Result	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BlockInWorldPredicate.Result[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TRUE

public static final BlockInWorldPredicate.Result TRUE

The block passed to the predicate matches the predicate.

FALSE

public static final BlockInWorldPredicate.Result FALSE

The block passed to the predicate does not match the predicate.

UNLOADED_CHUNK

public static final BlockInWorldPredicate.Result UNLOADED_CHUNK

The block passed to the predicate was in an unloaded chunk and the loadChunk flag was false.

Method Details

values

public static BlockInWorldPredicate.Result[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BlockInWorldPredicate.Result valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

asBoolean

public boolean asBoolean()

Converts the result into an approximated boolean representation. Specifically, the following mappings are applied:

• TRUE -> true
• FALSE -> false
• UNLOADED_CHUNK -> false

Returns:

the boolean representation.