Record Class AnnotationRecord

java.lang.Object

java.lang.Record

org.microbean.construct.element.AnnotationRecord

Record Components:

delegate - an AnnotationMirror to which operations will be delegated; must not be null

domain - a Domain; must not be null

All Implemented Interfaces:

AnnotationMirror

public record AnnotationRecord(AnnotationMirror delegate, Domain domain)
extends Record
implements AnnotationMirror

An AnnotationMirror implementation.

Author:

Laird Nelson

See Also:

• AnnotationMirror

Constructor Summary

Constructors

Constructor	Description
AnnotationRecord(AnnotationMirror delegate, Domain domain)	Creates a new AnnotationRecord.

Method Summary

Modifier and Type	Method	Description
AnnotationMirror	delegate()	Returns the value of the delegate record component.
Domain	domain()	Returns the value of the domain record component.
final boolean	equals(Object other)	Indicates whether some other object is "equal to" this one.
final UniversalType	getAnnotationType()
final Map<? extends UniversalElement,? extends AnnotationValueRecord>	getElementValues()
final int	hashCode()	Returns a hash code value for this object.
static final List<? extends AnnotationRecord>	of(Collection<? extends AnnotationMirror> as, Domain domain)	Returns a non-null, immutable List of AnnotationRecords whose elements wrap the supplied List's elements.
static final AnnotationRecord	of(AnnotationMirror a, Domain d)	Returns a non-null AnnotationRecord that is either the supplied AnnotationMirror (if it itself is an AnnotationRecord) or one that wraps it.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotationRecord

public AnnotationRecord(AnnotationMirror delegate,
 Domain domain)

Creates a new AnnotationRecord.

Parameters:

delegate - an AnnotationMirror to which operations will be delegated; must not be null

domain - a Domain; must not be null

Throws:

NullPointerException - if either argument is null

Method Details

equals

public final boolean equals(Object other)

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:

other - the object with which to compare

Returns:

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

getAnnotationType

public final UniversalType getAnnotationType()

Specified by:

getAnnotationType in interface AnnotationMirror

getElementValues

public final Map<? extends UniversalElement,? extends AnnotationValueRecord> getElementValues()

Specified by:

getElementValues in interface AnnotationMirror

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

of

public static final AnnotationRecord of(AnnotationMirror a,
 Domain d)

Returns a non-null AnnotationRecord that is either the supplied AnnotationMirror (if it itself is an AnnotationRecord) or one that wraps it.

Parameters:

a - an AnnotationMirror; must not be null

d - a Domain; must not be null

Returns:

a non-null AnnotationRecord

Throws:

NullPointerException - if either argument is null

See Also:

• AnnotationRecord(AnnotationMirror, Domain)

of

public static final List<? extends AnnotationRecord> of(Collection<? extends AnnotationMirror> as,
 Domain domain)

Returns a non-null, immutable List of AnnotationRecords whose elements wrap the supplied List's elements.

Parameters:

as - a Collection of AnnotationMirrors; must not be null

domain - a Domain; must not be null

Returns:

a non-null, immutable List of AnnotationRecords

Throws:

NullPointerException - if either argument is null

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

delegate

public AnnotationMirror delegate()

Returns the value of the delegate record component.

Returns:

the value of the delegate record component

domain

public Domain domain()

Returns the value of the domain record component.

Returns:

the value of the domain record component