Package be.seeseemelk.mockbukkit.block.state

Class BlockStateMock

java.lang.Object

be.seeseemelk.mockbukkit.block.state.BlockStateMock

All Implemented Interfaces:

BlockState, Metadatable

Direct Known Subclasses:

TileStateMock

public class BlockStateMock
extends Object
implements BlockState

Mock implementation of a BlockState. Also manages the creation of new BlockStates with the appropriate mock class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BlockStateMock(@NotNull BlockStateMock state)	Constructs a new BlockStateMock by cloning the data from an existing one.
protected	BlockStateMock(@NotNull Block block)	Constructs a new BlockStateMock for the provided Block.
	BlockStateMock(@NotNull Material material)	Constructs a new BlockStateMock for the provided Material.

Method Summary

Modifier and Type	Method	Description
protected void	checkType(@NotNull Block block, @NotNull Material... expected)	Ensures the provided block type is one of the expected materials provided.
protected void	checkType(@NotNull Block block, @NotNull Tag<Material> expected)	Ensures the provided block type is contained in the Tag.
protected void	checkType(@NotNull Material material, @NotNull Material @NotNull ... expected)	Ensures the provided material is one of the expected materials provided.
protected void	checkType(@NotNull Material material, @NotNull Tag<Material> expected)	Ensures the provided material is contained in the Tag.
boolean	equals(Object obj)
@NotNull Block	getBlock()
@NotNull BlockData	getBlockData()
@NotNull Chunk	getChunk()
@NotNull MaterialData	getData()	Deprecated.
@NotNull Collection<ItemStack>	getDrops()
@NotNull Collection<ItemStack>	getDrops(@NotNull ItemStack tool, @Nullable Entity entity)
@NotNull Collection<ItemStack>	getDrops(@Nullable ItemStack tool)
byte	getLightLevel()
@NotNull Location	getLocation()
Location	getLocation(Location loc)
@NotNull List<MetadataValue>	getMetadata(String metadataKey)
byte	getRawData()	Deprecated.
@NotNull BlockState	getSnapshot()	This returns a copy of this BlockStateMock.
@NotNull Material	getType()
@NotNull World	getWorld()
int	getX()
int	getY()
int	getZ()
int	hashCode()
boolean	hasMetadata(String metadataKey)
boolean	isCollidable()
boolean	isPlaced()
static @NotNull BlockStateMock	mockState(@NotNull Block block)	Attempts to construct a BlockStateMock by the provided block.
void	removeMetadata(String metadataKey, Plugin owningPlugin)
void	setBlockData(BlockData data)
void	setData(MaterialData data)	Deprecated.
void	setMetadata(String metadataKey, @NotNull MetadataValue newMetadataValue)
void	setRawData(byte data)	Deprecated.
void	setType(Material type)
boolean	update()
boolean	update(boolean force)
boolean	update(boolean force, boolean applyPhysics)

Methods inherited from class java.lang.Object

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

Constructor Details

BlockStateMock

public BlockStateMock(@NotNull
 @NotNull Material material)

Constructs a new BlockStateMock for the provided Material.

Parameters:

material - The material this state is for.

BlockStateMock

protected BlockStateMock(@NotNull
 @NotNull Block block)

Constructs a new BlockStateMock for the provided Block.

Parameters:

block - The block this state is for.

BlockStateMock

protected BlockStateMock(@NotNull
 @NotNull BlockStateMock state)

Constructs a new BlockStateMock by cloning the data from an existing one.

Parameters:

state - The state to clone.

Method Details

checkType

protected void checkType(@NotNull
 @NotNull Material material,
 @NotNull
 @NotNull Material @NotNull ... expected)

Ensures the provided material is one of the expected materials provided.

Parameters:

material - The material to test.

expected - The expected materials.

checkType

protected void checkType(@NotNull
 @NotNull Block block,
 @NotNull
 @NotNull Material... expected)

Ensures the provided block type is one of the expected materials provided.

Parameters:

block - The block to test.

expected - The expected materials.

checkType

protected void checkType(@NotNull
 @NotNull Material material,
 @NotNull
 @NotNull Tag<Material> expected)

