Package org.bukkit.material

Class Tree

java.lang.Object

org.bukkit.material.MaterialData

org.bukkit.material.Wood

org.bukkit.material.Tree

All Implemented Interfaces:

java.lang.Cloneable

public class Tree
extends Wood

Represents the different types of Tree block that face a direction.

See Also:

Material.LOG, Material.LOG_2

Field Summary

Fields

Modifier and Type	Field	Description
protected static BlockFace	DEFAULT_DIRECTION
protected static Material	DEFAULT_TYPE

Fields inherited from class org.bukkit.material.Wood

DEFAULT_SPECIES

Constructor Summary

Constructors

Constructor	Description
Tree()	Constructs a tree block.
Tree(int type)	Deprecated. Magic value
Tree(int type, byte data)	Deprecated. Magic value
Tree(Material type)	Constructs a tree block of the given type.
Tree(Material type, byte data)	Deprecated. Magic value
Tree(Material type, TreeSpecies species)	Constructs a tree block of the given type and tree species.
Tree(Material type, TreeSpecies species, BlockFace dir)	Constructs a tree block of the given type and tree species, and facing the given direction.
Tree(TreeSpecies species)	Constructs a tree block of the given tree species.
Tree(TreeSpecies species, BlockFace dir)	Constructs a tree block of the given tree species, and facing the given direction.

Method Summary

Modifier and Type	Method	Description
Tree	clone()
BlockFace	getDirection()	Get direction of the log
void	setDirection(BlockFace dir)	Set direction of the log
java.lang.String	toString()

Methods inherited from class org.bukkit.material.MaterialData

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

Methods inherited from class java.lang.Object

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

Methods inherited from class org.bukkit.material.Wood

getSpecies, setSpecies

Field Detail

DEFAULT_TYPE

protected static final Material DEFAULT_TYPE

DEFAULT_DIRECTION

protected static final BlockFace DEFAULT_DIRECTION

Constructor Detail

Tree

public Tree()

Constructs a tree block.

Tree

public Tree(TreeSpecies species)

Constructs a tree block of the given tree species.

Parameters:

species - the species of the tree block

Tree

public Tree(TreeSpecies species,
            BlockFace dir)

Constructs a tree block of the given tree species, and facing the given direction.

Parameters:

species - the species of the tree block

dir - the direction the tree block is facing

Tree

@Deprecated
public Tree(int type)

Deprecated.

Magic value

Parameters:

type - the raw type id

Tree

public Tree(Material type)

Constructs a tree block of the given type.

Parameters:

type - the type of tree block

Tree

public Tree(Material type,
            TreeSpecies species)

Constructs a tree block of the given type and tree species.

Parameters:

type - the type of tree block

species - the species of the tree block

Tree

public Tree(Material type,
            TreeSpecies species,
            BlockFace dir)

Constructs a tree block of the given type and tree species, and facing the given direction.

Parameters:

type - the type of tree block

species - the species of the tree block

dir - the direction the tree block is facing

Tree

@Deprecated
public Tree(int type,
            byte data)

Deprecated.

Magic value

Parameters:

type - the raw type id

data - the raw data value

Tree

@Deprecated
public Tree(Material type,
            byte data)

Deprecated.

Magic value

Parameters:

type - the type

data - the raw data value

Method Detail

getDirection

public BlockFace getDirection()

Get direction of the log

Returns:

one of:

• BlockFace.TOP for upright (default)
• BlockFace.NORTH (east-west)
• BlockFace.WEST (north-south)
• BlockFace.SELF (directionless)

setDirection

public void setDirection(BlockFace dir)

Set direction of the log

Parameters:

dir - - direction of end of log (BlockFace.SELF for no direction)

toString

public java.lang.String toString()

Overrides:

toString in class Wood

clone

public Tree clone()

Overrides:

clone in class Wood