Record Class AttributedType

java.lang.Object

java.lang.Record

org.microbean.bean.AttributedType

Record Components:

type - a TypeMirror

attributes - a List of Attributess

All Implemented Interfaces:

Constable, Attributed

public record AttributedType(TypeMirror type, List<Attributes> attributes)
extends Record
implements Attributed, Constable

A pairing of a TypeMirror with a List of Attributess.

Author:

Laird Nelson

Constructor Summary

Constructors

Constructor	Description
AttributedType(TypeMirror type)	Creates a new AttributedType.
AttributedType(TypeMirror type, List<Attributes> attributes)	Creates a new AttributedType.
AttributedType(TypeMirror type, Attributes... attributes)	Creates a new AttributedType.

Method Summary

Modifier and Type	Method	Description
List<Attributes>	attributes()	Returns the value of the attributes record component.
Optional<? extends ConstantDesc>	describeConstable()	Returns an Optional containing a ConstantDesc describing this AttributedType, or an empty Optional if it could not be described.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static final AttributedType	of(TypeMirror type, Attributes... attributes)	Returns an AttributedType comprising the supplied arguments.
final String	toString()	Returns a string representation of this record class.
TypeMirror	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

AttributedType

public AttributedType(TypeMirror type,
 Attributes... attributes)

Creates a new AttributedType.

Parameters:

type - a TypeMirror; must not be null; must be a primitive, array or declared type

attributes - an array of Attributes; may be null

Throws:

NullPointerException - if type is null

IllegalArgumentException - if type is the wrong kind of type

AttributedType

public AttributedType(TypeMirror type,
 List<Attributes> attributes)

Creates a new AttributedType.

Parameters:

type - a TypeMirror; must not be null; must be a primitive, array or declared type

attributes - a List of Attributes; must not be null

Throws:

NullPointerException - if either argument is null

IllegalArgumentException - if type is the wrong kind of type

AttributedType

public AttributedType(TypeMirror type)

Creates a new AttributedType.

Parameters:

type - a TypeMirror; must not be null; must be a primitive, array or declared type

Throws:

NullPointerException - if type is null

IllegalArgumentException - if type is the wrong kind of type

Method Details

describeConstable

public Optional<? extends ConstantDesc> describeConstable()

Returns an Optional containing a ConstantDesc describing this AttributedType, or an empty Optional if it could not be described.

Specified by:

describeConstable in interface Constable

Returns:

an Optional containing a ConstantDesc describing this AttributedType, or an empty Optional if it could not be describe; never null

of

public static final AttributedType of(TypeMirror type,
 Attributes... attributes)

Returns an AttributedType comprising the supplied arguments.

Parameters:

type - a TypeMirror; must not be null; must be a primitive, array or declared type

attributes - an array of Attributes; may be null

Returns:

a non-null AttributedType

Throws:

NullPointerException - if type is null

IllegalArgumentException - if type is the wrong kind of type

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

type

public TypeMirror type()

Returns the value of the type record component.

Returns:

the value of the type record component

attributes

public List<Attributes> attributes()

Returns the value of the attributes record component.

Specified by:

attributes in interface Attributed

Returns:

the value of the attributes record component