com.lhkbob.entreri.property

Class Attributes

java.lang.Object

com.lhkbob.entreri.property.Attributes

public class Attributes
extends Object

Attributes represents the collection of attributes that have been provided on a property declaration within a ComponentData definition. To use attributes, PropertyFactory implementations should have a constructor that takes a single Attributes instance.

Author:

Michael Ludwig

See Also:

PropertyFactory

Constructor Summary

Constructors

Constructor and Description
Attributes(Annotation... attrs) Construct a new set of attributes from the given annotations.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Annotation> T	getAttribute(Class<T> cls) Get the attribute annotation of type T.
Collection<Annotation>	getAttributes()
boolean	hasAttribute(Class<? extends Annotation> cls) Get whether or not this set of attributes has an attribute of the given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Attributes

public Attributes(Annotation... attrs)

Construct a new set of attributes from the given annotations. Only annotations that have the Attribute annotation are kept.

Parameters:

attrs - The annotations from the method, or field, etc.

Throws:

NullPointerException - if attrs is null or contains null elements

Method Detail

getAttribute

public <T extends Annotation> T getAttribute(Class<T> cls)

Get the attribute annotation of type T. If there is no attribute for the given type, then null is returned.

Parameters:

cls - The attribute annotation class type

Returns:

The associated attribute instance

hasAttribute

public boolean hasAttribute(Class<? extends Annotation> cls)

Get whether or not this set of attributes has an attribute of the given type. If an attribute does not have any variables, this is sufficient instead of getting the actual instance.

Parameters:

cls - The annotation class type

Returns:

True if the associated attribute exists

getAttributes

public Collection<Annotation> getAttributes()

Returns:

All annotation attributes in this set