Module org.microbean.qualifier

Package org.microbean.qualifier

Record Class Qualified.Record<V,T>

java.lang.Object

java.lang.Record

org.microbean.qualifier.Qualified.Record<V,T>

Type Parameters:

V - the type borne by the values of the Qualifiers in this Qualified.Record

T - the type of the object that is qualified; note that if it does not extend Constable then a Qualified.Record bearing it will return an empty Optional from its describeConstable() method

Record Components:

qualifiers - the Qualifiers; may be null in which case the return value of Qualifiers.of() will be used instead

qualified - the object being qualified; may be null

All Implemented Interfaces:

Constable, Qualified<V,T>

Enclosing interface:

Qualified<V,T>

public static record Qualified.Record<V,T>(Qualifiers<V> qualifiers, T qualified)
extends Record
implements Qualified<V,T>, Constable

A Qualified Record.

Author:

Laird Nelson

Nested Class Summary

Nested classes/interfaces inherited from interface org.microbean.qualifier.Qualified

Qualified.Record<V,T>

Constructor Summary

Constructors

Constructor	Description
Record(Qualifiers<V> qualifiers, T qualified)	Creates a new Qualified.Record.
Record(T qualified)	Creates a new Qualified.Record.

Method Summary

Modifier and Type	Method	Description
final Optional<? extends ConstantDesc>	describeConstable()	Returns an Optional housing a ConstantDesc describing this Qualified.Record, if this Qualified.Record is capable of being represented as a dynamic constant, or an empty Optional if not.
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 <V, T> Qualified.Record<V,T>	of(Qualifiers<V> qualifiers, T qualified)	Returns a Qualified.Record, which may or may not be newly created, representing the supplied Qualifiers and qualified object.
static final <V, T> Qualified.Record<V,T>	of(T qualified)	Returns a Qualified.Record, which may or may not be newly created, representing the qualified object.
T	qualified()	Returns the value of the qualified record component.
Qualifiers<V>	qualifiers()	Returns the value of the qualifiers record component.
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

Record

public Record(T qualified)

Creates a new Qualified.Record.

Parameters:

qualified - the object being qualified; may be null

See Also:

• Record(Qualifiers, Object)

Record

public Record(Qualifiers<V> qualifiers,
 T qualified)

Creates a new Qualified.Record.

Parameters:

qualifiers - the Qualifiers; may be null in which case the return value of Qualifiers.of() will be used instead

qualified - the object being qualified; may be null

Method Details

describeConstable

public final Optional<? extends ConstantDesc> describeConstable()

Returns an Optional housing a ConstantDesc describing this Qualified.Record, if this Qualified.Record is capable of being represented as a dynamic constant, or an empty Optional if not.

Specified by:

describeConstable in interface Constable

Specified by:

describeConstable in interface Qualified<V,T>

Returns:

an Optional housing a ConstantDesc describing this Qualified.Record, if this Qualified.Record is capable of being represented as a dynamic constant, or an empty Optional if not

See Also:

• Dynamically-computed constants

Idempotency:

This method is, and its overrides must be, idempotent and deterministic.

Nullability:

This method does not, and its overrides must not, return null.

Thread Safety:

This method is, and its overrides must be, safe for concurrent use by multiple threads.

of

public static final <V,
T> Qualified.Record<V,T> of(T qualified)

Returns a Qualified.Record, which may or may not be newly created, representing the qualified object.

Type Parameters:

V - the type of the Qualified.Record's Qualifiers' value and attribute values

T - the type of the qualified object

Parameters:

qualified - the qualified object; may be null

Returns:

a Qualified.Record

See Also:

• of(Qualifiers, Object)

Idempotency:

This method is neither idempotent nor deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

of

public static final <V,
T> Qualified.Record<V,T> of(Qualifiers<V> qualifiers,
 T qualified)

Returns a Qualified.Record, which may or may not be newly created, representing the supplied Qualifiers and qualified object.

Type Parameters:

V - the type of the Qualified.Record's Qualifiers' value and attribute values

T - the type of the qualified object

Parameters:

qualifiers - the Qualifiers; may be null

qualified - the qualified object; may be null

Returns:

a Qualified.Record

Idempotency:

This method is neither idempotent nor deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

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.

qualifiers

public Qualifiers<V> qualifiers()

Returns the value of the qualifiers record component.

Specified by:

qualifiers in interface Qualified<V,T>

Returns:

the value of the qualifiers record component

qualified

public T qualified()

Returns the value of the qualified record component.

Specified by:

qualified in interface Qualified<V,T>

Returns:

the value of the qualified record component