org.pepsoft.worldpainter.objects

Class NamedObjectWithAttributes

java.lang.Object

org.pepsoft.worldpainter.objects.AbstractObject

org.pepsoft.worldpainter.objects.NamedObjectWithAttributes

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, WPObject

Direct Known Subclasses:

GenericObject

public abstract class NamedObjectWithAttributes
extends AbstractObject

Created by Pepijn on 9-3-2017.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.pepsoft.worldpainter.objects.WPObject

WPObject.BlockVisitor

Field Summary

Fields inherited from interface org.pepsoft.worldpainter.objects.WPObject

ATTRIBUTE_COLLISION_MODE, ATTRIBUTE_CONNECT_BLOCKS, ATTRIBUTE_EXTEND_FOUNDATION, ATTRIBUTE_FILE, ATTRIBUTE_FREQUENCY, ATTRIBUTE_HEIGHT_MODE, ATTRIBUTE_LEAF_DECAY_MODE, ATTRIBUTE_MANAGE_WATERLOGGED, ATTRIBUTE_NEEDS_FOUNDATION, ATTRIBUTE_OFFSET, ATTRIBUTE_RANDOM_MIRRORING_ONLY, ATTRIBUTE_RANDOM_ROTATION, ATTRIBUTE_RANDOM_ROTATION_ONLY, ATTRIBUTE_REPLACE_WITH_AIR, ATTRIBUTE_REPLACE_WITH_AIR_MATERIAL, ATTRIBUTE_SPAWN_IN_LAVA, ATTRIBUTE_SPAWN_IN_WATER, ATTRIBUTE_SPAWN_ON_LAND, ATTRIBUTE_SPAWN_ON_LAVA, ATTRIBUTE_SPAWN_ON_WATER, ATTRIBUTE_SPAWN_ON_WATER_NO_COLLIDE, ATTRIBUTE_UNDERGROUND_MODE, ATTRIBUTE_VERTICAL_OFFSET, ATTRIBUTE_Y_VARIATION, COLLISION_MODE_ALL, COLLISION_MODE_NONE, COLLISION_MODE_SOLID, HEIGHT_MODE_FIXED, HEIGHT_MODE_TERRAIN, LEAF_DECAY_NO_CHANGE, LEAF_DECAY_OFF, LEAF_DECAY_ON

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NamedObjectWithAttributes()
protected	NamedObjectWithAttributes(java.lang.String name)
protected	NamedObjectWithAttributes(java.lang.String name, java.util.Map<java.lang.String,java.io.Serializable> attributes)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.io.Serializable>	getAttributes() Get a live view of the object metadata.
java.lang.String	getName() Get the name of the object.
<T extends java.io.Serializable> void	setAttribute(org.pepsoft.util.AttributeKey<T> key, T value) Convenience method for setting the value of an attribute stored in the external metadata, if any.
void	setAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes) Store external metadata about the object.
void	setName(java.lang.String name) Set the name of the object.

Methods inherited from class org.pepsoft.worldpainter.objects.AbstractObject

clone, getOffset, prepareForExport

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pepsoft.worldpainter.objects.WPObject

dump, getAllMaterials, getAttribute, getDimensions, getEntities, getMask, getMaterial, getTileEntities, guessConnectBlocks, guessManageWaterlogged, guestimateOffset, hasAttribute, visitBlocks

Constructor Detail

NamedObjectWithAttributes

protected NamedObjectWithAttributes()

NamedObjectWithAttributes

protected NamedObjectWithAttributes(java.lang.String name)

NamedObjectWithAttributes

protected NamedObjectWithAttributes(java.lang.String name,
                                    java.util.Map<java.lang.String,java.io.Serializable> attributes)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: WPObject

Get the name of the object.

Returns:

The name of the object.

setName

public void setName(java.lang.String name)

Description copied from interface: WPObject

Set the name of the object.

Parameters:

name - The new name of the object.

getAttributes

public java.util.Map<java.lang.String,java.io.Serializable> getAttributes()

Description copied from interface: WPObject

Get a live view of the object metadata.

Returns:

A live view of the object metadata. May be null.

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes)

Description copied from interface: WPObject

Store external metadata about the object.

Parameters:

attributes - The external metadata to store.

setAttribute

public <T extends java.io.Serializable> void setAttribute(org.pepsoft.util.AttributeKey<T> key,
                                                          T value)

Description copied from interface: WPObject

Convenience method for setting the value of an attribute stored in the external metadata, if any. Setting the value to null will delete the attribute from the store. If the store becomes empty it is deleted entirely.

Type Parameters:

T - The type of the attribute.

Parameters:

key - The key of the attribute to set or delete.

value - The value of the attribute to set, or null to delete it.