Record Class Bean<I>

java.lang.Object

java.lang.Record

org.microbean.bean.Bean<I>

Type Parameters:

I - the type of the contextual instances the associated Factory creates

Record Components:

id - the Id; must not be null

factory - the Factory; must not be null

All Implemented Interfaces:

Constable, Aggregate, Ranked

public record Bean<I>(Id id, Factory<I> factory)
extends Record
implements Aggregate, Constable, Ranked

A (Constable) pairing of an Id with a Factory.

Author:

Laird Nelson

See Also:

• Factory
• Id

Field Summary

Fields inherited from interface org.microbean.bean.Aggregate

EMPTY_ASSIGNMENTS, EMPTY_DEPENDENCIES

Fields inherited from interface org.microbean.bean.Ranked

DEFAULT_RANK

Constructor Summary

Constructors

Constructor	Description
Bean(Id id, Factory<I> factory)	Creates a new Bean.

Method Summary

Modifier and Type	Method	Description
final boolean	alternate()	Returns true if this Ranked is to be considered an alternate, which may have an effect on how the return value of the Ranked.rank() method is interpreted in some situations.
final SequencedSet<? extends Assignment<?>>	assign(Function<? super AttributedType,?> r)	A convenience method that assigns a contextual reference to each of this Aggregate's AttributedElement instances and returns the resulting SequencedSet of Assignments.
final <X> Bean<X>	cast()	Returns this Bean, forcibly cast appropriately.
final SequencedSet<AttributedElement>	dependencies()	Returns an immutable SequencedSet of AttributedElement instances.
final Optional<DynamicConstantDesc<Bean<I>>>	describeConstable()
final boolean	equals(Object other)	Indicates whether some other object is "equal to" this one.
Factory<I>	factory()	Returns the value of the factory record component.
final int	hashCode()	Returns a hash code value for this object.
Id	id()	Returns the value of the id record component.
final int	rank()	Returns the rank of this Ranked implementation.
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

Methods inherited from interface org.microbean.bean.Ranked

outranks, outranks

Constructor Details

Bean

public Bean(Id id,
 Factory<I> factory)

Creates a new Bean.

Parameters:

id - the Id; must not be null

factory - the Factory; must not be null

Throws:

NullPointerException - if either argument is null

Method Details

alternate

public final boolean alternate()

Description copied from interface: Ranked

Returns true if this Ranked is to be considered an alternate, which may have an effect on how the return value of the Ranked.rank() method is interpreted in some situations.

The default implementation of this method returns false.

Overrides of this method must be idempotent and return a determinate value.

Specified by:

alternate in interface Ranked

Returns:

true if this Ranked is to be considered an alternate

assign

public final SequencedSet<? extends Assignment<?>> assign(Function<? super AttributedType,?> r)

Description copied from interface: Aggregate

A convenience method that assigns a contextual reference to each of this Aggregate's AttributedElement instances and returns the resulting SequencedSet of Assignments.

Typically there is no need to override this method.

Specified by:

assign in interface Aggregate

Parameters:

r - a Function that retrieves a contextual reference suitable for an AttributedType; if Aggregate.dependencies() returns a non-empty SequencedSet then this argument must not be null

Returns:

an immutable SequencedSet of Assignment instances; never null

See Also:

• References

cast

public final <X> Bean<X> cast()

Returns this Bean, forcibly cast appropriately.

Type Parameters:

X - the type of contextual instances this Bean creates

Returns:

this Bean

Throws:

ClassCastException - if the cast is inappropriate

dependencies

public final SequencedSet<AttributedElement> dependencies()

Description copied from interface: Aggregate

Returns an immutable SequencedSet of AttributedElement instances.

Specified by:

dependencies in interface Aggregate

Returns:

an immutable SequencedSet of AttributedElement instances; never null

See Also:

• AttributedElement

describeConstable

public final Optional<DynamicConstantDesc<Bean<I>>> describeConstable()

Specified by:

describeConstable in interface Constable

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.

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

rank

public final int rank()

Description copied from interface: Ranked

Returns the rank of this Ranked implementation.

Implementations of this method may return any integer: positive, zero, or negative.

The default implementation of this method returns the value of the Ranked.DEFAULT_RANK field (0).

Overrides of this method must return a determinate value.

Specified by:

rank in interface Ranked

Returns:

the rank of this Ranked implementation

See Also:

• Ranked.outranks(int, int)

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

id

public Id id()

Returns the value of the id record component.

Returns:

the value of the id record component

factory

public Factory<I> factory()

Returns the value of the factory record component.

Returns:

the value of the factory record component