jalse.attributes

Class DefaultAttributeContainer

java.lang.Object

jalse.attributes.DefaultAttributeContainer

All Implemented Interfaces:

AttributeContainer

public class DefaultAttributeContainer
extends java.lang.Object
implements AttributeContainer

An DefaultAttributeContainer is a thread-safe implementation of AttributeContainer.

DefaultAttributeContainer can take a delegate AttributeContainer to supply to AttributeEvent. Attribute updates will trigger these events using AttributeListener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultAttributeContainer.Builder Chaining builder for DefaultAttributeContainer.

Constructor Summary

Constructors

Constructor and Description
DefaultAttributeContainer() Creates a new instance of DefaultAttributeContainer with no delegate container (self).
DefaultAttributeContainer(AttributeContainer delegateContainer) Creates a new instance of DefaultAttributeContainer with a delegate container.

Method Summary

Modifier and Type	Method and Description
<T> boolean	addAttributeListener(NamedAttributeType<T> namedType, AttributeListener<T> listener) Adds an attribute listener for the supplied named attribute type.
boolean	equals(java.lang.Object obj)
<T> void	fireAttributeChanged(NamedAttributeType<T> namedType) Manually fires an attribute change for the supplied attribute type.
<T> T	getAttribute(NamedAttributeType<T> namedType) Gets the attribute matching the supplied type.
int	getAttributeCount() Gets the number of total attributes within the container.
<T> java.util.Set<? extends AttributeListener<T>>	getAttributeListeners(NamedAttributeType<T> namedType) Gets all attribute listeners associated to the supplied named attribute type.
java.util.Set<NamedAttributeType<?>>	getAttributeListenerTypes() Gets all of the named attribute types with listeners bound.
java.util.Set<NamedAttributeType<?>>	getAttributeTypes() Gets all of the named attribute types with attributes.
AttributeContainer	getDelegateContainer() Gets the delegate container.
int	hashCode()
<T> T	removeAttribute(NamedAttributeType<T> namedType) Removes the attribute matching the supplied type.
<T> boolean	removeAttributeListener(NamedAttributeType<T> namedType, AttributeListener<T> listener) Removes an attribute listener assigned to the supplied attribute type.
void	removeAttributeListeners() Removes all listeners.
<T> void	removeAttributeListeners(NamedAttributeType<T> namedType) Removes all listeners for the supplied attribute types.
void	removeAttributes() Removes all attributes within the container (firing removal events).
<T> T	setAttribute(NamedAttributeType<T> namedType, T attr) Adds the supplied attribute to the collection.
java.util.stream.Stream<?>	streamAttributes() Streams all of the attributes within the container.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface jalse.attributes.AttributeContainer

addAll, addAllAttributeListeners, addAllAttributes, addAttributeListener, fireAttributeChanged, getAttribute, getAttributeListenerNames, getAttributeListeners, getAttributeListenerTypes, getAttributeNames, getAttributes, getAttributeTypes, getOptAttribute, getOptAttribute, hasAttribute, hasAttribute, hasAttributeListener, hasAttributeListener, hasAttributeListeners, hasAttributeListeners, hasAttributes, removeAttribute, removeAttributeListener, removeAttributeListeners, removeOptAttribute, removeOptAttribute, setAttribute, setOptAttribute, setOptAttribute

Constructor Detail

DefaultAttributeContainer

public DefaultAttributeContainer()

Creates a new instance of DefaultAttributeContainer with no delegate container (self).

DefaultAttributeContainer

public DefaultAttributeContainer(AttributeContainer delegateContainer)

Creates a new instance of DefaultAttributeContainer with a delegate container.

Parameters:

delegateContainer - Delegate AttributeContainer for events.

Method Detail

addAttributeListener

public <T> boolean addAttributeListener(NamedAttributeType<T> namedType,
                                        AttributeListener<T> listener)

Description copied from interface: AttributeContainer

Adds an attribute listener for the supplied named attribute type.

Specified by:

addAttributeListener in interface AttributeContainer

Parameters:

namedType - Named attribute type.

listener - Listener to add.

Returns:

Whether the listener was not already assigned.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

