Record Class Id

java.lang.Object

java.lang.Record

org.microbean.bean.Id

Record Components:

types - a BeanTypeList

attributes - a List of NamedAttributeMaps

governingScopeId - a NamedAttributeMap identifying the scope to which this Id logically belongs

alternate - whether this Id is to be considered an alternate

rank - the rank of this Id

All Implemented Interfaces:

Constable, Ranked, ScopeMember

public record Id(BeanTypeList types, List<NamedAttributeMap<?>> attributes, NamedAttributeMap<?> governingScopeId, boolean alternate, int rank)
extends Record
implements Constable, Ranked, ScopeMember

An identifier for a Bean.

Author:

Laird Nelson

See Also:

• Ranked
• ScopeMember

Field Summary

Fields inherited from interface org.microbean.bean.Ranked

DEFAULT_RANK

Constructor Summary

Constructors

Constructor	Description
Id(BeanTypeList types, List<NamedAttributeMap<?>> attributes, NamedAttributeMap<?> governingScopeId)	Creates a new Id that is not an alternate and that has a default rank.
Id(BeanTypeList types, List<NamedAttributeMap<?>> attributes, NamedAttributeMap<?> governingScopeId, boolean alternate, int rank)	Creates a new Id.
Id(BeanTypeList types, List<NamedAttributeMap<?>> attributes, NamedAttributeMap<?> governingScopeId, int rank)	Creates a new Id that is not an alternate.

Method Summary

Modifier and Type	Method	Description
boolean	alternate()	Returns the value of the alternate record component.
List<NamedAttributeMap<?>>	attributes()	Returns the value of the attributes record component.
final Optional<DynamicConstantDesc<Id>>	describeConstable()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
NamedAttributeMap<?>	governingScopeId()	Returns the value of the governingScopeId record component.
final int	hashCode()	Returns a hash code value for this object.
int	rank()	Returns the value of the rank record component.
final String	toString()	Returns a string representation of this record class.
BeanTypeList	types()	Returns the value of the types record component.

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

Methods inherited from interface org.microbean.scope.ScopeMember

governedBy

Constructor Details

Id

public Id(BeanTypeList types,
 List<NamedAttributeMap<?>> attributes,
 NamedAttributeMap<?> governingScopeId)

Creates a new Id that is not an alternate and that has a default rank.

Parameters:

types - a BeanTypeList; must not be null; must not be empty

attributes - a List of NamedAttributeMaps; must not be null

governingScopeId - a NamedAttributeMap identifying the scope to which this Id logically belongs; must not be null

Throws:

NullPointerException - if types, attributes, or governingScopeId is null

Id

public Id(BeanTypeList types,
 List<NamedAttributeMap<?>> attributes,
 NamedAttributeMap<?> governingScopeId,
 int rank)

Creates a new Id that is not an alternate.

Parameters:

types - a BeanTypeList; must not be null; must not be empty

attributes - a List of NamedAttributeMaps; must not be null

governingScopeId - a NamedAttributeMap identifying the scope to which this Id logically belongs; must not be null

rank - the rank of this Id

Throws:

NullPointerException - if types, attributes, or governingScopeId is null

Id

public Id(BeanTypeList types,
 List<NamedAttributeMap<?>> attributes,
 NamedAttributeMap<?> governingScopeId,
 boolean alternate,
 int rank)

Creates a new Id.

Parameters:

types - a BeanTypeList; must not be null; must not be empty

attributes - a List of NamedAttributeMaps; must not be null

governingScopeId - a NamedAttributeMap identifying the scope to which this Id logically belongs; must not be null

alternate - whether this Id is to be considered an alternate

rank - the rank of this Id

Throws:

NullPointerException - if types, attributes, or governingScopeId is null

Method Details

describeConstable

public final Optional<DynamicConstantDesc<Id>> describeConstable()

Specified by:

describeConstable in interface Constable

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

types

public BeanTypeList types()

Returns the value of the types record component.

Returns:

the value of the types record component

attributes

public List<NamedAttributeMap<?>> attributes()

Returns the value of the attributes record component.

Returns:

the value of the attributes record component

governingScopeId

public NamedAttributeMap<?> governingScopeId()

Returns the value of the governingScopeId record component.

Specified by:

governingScopeId in interface ScopeMember

Returns:

the value of the governingScopeId record component

alternate

public boolean alternate()

Returns the value of the alternate record component.

Specified by:

alternate in interface Ranked

Returns:

the value of the alternate record component

rank

public int rank()

Returns the value of the rank record component.

Specified by:

rank in interface Ranked

Returns:

the value of the rank record component

See Also:

• Ranked.outranks(int, int)