Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
jalse.attributes.AttributeContainer Maven / Gradle / Ivy
package jalse.attributes;
import jalse.listeners.AttributeListener;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
* This is an attribute collection. This attribute collections works more like a set but using the
* {@link AttributeType} to determine uniqueness (only one of each attribute type can be added).
* {@link AttributeListener} can be added for an attribute type, trigger code will fire upon add,
* update or removal of attributes of that type. Each collection manipulation method returns
* {@code Optional} of the attribute (may be empty if none matching are found).
*
* @author Elliot Ford
*
* @see Optional
* @see DefaultAttributeContainer
* @see Attributes#emptyAttributeContainer()
* @see Attributes#unmodifiableAttributeContainer(AttributeContainer)
*
*/
public interface AttributeContainer {
/**
* Adds all attributes and listeners from the source container.
*
* @param sourceContainer
* Source container to copy from.
*/
default void addAll(final AttributeContainer sourceContainer) {
addAllAttributes(sourceContainer);
addAllAttributeListeners(sourceContainer);
}
/**
* Adds all attribute listeners from the source container.
*
* @param sourceContainer
* Source attribute container.
*/
@SuppressWarnings("unchecked")
default void addAllAttributeListeners(final AttributeContainer sourceContainer) {
for (final String name : sourceContainer.getAttributeListenerNames()) {
for (final AttributeType type : sourceContainer.getAttributeListenerTypes(name)) {
for (final AttributeListener listener : sourceContainer.getAttributeListeners(name, type)) {
addAttributeListener(name, (AttributeType) type, (AttributeListener) listener);
}
}
}
}
/**
* Adds all attributes from the source container.
*
* @param sourceContainer
* Source attribute container.
*/
@SuppressWarnings("unchecked")
default void addAllAttributes(final AttributeContainer sourceContainer) {
for (final String name : sourceContainer.getAttributeNames()) {
for (final AttributeType type : sourceContainer.getAttributeTypes(name)) {
final Object attr = sourceContainer.getAttribute(name, type);
if (attr != null) {
setAttribute(name, (AttributeType) type, attr);
}
}
}
}
/**
* Adds an attribute listener for the supplied named attribute type.
*
* @param namedType
* Named attribute type.
* @param listener
* Listener to add.
* @return Whether the listener was not already assigned.
*/
default boolean addAttributeListener(final NamedAttributeType namedType, final AttributeListener listener) {
return addAttributeListener(namedType.getName(), namedType.getType(), listener);
}
/**
* Adds an attribute listener for the supplied attribute type.
*
* @param name
* Attribute type name.
*
* @param type
* Attribute type.
* @param listener
* Listener to add.
* @return Whether the listener was not already assigned.
*/
boolean addAttributeListener(String name, AttributeType type, AttributeListener listener);
/**
* Manually fires an attribute change for the supplied attribute type. This is used for mutable
* attributes that can change their internal state.
*
* @param namedType
* Named attribute type name.
*/
default void fireAttributeChanged(final NamedAttributeType namedType) {
fireAttributeChanged(namedType.getName(), namedType.getType());
}
/**
* Manually fires an attribute change for the supplied attribute type. This is used for mutable
* attributes that can change their internal state.
*
* @param name
* Attribute type name.
*
* @param type
* Attribute type to fire for.
*/
void fireAttributeChanged(String name, AttributeType type);
/**
* Gets the attribute matching the supplied type.
*
* @param namedType
* Named attribute type to check for.
* @return The attribute matching the supplied type or null if none found.
*/
default T getAttribute(final NamedAttributeType namedType) {
return getAttribute(namedType.getName(), namedType.getType());
}
/**
* Gets the attribute matching the supplied type.
*
* @param name
* Attribute type name.
*
* @param type
* Attribute type to check for.
* @return The attribute matching the supplied type or null if none found.
*/
T getAttribute(String name, final AttributeType type);
/**
* Gets the number of total attributes within the container.
*
* @return Attribute count.
*/
int getAttributeCount();
/**
* Gets the attribute type names with listeners associated.
*
* @return Associated attribute type names to listeners.
*/
Set getAttributeListenerNames();
/**
* Gets all attribute listeners associated to the supplied named attribute type.
*
* @param namedType
* Named attribute type to check for.
* @return Set of attribute listeners or an empty set if none were found.
*/
default Set> getAttributeListeners(final NamedAttributeType namedType) {
return getAttributeListeners(namedType.getName(), namedType.getType());
}
/**
* Gets all attribute listeners associated to the supplied named attribute type.
*
* @param name
* Attribute type name.
*
* @param type
* Attribute type to check for.
* @return Set of attribute listeners or an empty set if none were found.
*/
Set> getAttributeListeners(String name, AttributeType type);
/**
* Gets all the attribute listener types.
*
* @param name
* Attribute type name.
*
* @return Set of the types attribute listeners are for or an empty set if none were found.
*/
Set> getAttributeListenerTypes(String name);
/**
* Gets all the attribute type names assigned to attributes.
*
* @return Attribute type names with values.
*/
Set getAttributeNames();
/**
* Gets all of the attributes within the container.
*
* @return All of the attributes or an empty set if none were found.
*
* @see #streamAttributes()
*/
default Set getAttributes() {
return streamAttributes().collect(Collectors.toSet());
}
/**
* Gets all of the attribute types within the container.
*
* @param name
* Attribute type name.
*
* @return All of the types of the attributes or an empty set if none were found.
*/
Set> getAttributeTypes(String name);
/**
* This is a convenience method for getting an attribute (optional).
*
*
* @param namedType
* Named attribute type to check for.
* @return Optional containing the attribute or else empty optional if none found.
*/
default Optional getOptAttribute(final NamedAttributeType namedType) {
return getOptAttribute(namedType.getName(), namedType.getType());
}
/**
* This is a convenience method for getting an attribute (optional).
*
* @param name
* Attribute type name.
* @param type
* Attribute type to check for.
* @return Optional containing the attribute or else empty optional if none found.
*/
default Optional getOptAttribute(final String name, final AttributeType type) {
return Optional.ofNullable(getAttribute(name, type));
}
/**
* Checks whether the container has a value associated to the supplied attribute type.
*
* @param namedType
* Named attribute type.
* @return Whether the attribute was found.
*/
default boolean hasAttribute(final NamedAttributeType namedType) {
return hasAttribute(namedType.getName(), namedType.getType());
}
/**
* Checks whether the container has a value associated to the supplied attribute type.
*
* @param name
* Attribute type name.
* @param type
* Attribute type.
* @return Whether the attribute was found.
*/
default boolean hasAttribute(final String name, final AttributeType type) {
return getAttribute(name, type) != null;
}
/**
* Checks whether the container has any attributes.
*
* @return Is the container is not empty.
*/
default boolean hasAttributes() {
return getAttributeCount() > 0;
}
/**
* Removes the attribute matching the supplied type.
*
* @param namedType
* Named attribute type to remove.
*
* @return The removed attribute or null if none was removed.
*/
default T removeAttribute(final NamedAttributeType namedType) {
return removeAttribute(namedType.getName(), namedType.getType());
}
/**
* Removes the attribute matching the supplied type.
*
* @param name
* Attribute type name.
*
* @param type
* Attribute type to remove.
* @return The removed attribute or null if none was removed.
*/
T removeAttribute(String name, final AttributeType type);
/**
* Removes an attribute listener assigned to the supplied attribute type.
*
* @param namedType
* Named attribute type.
* @param listener
* Listener to remove.
* @return Whether the listener was assigned.
*/
default boolean removeAttributeListener(final NamedAttributeType namedType,
final AttributeListener listener) {
return removeAttributeListener(namedType.getName(), namedType.getType(), listener);
}
/**
* Removes an attribute listener assigned to the supplied attribute type.
*
* @param name
* Attribute type name.
* @param type
* Attribute type.
* @param listener
* Listener to remove.
* @return Whether the listener was assigned.
*/
boolean removeAttributeListener(String name, AttributeType type, AttributeListener listener);
/**
* Removes all listeners.
*/
void removeAttributeListeners();
/**
* Removes all listeners for the supplied attribute types.
*
* @param namedType
* Named attribute type.
*/
default void removeAttributeListeners(final NamedAttributeType namedType) {
removeAttributeListeners(namedType.getName(), namedType.getType());
}
/**
* Removes all listeners for the supplied attribute types.
*
* @param name
* Attribute type name.
* @param type
* Attribute type.
*/
void removeAttributeListeners(String name, AttributeType type);
/**
* Removes all attributes within the container (firing removal events).
*/
void removeAttributes();
/**
* This is a convenience method for removing an attribute (no optional).
*
* @param namedType
* Named attribute type to remove.
* @return Optional containing the removed attribute or else empty optional if none found
*/
default Optional removeOptAttribute(final NamedAttributeType namedType) {
return removeOptAttribute(namedType.getName(), namedType.getType());
}
/**
* This is a convenience method for removing an attribute (no optional).
*
* @param name
* Attribute type name.
*
* @param type
* Attribute type to remove.
* @return Optional containing the removed attribute or else empty optional if none found
*/
default Optional removeOptAttribute(final String name, final AttributeType type) {
return Optional.ofNullable(removeAttribute(name, type));
}
/**
* Adds the supplied attribute to the collection.
*
* @param namedType
* Named attribute type.
* @param attr
* Attribute to add.
* @return The replaced attribute or null if none was replaced.
*/
default T setAttribute(final NamedAttributeType namedType, final T attr) {
return setAttribute(namedType.getName(), namedType.getType(), attr);
}
/**
* Adds the supplied attribute to the collection.
*
* @param name
* Attribute type name.
*
* @param type
* Attribute type.
* @param attr
* Attribute to add.
* @return The replaced attribute or null if none was replaced.
*/
T setAttribute(String name, final AttributeType type, T attr);
/**
* This is a convenience method for adding an attribute (optional).
*
* @param namedType
* Named attribute type.
* @param attr
* Attribute to add.
* @return Optional containing the replaced attribute if set or else empty optional if none
* found
*
*/
default Optional setOptAttribute(final NamedAttributeType namedType, final T attr) {
return setOptAttribute(namedType.getName(), namedType.getType(), attr);
}
/**
* This is a convenience method for adding an attribute (optional).
*
* @param name
* Attribute type name.
*
* @param type
* Attribute type.
* @param attr
* Attribute to add.
* @return Optional containing the replaced attribute if set or else empty optional if none
* found
*/
default Optional setOptAttribute(final String name, final AttributeType type, final T attr) {
return Optional.ofNullable(setAttribute(name, type, attr));
}
/**
* Streams all of the attributes within the container.
*
* @return Stream of all attributes.
*/
Stream streamAttributes();
}
