java.lang.Object

java.lang.Record

org.microbean.attributes.ArrayValue<T>

Type Parameters:: T - the type of the Values
Record Components:: value - a non-null array of Values

All Implemented Interfaces:: Comparable<ArrayValue<T>>, Constable, Value<ArrayValue<T>>

public record ArrayValue<T extends Value<T>>(T extends Value<T>[] value) extends Record implements Value<ArrayValue<T>>

A Value holding other Values.

Author:: Laird Nelson

Constructor Summary

Constructors

Constructor

Description

ArrayValue(T[] value)

Creates a new ArrayValue.
Method Summary

Modifier and Type

Method

Description

final int

compareTo(ArrayValue<T> other)

final Optional<DynamicConstantDesc<ArrayValue<T>>>

describeConstable()

final boolean

equals(Object other)

Indicates whether some other object is "equal to" this one.

final int

hashCode()

Returns a hash code value for this object.

static final ArrayValue<BooleanValue>

of(boolean... values)

Returns an ArrayValue suitable for the supplied argument.

static final ArrayValue<ByteValue>

of(byte... values)

Returns an ArrayValue suitable for the supplied argument.

static final ArrayValue<CharValue>

of(char... values)

Returns an ArrayValue suitable for the supplied argument.

static final ArrayValue<DoubleValue>

of(double... values)

Returns an ArrayValue suitable for the supplied argument.

static final ArrayValue<FloatValue>

of(float... values)

Returns an ArrayValue suitable for the supplied argument.

static final ArrayValue<IntValue>

of(int... values)

Returns an ArrayValue suitable for the supplied argument.

static final ArrayValue<LongValue>

of(long... values)

Returns an ArrayValue suitable for the supplied argument.

static final ArrayValue<ShortValue>

of(short... values)

Returns an ArrayValue suitable for the supplied argument.

static final ArrayValue<ClassValue>

of(Class<?>... values)

Returns an ArrayValue suitable for the supplied argument.

static final ArrayValue<StringValue>

of(String... values)

Returns an ArrayValue suitable for the supplied argument.

static final <T extends Value<T>> ArrayValue<T>

of(List<T> value)

Returns an ArrayValue suitable for the supplied argument.

static final <T extends Value<T>> ArrayValue<T>

of(T[] value)

Returns an ArrayValue suitable for the supplied argument.

final String

toString()

Returns a string representation of this record class.

final T[]

value()

Returns the array of suitably-typed Values this ArrayValue holds.

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

Constructor Details
- ArrayValue
  
  public ArrayValue(T[] value)
  
  Creates a new ArrayValue.
  
  Parameters:
  
  value - a non-null array of Values
  
  Throws:
  
  NullPointerException - if value is null
Method Details
- compareTo
  
  public final int compareTo(ArrayValue<T> other)
  
  Specified by:
  
  compareTo in interface Comparable<T extends Value<T>>
- describeConstable
  
  public final Optional<DynamicConstantDesc<ArrayValue<T>>> 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
- 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
- value
  
  public final T[] value()
  
  Returns the array of suitably-typed Values this ArrayValue holds.
  No reference to the returned array is kept.
  
  Returns:
  
  a non-null array of suitably-typed Values
- of
  public static final ArrayValue<BooleanValue> of(boolean... values)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Parameters:
  
  values - a non-null array of values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if values is null
  
  See Also:
  
  of(Value[])
- of
  public static final ArrayValue<ByteValue> of(byte... values)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Parameters:
  
  values - a non-null array of values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if values is null
  
  See Also:
  
  of(Value[])
- of
  public static final ArrayValue<CharValue> of(char... values)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Parameters:
  
  values - a non-null array of values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if values is null
  
  See Also:
  
  of(Value[])
- of
  public static final ArrayValue<DoubleValue> of(double... values)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Parameters:
  
  values - a non-null array of values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if values is null
  
  See Also:
  
  of(Value[])
- of
  public static final ArrayValue<FloatValue> of(float... values)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Parameters:
  
  values - a non-null array of values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if values is null
  
  See Also:
  
  of(Value[])
- of
  public static final ArrayValue<IntValue> of(int... values)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Parameters:
  
  values - a non-null array of values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if values is null
  
  See Also:
  
  of(Value[])
- of
  public static final ArrayValue<LongValue> of(long... values)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Parameters:
  
  values - a non-null array of values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if values is null
  
  See Also:
  
  of(Value[])
- of
  public static final ArrayValue<ShortValue> of(short... values)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Parameters:
  
  values - a non-null array of values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if values is null
  
  See Also:
  
  of(Value[])
- of
  public static final ArrayValue<ClassValue> of(Class<?>... values)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Parameters:
  
  values - a non-null array of values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if values is null
  
  See Also:
  
  of(Value[])
- of
  public static final ArrayValue<StringValue> of(String... values)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Parameters:
  
  values - a non-null array of values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if values is null
  
  See Also:
  
  of(Value[])
- of
  public static final <T extends Value<T>> ArrayValue<T> of(List<T> value)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Type Parameters:
  
  T - the type of Value held by the returned ArrayValue
  
  Parameters:
  
  value - a non-null List of suitably-typed Values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if value is null
  
  See Also:
  
  of(Value[])
- of
  
  public static final <T extends Value<T>> ArrayValue<T> of(T[] value)
  
  Returns an ArrayValue suitable for the supplied argument.
  
  Type Parameters:
  
  T - the type of Value held by the returned ArrayValue
  
  Parameters:
  
  value - a non-null array of suitably-typed Values
  
  Returns:
  
  a non-null ArrayValue
  
  Throws:
  
  NullPointerException - if value is null

Record Class ArrayValue<T extends Value<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

ArrayValue

Method Details

compareTo

describeConstable

equals

hashCode

toString

value

of

of

of

of

of

of

of

of

of

of

of

of