fireAttributeChanged

public <T> void fireAttributeChanged(NamedAttributeType<T> namedType)

Description copied from interface: AttributeContainer

Manually fires an attribute change for the supplied attribute type. This is used for mutable attributes that can change their internal state.

Specified by:

fireAttributeChanged in interface AttributeContainer

Parameters:

namedType - Named attribute type name.

getAttribute

public <T> T getAttribute(NamedAttributeType<T> namedType)

Description copied from interface: AttributeContainer

Gets the attribute matching the supplied type.

Specified by:

getAttribute in interface AttributeContainer

Parameters:

namedType - Named attribute type to check for.

Returns:

The attribute matching the supplied type or null if none found.

getAttributeCount

public int getAttributeCount()

Description copied from interface: AttributeContainer

Gets the number of total attributes within the container.

Specified by:

getAttributeCount in interface AttributeContainer

Returns:

Attribute count.

getAttributeListeners

public <T> java.util.Set<? extends AttributeListener<T>> getAttributeListeners(NamedAttributeType<T> namedType)

Description copied from interface: AttributeContainer

Gets all attribute listeners associated to the supplied named attribute type.

Specified by:

getAttributeListeners in interface AttributeContainer

Parameters:

namedType - Named attribute type to check for.

Returns:

Set of attribute listeners or an empty set if none were found.

getAttributeListenerTypes

public java.util.Set<NamedAttributeType<?>> getAttributeListenerTypes()

Description copied from interface: AttributeContainer

Gets all of the named attribute types with listeners bound.

Specified by:

getAttributeListenerTypes in interface AttributeContainer

Returns:

All named types with listeners.

getAttributeTypes

public java.util.Set<NamedAttributeType<?>> getAttributeTypes()

Description copied from interface: AttributeContainer

Gets all of the named attribute types with attributes.

Specified by:

getAttributeTypes in interface AttributeContainer

Returns:

Named attribute types for the attributes.

getDelegateContainer

public AttributeContainer getDelegateContainer()

Gets the delegate container.

Returns:

Delegate event container.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

removeAttribute

public <T> T removeAttribute(NamedAttributeType<T> namedType)

Description copied from interface: AttributeContainer

Removes the attribute matching the supplied type.

Specified by:

removeAttribute in interface AttributeContainer

Parameters:

namedType - Named attribute type to remove.

Returns:

The removed attribute or null if none was removed.

removeAttributeListener

public <T> boolean removeAttributeListener(NamedAttributeType<T> namedType,
                                           AttributeListener<T> listener)

Description copied from interface: AttributeContainer

Removes an attribute listener assigned to the supplied attribute type.

Specified by:

removeAttributeListener in interface AttributeContainer

Parameters:

namedType - Named attribute type.

listener - Listener to remove.

Returns:

Whether the listener was assigned.

removeAttributeListeners

public void removeAttributeListeners()

Description copied from interface: AttributeContainer

Removes all listeners.

Specified by:

removeAttributeListeners in interface AttributeContainer

removeAttributeListeners

public <T> void removeAttributeListeners(NamedAttributeType<T> namedType)

Description copied from interface: AttributeContainer

Removes all listeners for the supplied attribute types.

Specified by:

removeAttributeListeners in interface AttributeContainer

Parameters:

namedType - Named attribute type.

removeAttributes

public void removeAttributes()

Description copied from interface: AttributeContainer

Removes all attributes within the container (firing removal events).

Specified by:

removeAttributes in interface AttributeContainer

setAttribute

public <T> T setAttribute(NamedAttributeType<T> namedType,
                          T attr)

Description copied from interface: AttributeContainer

Adds the supplied attribute to the collection.

Specified by:

setAttribute in interface AttributeContainer

Parameters:

namedType - Named attribute type.

attr - Attribute to add.

Returns:

The replaced attribute or null if none was replaced.

streamAttributes

public java.util.stream.Stream<?> streamAttributes()

Description copied from interface: AttributeContainer

Streams all of the attributes within the container.

Specified by:

streamAttributes in interface AttributeContainer

Returns:

Stream of all attributes.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object