Ensures the provided material is contained in the Tag.

Parameters:

material - The material to test.

expected - The expected tag.

checkType

protected void checkType(@NotNull
 @NotNull Block block,
 @NotNull
 @NotNull Tag<Material> expected)

Ensures the provided block type is contained in the Tag.

Parameters:

block - The material to test.

expected - The expected tag.

setMetadata

public void setMetadata(String metadataKey,
 @NotNull
 @NotNull MetadataValue newMetadataValue)

Specified by:

setMetadata in interface Metadatable

getMetadata

@NotNull
public @NotNull List<MetadataValue> getMetadata(String metadataKey)

Specified by:

getMetadata in interface Metadatable

hasMetadata

public boolean hasMetadata(String metadataKey)

Specified by:

hasMetadata in interface Metadatable

removeMetadata

public void removeMetadata(String metadataKey,
 Plugin owningPlugin)

Specified by:

removeMetadata in interface Metadatable

getBlock

@NotNull
public @NotNull Block getBlock()

Specified by:

getBlock in interface BlockState

getData

@Deprecated
public @NotNull MaterialData getData()

Deprecated.

Specified by:

getData in interface BlockState

getType

@NotNull
public @NotNull Material getType()

Specified by:

getType in interface BlockState

getLightLevel

public byte getLightLevel()

Specified by:

getLightLevel in interface BlockState

getWorld

@NotNull
public @NotNull World getWorld()

Specified by:

getWorld in interface BlockState

getX

public int getX()

Specified by:

getX in interface BlockState

getY

public int getY()

Specified by:

getY in interface BlockState

getZ

public int getZ()

Specified by:

getZ in interface BlockState

getLocation

@NotNull
public @NotNull Location getLocation()

Specified by:

getLocation in interface BlockState

getLocation

public Location getLocation(Location loc)

Specified by:

getLocation in interface BlockState

getChunk

@NotNull
public @NotNull Chunk getChunk()

Specified by:

getChunk in interface BlockState

setData

@Deprecated
public void setData(@NotNull
 MaterialData data)

Deprecated.

Specified by:

setData in interface BlockState

setType

public void setType(Material type)

Specified by:

setType in interface BlockState

update

public boolean update()

Specified by:

update in interface BlockState

update

public boolean update(boolean force)

Specified by:

update in interface BlockState

update

public boolean update(boolean force,
 boolean applyPhysics)

Specified by:

update in interface BlockState

getRawData

@Deprecated
public byte getRawData()

Deprecated.

Specified by:

getRawData in interface BlockState

setRawData

@Deprecated
public void setRawData(byte data)

Deprecated.

Specified by:

setRawData in interface BlockState

isPlaced

public boolean isPlaced()

Specified by:

isPlaced in interface BlockState

isCollidable

public boolean isCollidable()

Specified by:

isCollidable in interface BlockState

getDrops

@NotNull
public @NotNull Collection<ItemStack> getDrops()

Specified by:

getDrops in interface BlockState

getDrops

@NotNull
public @NotNull Collection<ItemStack> getDrops(@Nullable
 @Nullable ItemStack tool)

Specified by:

getDrops in interface BlockState

getDrops

@NotNull
public @NotNull Collection<ItemStack> getDrops(@NotNull
 @NotNull ItemStack tool,
 @Nullable
 @Nullable Entity entity)

Specified by:

getDrops in interface BlockState

getBlockData

@NotNull
public @NotNull BlockData getBlockData()

Specified by:

getBlockData in interface BlockState

setBlockData

public void setBlockData(BlockData data)

Specified by:

setBlockData in interface BlockState

getSnapshot

@NotNull
public @NotNull BlockState getSnapshot()

This returns a copy of this BlockStateMock. Inheritents of this class should override this method!

Returns:

A snapshot of this BlockStateMock.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

mockState

@NotNull
public static @NotNull BlockStateMock mockState(@NotNull
 @NotNull Block block)

Attempts to construct a BlockStateMock by the provided block. Will return a basic BlockStateMock if no implementation is found.

Parameters:

block - The block to create the BlockState from.

Returns:

The BlockState.