java.lang.Object

java.lang.Record

org.microbean.attributes.Attributes

Record Components:: name - a non-null name of this Attributes; values - a non-null Map of named values associated with this Attributes; notes - a non-null Map of non-normative named values associated with this Attributes; attributesMap - a non-null Map of named metadata associated with this Attributes

All Implemented Interfaces:: Comparable<Attributes>, Constable, Attributed, Value<Attributes>

public record Attributes(String name, Map<String,Value<?>> values, Map<String,Value<?>> notes, Map<String,List<Attributes>> attributesMap) extends Record implements Attributed, Value<Attributes>

An attributed Value with a name, named values, and non-normative named values.

Author:: Laird Nelson

Constructor Summary

Constructors

Constructor

Description

Attributes(String name, Map<String,Value<?>> values, Map<String,Value<?>> notes, Map<String,List<Attributes>> attributesMap)

Creates a new Attributes.
Method Summary

Modifier and Type

Method

Description

final List<Attributes>

attributes()

Returns a List of Attributes associated with this Attributes directly, or an empty List if there is no such List.

final List<Attributes>

attributes(String key)

Returns a List of Attributes associated with the supplied key, or an empty List if there is no such List.

Map<String,List<Attributes>>

attributesMap()

Returns the value of the attributesMap record component.

final int

compareTo(Attributes other)

final Optional<DynamicConstantDesc<Attributes>>

describeConstable()

final boolean

equals(Object other)

Returns true if this Attributes equals the supplied Object.

final int

hashCode()

Returns a hash code value for this Attributes derived solely from its values.

String

name()

Returns the value of the name record component.

Map<String,Value<?>>

notes()

Returns the value of the notes record component.

static final Attributes

of(String name)

Returns an Attributes comprising the supplied arguments.

static final Attributes

of(String name, String valueValue)

Returns an Attributes comprising the supplied arguments.

static final Attributes

of(String name, List<Attributes> attributes)

Returns an Attributes comprising the supplied arguments.

static final Attributes

of(String name, Map<String,Value<?>> values, Map<String,Value<?>> notes, Map<String,List<Attributes>> attributes)

Returns an Attributes comprising the supplied arguments.

static final Attributes

of(String name, Attributes... attributes)

Returns an Attributes comprising the supplied arguments.

final String

toString()

Returns a string representation of this record class.

final <T extends Value<T>> T

value(String name)

Returns a suitably-typed Value indexed under the supplied name, or null if no such Value exists.

Map<String,Value<?>>

values()

Returns the value of the values record component.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- Attributes
  
  public Attributes(String name, Map<String,Value<?>> values, Map<String,Value<?>> notes, Map<String,List<Attributes>> attributesMap)
  
  Creates a new Attributes.
  
  Parameters:
  
  name - a non-null name of this Attributes
  
  values - a non-null Map of named values associated with this Attributes
  
  notes - a non-null Map of non-normative named values associated with this Attributes
  
  attributesMap - a non-null Map of named metadata associated with this Attributes
  
  Throws:
  
  NullPointerException - if any argument is null
Method Details
- attributes
  public final List<Attributes> attributes()
  
  Returns a List of Attributes associated with this Attributes directly, or an empty List if there is no such List.
  
  Specified by:
  
  attributes in interface Attributed
  
  Returns:
  
  a non-null List of Attributes
  
  See Also:
  
  attributes(String)
  
  name()
- attributes
  
  public final List<Attributes> attributes(String key)
  
  Returns a List of Attributes associated with the supplied key, or an empty List if there is no such List.
  
  Parameters:
  
  key - a String; must not be null
  
  Returns:
  
  a non-null List of Attributes
  
  Throws:
  
  NullPointerException - if key is null
- compareTo
  
  public final int compareTo(Attributes other)
  
  Specified by:
  
  compareTo in interface Comparable<Attributes>
- describeConstable
  
  public final Optional<DynamicConstantDesc<Attributes>> describeConstable()
  
  Specified by:
  
  describeConstable in interface Constable
