Package org.mockbukkit.mockbukkit.block.state

Class ContainerStateMock

java.lang.Object

org.mockbukkit.mockbukkit.block.state.BlockStateMock

org.mockbukkit.mockbukkit.block.state.TileStateMock

org.mockbukkit.mockbukkit.block.state.LockableTileStateMock

org.mockbukkit.mockbukkit.block.state.ContainerStateMock

All Implemented Interfaces:

LockableTileState, TileStateInventoryHolder, PersistentDataViewHolder, BlockState, Container, Lockable, TileState, BlockInventoryHolder, InventoryHolder, Metadatable, Nameable, PersistentDataHolder

Direct Known Subclasses:

AbstractFurnaceStateMock, BarrelStateMock, BrewingStandStateMock, ChestStateMock, DispenserStateMock, DropperStateMock, HopperStateMock, LecternStateMock, ShulkerBoxStateMock

public abstract class ContainerStateMock
extends LockableTileStateMock
implements Container

Mock implementation of a Container.

See Also:

• TileStateMock

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected abstract @NotNull InventoryMock	createInventory()
protected @NotNull InventoryMock	createInventoryCopy(@NotNull Inventory inventory)
@Nullable net.kyori.adventure.text.Component	customName()
void	customName(@Nullable net.kyori.adventure.text.Component customName)
boolean	equals(Object o)
@Nullable String	getCustomName()
@NotNull Inventory	getInventory()
@NotNull String	getLock()
abstract @NotNull ContainerStateMock	getSnapshot()	This returns a copy of this BlockStateMock.
@NotNull Inventory	getSnapshotInventory()
int	hashCode()
boolean	isLocked()
void	setCustomName(@Nullable String name)
void	setLock(@Nullable String key)
protected String	toStringInternal()	Provides the contents of BlockStateMock.toString() .

Methods inherited from class org.mockbukkit.mockbukkit.block.state.LockableTileStateMock

setLockItem

Methods inherited from class org.mockbukkit.mockbukkit.block.state.TileStateMock

getPersistentDataContainer, isSnapshot

Methods inherited from class org.mockbukkit.mockbukkit.block.state.BlockStateMock

checkType, checkType, checkType, checkType, copy, copy, getBlock, getBlockData, getChunk, getData, getDrops, getDrops, getDrops, getLightLevel, getLocation, getLocation, getMetadata, getRawData, getType, getWorld, getX, getY, getZ, hasMetadata, isCollidable, isPlaced, mockState, mockState, removeMetadata, setBlockData, setData, setMetadata, setRawData, setType, toString, update, update, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bukkit.inventory.BlockInventoryHolder

getBlock

Methods inherited from interface org.bukkit.block.BlockState

copy, copy, getBlock, getBlockData, getChunk, getData, getDrops, getDrops, getDrops, getLightLevel, getLocation, getLocation, getRawData, getType, getWorld, getX, getY, getZ, isCollidable, isPlaced, setBlockData, setData, setRawData, setType, update, update, update

Methods inherited from interface org.bukkit.block.Lockable

setLockItem

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.block.TileState

getPersistentDataContainer, isSnapshot

Constructor Details

ContainerStateMock

protected ContainerStateMock(@NotNull
 @NotNull Material material)

Constructs a new ContainerStateMock for the provided Material.

Parameters:

material - The material this state is for.

ContainerStateMock

protected ContainerStateMock(@NotNull
 @NotNull Block block)

Constructs a new ContainerStateMock for the provided Block.

Parameters:

block - The block this state is for.

ContainerStateMock

protected ContainerStateMock(@NotNull
 @NotNull ContainerStateMock state)

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

Parameters:

state - The state to clone.

Method Details

createInventory

@NotNull
protected abstract @NotNull InventoryMock createInventory()

Returns:

A new inventory, of the correct type for the state.

createInventoryCopy

@NotNull
protected @NotNull InventoryMock createInventoryCopy(@NotNull
 @NotNull Inventory inventory)

Parameters:

inventory - Inventory contents to copy.

Returns:

A new inventory, of the correct type for the state with contents deep-copied from the given inventory.

getSnapshot

@NotNull
public abstract @NotNull ContainerStateMock getSnapshot()

Description copied from class: BlockStateMock

This returns a copy of this BlockStateMock. Inheriters of this class must override this method!

Specified by:

getSnapshot in class LockableTileStateMock

Returns:

A snapshot of this BlockStateMock.

isLocked

public boolean isLocked()

Specified by:

isLocked in interface Lockable

Specified by:

isLocked in class LockableTileStateMock

getLock

@NotNull
public @NotNull String getLock()

Specified by:

getLock in interface Lockable

Specified by:

getLock in class LockableTileStateMock

setLock

public void setLock(@Nullable
 @Nullable String key)

Specified by:

setLock in interface Lockable

Specified by:

setLock in class LockableTileStateMock

customName

@Nullable
public @Nullable net.kyori.adventure.text.Component customName()

Specified by:

customName in interface Nameable

customName

public void customName(@Nullable
 @Nullable net.kyori.adventure.text.Component customName)

Specified by:

customName in interface Nameable

getCustomName

@Nullable
public @Nullable String getCustomName()

Specified by:

getCustomName in interface Nameable

setCustomName

public void setCustomName(@Nullable
 @Nullable String name)

Specified by:

setCustomName in interface Nameable

getInventory

@NotNull
public @NotNull Inventory getInventory()

Specified by:

getInventory in interface InventoryHolder

Specified by:

getInventory in interface TileStateInventoryHolder

getSnapshotInventory

@NotNull
public @NotNull Inventory getSnapshotInventory()

Specified by:

getSnapshotInventory in interface TileStateInventoryHolder

equals

public boolean equals(Object o)

Overrides:

equals in class TileStateMock

hashCode

public int hashCode()

Overrides:

hashCode in class TileStateMock

toStringInternal

protected String toStringInternal()

Description copied from class: BlockStateMock

Provides the contents of BlockStateMock.toString() .

Implementors must call super as in the following example.

	@Override
	protected String toStringInternal()
	{
		return super.toStringInternal() +
				", member1=" + member1 +
				", member2=" + member2;
	}
 

Overrides:

toStringInternal in class TileStateMock

Returns:

Comma separated list of properties and values.