Package be.seeseemelk.mockbukkit.block.state

Class SignMock

java.lang.Object

be.seeseemelk.mockbukkit.block.state.BlockStateMock

be.seeseemelk.mockbukkit.block.state.TileStateMock

be.seeseemelk.mockbukkit.block.state.SignMock

All Implemented Interfaces:

PersistentDataViewHolder, BlockState, Sign, TileState, Colorable, Metadatable, PersistentDataHolder

public class SignMock
extends TileStateMock
implements Sign

Mock implementation of a Sign.

See Also:

• TileStateMock

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@Nullable Player	getAllowedEditor()
@Nullable UUID	getAllowedEditorUniqueId()
@NotNull DyeColor	getColor()
@NotNull Side	getInteractableSideFor(double x, double z)
@NotNull String	getLine(int index)	Deprecated.
@NotNull String @NotNull []	getLines()	Deprecated.
@NotNull SignSide	getSide(@NotNull Side side)
@NotNull BlockState	getSnapshot()	This returns a copy of this BlockStateMock.
@NotNull SignSide	getTargetSide(@NotNull Player player)
boolean	isEditable()
boolean	isGlowingText()
boolean	isWaxed()
@NotNull net.kyori.adventure.text.Component	line(int index)
void	line(int index, @NotNull net.kyori.adventure.text.Component line)
@NotNull List<net.kyori.adventure.text.Component>	lines()
void	setAllowedEditorUniqueId(@Nullable UUID uuid)
void	setColor(@NotNull DyeColor color)
void	setEditable(boolean editable)
void	setGlowingText(boolean glowing)
void	setLine(int index, String line)	Deprecated.
void	setWaxed(boolean waxed)

Methods inherited from class be.seeseemelk.mockbukkit.block.state.TileStateMock

getPersistentDataContainer, isSnapshot

Methods inherited from class be.seeseemelk.mockbukkit.block.state.BlockStateMock

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

Methods inherited from class java.lang.Object

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

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.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.block.Sign

getInteractableSideFor, getInteractableSideFor

Methods inherited from interface org.bukkit.block.TileState

getPersistentDataContainer, isSnapshot

Constructor Details

SignMock

public SignMock(@NotNull
 @NotNull Material material)

Constructs a new SignMock for the provided Material. Only supports materials in Tag.SIGNS

Parameters:

material - The material this state is for.

SignMock

protected SignMock(@NotNull
 @NotNull Block block)

Constructs a new SignMock for the provided Block. Only supports materials in Tag.SIGNS

Parameters:

block - The block this state is for.

SignMock

protected SignMock(@NotNull
 @NotNull SignMock state)

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

Parameters:

state - The state to clone.

Method Details

lines

@NotNull
public @NotNull List<net.kyori.adventure.text.Component> lines()

Specified by:

lines in interface Sign

line

@NotNull
public @NotNull net.kyori.adventure.text.Component line(int index)
                                                 throws IndexOutOfBoundsException

Specified by:

line in interface Sign

Throws:

IndexOutOfBoundsException

line

public void line(int index,
 @NotNull
 @NotNull net.kyori.adventure.text.Component line)
          throws IndexOutOfBoundsException

Specified by:

line in interface Sign

Throws:

IndexOutOfBoundsException

getLines

@NotNull
@Deprecated(since="1.16")
public @NotNull String @NotNull [] getLines()

Deprecated.

Specified by:

getLines in interface Sign

getLine

@Deprecated(since="1.16")
@NotNull
public @NotNull String getLine(int index)
                        throws IndexOutOfBoundsException

Deprecated.

Specified by:

getLine in interface Sign

Throws:

IndexOutOfBoundsException

setLine

@Deprecated(since="1.16")
public void setLine(int index,
 String line)
             throws IndexOutOfBoundsException

Deprecated.

Specified by:

setLine in interface Sign

Throws:

IndexOutOfBoundsException

isEditable

public boolean isEditable()

Specified by:

isEditable in interface Sign

setEditable

public void setEditable(boolean editable)

Specified by:

setEditable in interface Sign

isGlowingText

public boolean isGlowingText()

Specified by:

isGlowingText in interface Sign

setGlowingText

public void setGlowingText(boolean glowing)

Specified by:

setGlowingText in interface Sign

getColor

@NotNull
public @NotNull DyeColor getColor()

Specified by:

getColor in interface Colorable

Specified by:

getColor in interface Sign

setColor

public void setColor(@NotNull
 @NotNull DyeColor color)

Specified by:

setColor in interface Colorable

Specified by:

setColor in interface Sign

isWaxed

public boolean isWaxed()

Specified by:

isWaxed in interface Sign

setWaxed

public void setWaxed(boolean waxed)

Specified by:

setWaxed in interface Sign

getSide

@NotNull
public @NotNull SignSide getSide(@NotNull
 @NotNull Side side)

Specified by:

getSide in interface Sign

getTargetSide

@NotNull
public @NotNull SignSide getTargetSide(@NotNull
 @NotNull Player player)

Specified by:

getTargetSide in interface Sign

getAllowedEditor

@Nullable
public @Nullable Player getAllowedEditor()

Specified by:

getAllowedEditor in interface Sign

getAllowedEditorUniqueId

@Nullable
public @Nullable UUID getAllowedEditorUniqueId()

Specified by:

getAllowedEditorUniqueId in interface Sign

setAllowedEditorUniqueId

public void setAllowedEditorUniqueId(@Nullable
 @Nullable UUID uuid)

Specified by:

setAllowedEditorUniqueId in interface Sign

getInteractableSideFor

@NotNull
public @NotNull Side getInteractableSideFor(double x,
 double z)

Specified by:

getInteractableSideFor in interface Sign

getSnapshot

@NotNull
public @NotNull BlockState getSnapshot()

Description copied from class: BlockStateMock

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

Specified by:

getSnapshot in class TileStateMock

Returns:

A snapshot of this BlockStateMock.