- equals
  public final boolean equals(Object other)
  
  Returns true if this Attributes equals the supplied Object.
  If the supplied Object is also an Attributes and has a name equal to this Attributes' name and a values Map equal to this Attributes' values Map, this method returns true.
  
  This method returns false in all other cases.
  
  Specified by:
  
  equals in class Record
  
  Parameters:
  
  other - an Object; may be null
  
  Returns:
  
  true if this Attributes equals the supplied Object
  
  See Also:
  
  hashCode()
  
  name()
  
  values()
- hashCode
  public final int hashCode()
  
  Returns a hash code value for this Attributes derived solely from its values.
  
  Specified by:
  
  hashCode in class Record
  
  Returns:
  
  a hash code value
  
  See Also:
  
  values()
  
  equals(Object)
- value
  
  public final <T extends Value<T>> T value(String name)
  
  Returns a suitably-typed Value indexed under the supplied name, or null if no such Value exists.
  
  Type Parameters:
  
  T - the type of the Value
  
  Parameters:
  
  name - the name; must not be null
  
  Returns:
  
  a suitably-typed Value indexed under the supplied name, or null if no such Value exists
  
  Throws:
  
  NullPointerException - if name is null
  
  ClassCastException - if <T> does not match the actual type of the Value indexed under the supplied name
- of
  public static final Attributes of(String name)
  
  Returns an Attributes comprising the supplied arguments.
  
  Parameters:
  
  name - the name; must not be null
  
  Returns:
  
  a non-null Attributes
  
  Throws:
  
  NullPointerException - if name is null
  
  See Also:
  
  of(String, Map, Map, Map)
- of
  public static final Attributes of(String name, String valueValue)
  
  Returns an Attributes comprising the supplied arguments.
  
  Parameters:
  
  name - the name; must not be null
  
  valueValue - a String that will be indexed under the key "value"; must not be null
  
  Returns:
  
  a non-null Attributes
  
  Throws:
  
  NullPointerException - if name or valueValue is null
  
  See Also:
  
  of(String, Map, Map, Map)
- of
  public static final Attributes of(String name, Attributes... attributes)
  
  Returns an Attributes comprising the supplied arguments.
  
  Parameters:
  
  name - the name; must not be null
  
  attributes - an array of Attributes; may be null
  
  Returns:
  
  a non-null Attributes
  
  Throws:
  
  NullPointerException - if name is null
  
  See Also:
  
  of(String, List)
- of
  public static final Attributes of(String name, List<Attributes> attributes)
  
  Returns an Attributes comprising the supplied arguments.
  
  Parameters:
  
  name - the name; must not be null
  
  attributes - a non-null List of Attributes
  
  Returns:
  
  a non-null Attributes
  
  Throws:
  
  NullPointerException - if any argument is null
  
  See Also:
  
  of(String, Map, Map, Map)
- of
  
  public static final Attributes of(String name, Map<String,Value<?>> values, Map<String,Value<?>> notes, Map<String,List<Attributes>> attributes)
  
  Returns an Attributes comprising the supplied arguments.
  
  Parameters:
  
  name - the name; must not be null
  
  values - a Map of Values indexed by String keys; must not be null
  
  notes - a Map of Values indexed by String keys containing descriptive information only; must not be null; not incorporated into equality calculations
  
  attributes - a Map of Lists of Attributes instances denoting metadata for a given value in values (or for this Attributes as a whole if the key in question is equal to name); must not be null
  
  Returns:
  
  a non-null Attributes
  
  Throws:
  
  NullPointerException - if any 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
- name
  
  public String name()
  
  Returns the value of the name record component.
  
  Returns:
  
  the value of the name record component
- values
  
  public Map<String,Value<?>> values()
  
  Returns the value of the values record component.
  
  Returns:
  
  the value of the values record component
- notes
  
  public Map<String,Value<?>> notes()
  
  Returns the value of the notes record component.
  
  Returns:
  
  the value of the notes record component
- attributesMap
  
  public Map<String,List<Attributes>> attributesMap()
  
  Returns the value of the attributesMap record component.
  
  Returns:
  
  the value of the attributesMap record component

Record Class Attributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Attributes

Method Details

attributes

attributes

compareTo

describeConstable

equals

hashCode

value

of

of

of

of

of

toString

name

values

notes

attributesMap