de.pheasn.blockown

Class OwnedEntity

java.lang.Object

de.pheasn.blockown.OwnedEntity

All Implemented Interfaces:

Ownable, Serializable

public class OwnedEntity
extends Object
implements Ownable

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
org.bukkit.entity.Entity	getEntity() Gets the entity corresponding to this OwnedEntity.
Material	getMaterial() Returns the Material of the Ownable.
UUID	getUniqueId()
org.bukkit.World	getWorld() Returns the World the Ownable is in.
String	getWorldName() Returns the name of the world the Ownable is in.
int	hashCode()
boolean	isLiving() Checks if the entity is living.
static OwnedEntity	newInstance(org.bukkit.entity.Entity entity) Creates a new OwnedEntity instance holding a WeakReference to the given block.
static OwnedEntity	newInstance(UUID id, String worldName) Creates a new OwnedEntity instance.
static OwnedEntity	newInstance(UUID id, String worldName, Material material) Creates a new OwnedEntity instance.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static OwnedEntity newInstance(org.bukkit.entity.Entity entity)

Creates a new OwnedEntity instance holding a WeakReference to the given block.

Parameters:

entity - the entity

Returns:

the new OwnedEntity instance

newInstance

public static OwnedEntity newInstance(UUID id,
                      String worldName,
                      Material material)

Creates a new OwnedEntity instance. The corresponding Entity will be looked up when getEntity() is called.

Parameters:

id - the UUID

worldName - the worldName

material - the material

Returns:

the new OwnedEntity instance

newInstance

public static OwnedEntity newInstance(UUID id,
                      String worldName)

Creates a new OwnedEntity instance. The corresponding Entity and its Material will be looked up when needed.

Parameters:

id - the UUID

worldName - the worldName

Returns:

the new OwnedEntity instance

getEntity

public org.bukkit.entity.Entity getEntity()
                                   throws InvalidWorldException,
                                          InvalidUUIDException

Gets the entity corresponding to this OwnedEntity. Keep in mind that this can be a very expensive operation.

Returns:

the entity

Throws:

InvalidWorldException - if the world name is invalid

InvalidUUIDException - if the entity can't be found in the specified world

getUniqueId

public UUID getUniqueId()

getWorld

public org.bukkit.World getWorld()
                          throws InvalidWorldException

Description copied from interface: Ownable

Returns the World the Ownable is in. Never null.

Specified by:

getWorld in interface Ownable

Returns:

the World

Throws:

InvalidWorldException - if the world referenced by the world name doesn't exist

getWorldName

public String getWorldName()

Description copied from interface: Ownable

Returns the name of the world the Ownable is in. Never null.

Specified by:

getWorldName in interface Ownable

Returns:

the world name

getMaterial

public Material getMaterial()
                     throws InvalidWorldException

Description copied from interface: Ownable

Returns the Material of the Ownable. Never null.

Specified by:

getMaterial in interface Ownable

Returns:

the Material

Throws:

InvalidWorldException - if the world referenced by the world name doesn't exist

isLiving

public boolean isLiving()
                 throws InvalidWorldException,
                        InvalidUUIDException

Checks if the entity is living. This can be a very expensive operation if it needs to look up the entity.

Returns:

true, if it is a LivingEntity

Throws:

InvalidWorldException - if the world name is invalid

InvalidUUIDException - if the entity can't be found in the specified world

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object