jalse.attributes

Class AttributeEvent<T>

java.lang.Object

jalse.misc.AbstractIdentifiable

jalse.attributes.AttributeEvent<T>

Type Parameters:

T - Attribute type.

All Implemented Interfaces:

Identifiable

public class AttributeEvent<T>
extends AbstractIdentifiable

Attribute change event for AttributeListener. This is a unique event that contains the relevant AttributeType value and it's parent AttributeContainer (even if the Attribute has been removed). When an attribute is replaced the previous attribute is also contained within the event.

See Also:

AttributeContainer

Field Summary

Fields inherited from class jalse.misc.AbstractIdentifiable

id

Constructor Summary

Constructors

Constructor and Description
AttributeEvent(AttributeContainer container, NamedAttributeType<T> namedType, T value) Creates a new AttributeEvent with a random ID (with no previous Attribute).
AttributeEvent(AttributeContainer container, NamedAttributeType<T> namedType, T value, T replacedValue) Creates a new AttributeEvent with a random ID.

Method Summary

Modifier and Type	Method and Description
AttributeContainer	getContainer() Gets the Attribute's parent container.
java.lang.String	getName() Gets the attribute name.
NamedAttributeType<T>	getNamedType() Gets the named attribute type.
java.util.Optional<T>	getOptReplacedValue() Get the Attribute that was replaced by this Attribute.
T	getReplacedValue() Get the Attribute that was replaced by this Attribute.
AttributeType<T>	getType() Gets the attribute type for the attribute.
T	getValue() Gets the Attribute the event is for.
boolean	isReplacement() Checks whether the previous Attribute was replaced by this Attribute.

Methods inherited from class jalse.misc.AbstractIdentifiable

equals, getID, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface jalse.misc.Identifiable

equals, getID, hashCode, is, not, toString

Constructor Detail

AttributeEvent

public AttributeEvent(AttributeContainer container,
                      NamedAttributeType<T> namedType,
                      T value)

Creates a new AttributeEvent with a random ID (with no previous Attribute).

Parameters:

container - Parent container for the Attribute.

namedType - Named attribute type.

value - Attribute the event is for.

AttributeEvent

public AttributeEvent(AttributeContainer container,
                      NamedAttributeType<T> namedType,
                      T value,
                      T replacedValue)

Creates a new AttributeEvent with a random ID.

Parameters:

container - Parent container for the Attribute.

namedType - Named attribute type.

value - Attribute the event is for.

replacedValue - The previous attribute that has been replaced by this Attribute (can be null).

Method Detail

getContainer

public AttributeContainer getContainer()

Gets the Attribute's parent container.

Returns:

Parent container.

getName

public java.lang.String getName()

Gets the attribute name.

Returns:

Attribute name.

getNamedType

public NamedAttributeType<T> getNamedType()

Gets the named attribute type.

Returns:

Named attribute type.

getOptReplacedValue

public java.util.Optional<T> getOptReplacedValue()

Get the Attribute that was replaced by this Attribute.

Returns:

Optional containing replaced attribute or empty optional if nothing was replaced.

getReplacedValue

public T getReplacedValue()

Get the Attribute that was replaced by this Attribute.

Returns:

Replaced Attribute or null if nothing was replaced.

getType

public AttributeType<T> getType()

Gets the attribute type for the attribute.

Returns:

Attribute type.

getValue

public T getValue()

Gets the Attribute the event is for.

Returns:

The relevant Attribute.

isReplacement

public boolean isReplacement()

Checks whether the previous Attribute was replaced by this Attribute.

Returns:

Whether the previous Attribute was replaced.