Package wtf.choco.veinminer.block

Class VeinMinerBlockState

java.lang.Object

wtf.choco.veinminer.block.VeinMinerBlockState

All Implemented Interfaces:

Comparable<VeinMinerBlock>, VeinMinerBlock

public final class VeinMinerBlockState
extends Object
implements VeinMinerBlock

A type of VeinMinerBlock backed by a BlockState.

Field Summary

Fields inherited from interface wtf.choco.veinminer.block.VeinMinerBlock

WILDCARD

Constructor Summary

Constructors

Constructor	Description
VeinMinerBlockState(@NotNull BlockState state)	Construct a new VeinMinerBlockState.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
@NotNull BlockState	getState()	Get the BlockState represented by this block.
@NotNull BlockType	getType()	Get the BlockType represented by this block.
int	hashCode()
boolean	hasState()	Check whether or not this block has at least one state set.
boolean	matchesState(@NotNull BlockState state, boolean exact)	Check whether or not this VeinMinerBlock matches the given BlockState.
boolean	matchesType(@NotNull BlockType type)	Check whether or not this VeinMinerBlock matches the given BlockType.
@NotNull String	toStateString()	Get this VeinMinerBlock as a state string.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface wtf.choco.veinminer.block.VeinMinerBlock

compareTo, matchesState

Constructor Details

VeinMinerBlockState

public VeinMinerBlockState(@NotNull
 @NotNull BlockState state)

Construct a new VeinMinerBlockState.

Parameters:

state - the state

Method Details

getType

@NotNull
public @NotNull BlockType getType()

Description copied from interface: VeinMinerBlock

Get the BlockType represented by this block.

Specified by:

getType in interface VeinMinerBlock

Returns:

the type

getState

@NotNull
public @NotNull BlockState getState()

Description copied from interface: VeinMinerBlock

Get the BlockState represented by this block.

If this block has no state (e.g. VeinMinerBlock.hasState() is false), this method should return a state with default block state values.

Specified by:

getState in interface VeinMinerBlock

Returns:

the state

hasState

public boolean hasState()

Description copied from interface: VeinMinerBlock

Check whether or not this block has at least one state set.

Specified by:

hasState in interface VeinMinerBlock

Returns:

true if a state is set, false otherwise

matchesType

public boolean matchesType(@NotNull
 @NotNull BlockType type)

Description copied from interface: VeinMinerBlock

Check whether or not this VeinMinerBlock matches the given BlockType.

Specified by:

matchesType in interface VeinMinerBlock

Parameters:

type - the type to check

Returns:

true if this block matches the given type, false otherwise

matchesState

public boolean matchesState(@NotNull
 @NotNull BlockState state,
 boolean exact)

Description copied from interface: VeinMinerBlock

Check whether or not this VeinMinerBlock matches the given BlockState.

Specified by:

matchesState in interface VeinMinerBlock

Parameters:

state - the state to check

exact - whether or not to match against all states

Returns:

true if matches, false otherwise

toStateString

@NotNull
public @NotNull String toStateString()

Description copied from interface: VeinMinerBlock

Get this VeinMinerBlock as a state string.

Specified by:

toStateString in interface VeinMinerBlock

Returns:

the state string

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object