Package org.gradle.api.attributes
Class Attribute<T>
- java.lang.Object
-
- org.gradle.api.attributes.Attribute<T>
-
- Type Parameters:
T
- the type of the named attribute
- All Implemented Interfaces:
Named
@Incubating public class Attribute<T> extends Object implements Named
An attribute is a named entity with a type. It is used in conjunction with aAttributeContainer
to provide a type safe container for attributes. This class isn't intended to store the value of an attribute, but only represent the identity of the attribute. It means that an attribute must be immutable and can potentially be pooled. Attributes can be created using thefactory method
.- Since:
- 3.3
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.gradle.api.Named
Named.Namer
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
String
getName()
Returns the name of the attribute.Class<T>
getType()
Returns the type of this attribute.int
hashCode()
static <T> Attribute<T>
of(Class<T> type)
Creates a new attribute of the given type, inferring the name of the attribute from the simple type name.static <T> Attribute<T>
of(String name, Class<T> type)
Creates a new attribute of the given name with the given type.String
toString()
-
-
-
Method Detail
-
of
public static <T> Attribute<T> of(String name, Class<T> type)
Creates a new attribute of the given name with the given type. There's no guarantee that subsequent calls to this method with the same attributes would either return the same instance or different instances ofAttribute
, so consumers are required to compare the attributes with theequals(Object)
method.- Type Parameters:
T
- the type of the attribute- Parameters:
name
- the name of the attributetype
- the class of the attribute- Returns:
- an attribute with the given name and type
-
of
public static <T> Attribute<T> of(Class<T> type)
Creates a new attribute of the given type, inferring the name of the attribute from the simple type name. This method is useful when there's supposely only one attribute of a specific type in a container, so there's no need to distinguish by name (but the returned type doesn't enforce it_. There's no guarantee that subsequent calls to this method with the same attributes would either return the same instance or different instances ofAttribute
, so consumers are required to compare the attributes with theequals(Object)
method.- Type Parameters:
T
- the type of the attribute- Parameters:
type
- the class of the attribute- Returns:
- an attribute with the given name and type
-
getName
public String getName()
Returns the name of the attribute.
-
getType
public Class<T> getType()
Returns the type of this attribute.- Returns:
- the type of this attribute.
-
-