Package org.bukkit.material

Class Comparator

java.lang.Object

org.bukkit.material.MaterialData

org.bukkit.material.Comparator

All Implemented Interfaces:

Cloneable, Directional, Redstone

public class Comparator
extends MaterialData
implements Directional, Redstone

Represents a comparator in the on or off state, in normal or subtraction mode and facing in a specific direction.

See Also:

Material.LEGACY_REDSTONE_COMPARATOR_OFF, Material.LEGACY_REDSTONE_COMPARATOR_ON

Field Summary

Fields

Modifier and Type	Field	Description
protected static BlockFace	DEFAULT_DIRECTION
protected static boolean	DEFAULT_STATE
protected static boolean	DEFAULT_SUBTRACTION_MODE

Constructor Summary

Constructors

Constructor	Description
Comparator()	Constructs a comparator switched off, with the default mode (normal) and facing the default direction (north).
Comparator(BlockFace facingDirection)	Constructs a comparator switched off, with the default mode (normal) and facing the specified direction.
Comparator(BlockFace facingDirection, boolean isSubtraction)	Constructs a comparator switched off, with the specified mode and facing the specified direction.
Comparator(BlockFace facingDirection, boolean isSubtraction, boolean state)	Constructs a comparator switched on or off, with the specified mode and facing the specified direction.
Comparator(Material type)
Comparator(Material type, byte data)	Deprecated. Magic value

Method Summary

Modifier and Type	Method	Description
Comparator	clone()
BlockFace	getFacing()	Gets the direction this comparator is facing
boolean	isBeingPowered()	Checks if the comparator is being powered
boolean	isPowered()	Checks if the comparator is powered
boolean	isSubtractionMode()	Checks whether the comparator is in subtraction mode
void	setFacingDirection(BlockFace face)	Sets the direction this comparator is facing
void	setSubtractionMode(boolean isSubtraction)	Sets whether the comparator is in subtraction mode.
String	toString()

Methods inherited from class org.bukkit.material.MaterialData

equals, getData, getItemType, hashCode, setData, toItemStack, toItemStack

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DIRECTION

protected static final BlockFace DEFAULT_DIRECTION

DEFAULT_SUBTRACTION_MODE

protected static final boolean DEFAULT_SUBTRACTION_MODE

See Also:

Constant Field Values

DEFAULT_STATE

protected static final boolean DEFAULT_STATE

See Also:

Constant Field Values

Constructor Detail

Comparator

public Comparator()

Constructs a comparator switched off, with the default mode (normal) and facing the default direction (north).

Comparator

public Comparator(BlockFace facingDirection)

Constructs a comparator switched off, with the default mode (normal) and facing the specified direction.

Parameters:

facingDirection - the direction the comparator is facing

See Also:

BlockFace

Comparator

public Comparator(BlockFace facingDirection,
                  boolean isSubtraction)

Constructs a comparator switched off, with the specified mode and facing the specified direction.

Parameters:

facingDirection - the direction the comparator is facing

isSubtraction - True if the comparator is in subtraction mode, false for normal comparator operation

See Also:

BlockFace

Comparator

public Comparator(BlockFace facingDirection,
                  boolean isSubtraction,
                  boolean state)

Constructs a comparator switched on or off, with the specified mode and facing the specified direction.

Parameters:

facingDirection - the direction the comparator is facing

isSubtraction - True if the comparator is in subtraction mode, false for normal comparator operation

state - True if the comparator is in the on state

See Also:

BlockFace

Comparator

public Comparator(Material type)

Comparator

@Deprecated
public Comparator(Material type,
                  byte data)

Deprecated.

Magic value

Parameters:

type - the type

data - the raw data value

Method Detail

setSubtractionMode

public void setSubtractionMode(boolean isSubtraction)

Sets whether the comparator is in subtraction mode.

Parameters:

isSubtraction - True if the comparator is in subtraction mode, false for normal comparator operation

isSubtractionMode

public boolean isSubtractionMode()

Checks whether the comparator is in subtraction mode

Returns:

True if the comparator is in subtraction mode, false if normal comparator operation

setFacingDirection

public void setFacingDirection(BlockFace face)

Sets the direction this comparator is facing

Specified by:

setFacingDirection in interface Directional

Parameters:

face - The direction to set this comparator to

See Also:

BlockFace

getFacing

public BlockFace getFacing()

Gets the direction this comparator is facing

Specified by:

getFacing in interface Directional

Returns:

The direction this comparator is facing

See Also:

BlockFace

toString

public String toString()

Overrides:

toString in class MaterialData

clone

public Comparator clone()

Overrides:

clone in class MaterialData

isPowered

public boolean isPowered()

Checks if the comparator is powered

Specified by:

isPowered in interface Redstone

Returns:

true if the comparator is powered

isBeingPowered

public boolean isBeingPowered()

Checks if the comparator is being powered

Returns:

true if the comparator is being powered