Class Value.ArrayValue

Javadoc 27 generates this reference during each site build from the exported packages and the annotation processor. The Java guide shows the API in use.

java.lang.Object

dev.gecode.iris.Value.ArrayValue

All Implemented Interfaces:

Value

Enclosing interface:

Value

public static final class Value.ArrayValue extends Object implements Value

An array, or a row of a larger array, whose elements stay in place until they are asked for.

• Nested Class Summary

  Nested classes/interfaces inherited from interface Value

  Value.ArrayValue, Value.FloatValue, Value.IntValue, Value.StringValue

  Modifier and Type

  Interface

  Description

  static final class 

  Value.ArrayValue

  An array, or a row of a larger array, whose elements stay in place until they are asked for.

  static final record 

  Value.FloatValue

  A single float.

  static final record 

  Value.IntValue

  A single integer.

  static final record 

  Value.StringValue

  A single string.

• Method Summary

  Modifier and Type

  Method

  Description

  int

  depth()

  Returns the depth: 0 for a single value, and otherwise the levels of nesting.

  double[]

  doubles()

  Returns a copy of the numbers of this one-dimensional array, integers as floats.

  boolean

  equals(@Nullable Object other)

   

  Value

  get(int index)

  Gets an element of this array.

  int

  hashCode()

   

  long[]

  longs()

  Returns a copy of the integers of this one-dimensional array.

  int

  size()

  Returns the number of elements of this array.

  List<String>

  strings()

  Returns the strings of this one-dimensional array, as an unmodifiable list.

  String

  toString()

  Returns the array in canonical JSON.

  ValueType

  type()

  Returns the type of the leaves.

  Methods inherited from class Object

  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  Methods inherited from interface Value

  asDouble, asLong, asString, at, ints

  Modifier and Type

  Method

  Description

  default double

  asDouble()

  Returns this single number, as a float if it is an integer.

  default long

  asLong()

  Returns this single integer.

  default String

  asString()

  Returns this single string.

  default Value

  at(int... path)

  Follows indices into this value.

  default int[]

  ints()

  Narrows the integers of this one-dimensional array.

• Method Details

  • type

    public ValueType type()

    Description copied from interface: Value

    Returns the type of the leaves.

    Specified by:

    type in interface Value

    Returns:

    the type of the leaves

  • depth

    public int depth()

    Description copied from interface: Value

    Returns the depth: 0 for a single value, and otherwise the levels of nesting.

    Specified by:

    depth in interface Value

    Returns:

    the depth: 0 for a single value, and otherwise the levels of nesting

  • size

    public int size()

    Description copied from interface: Value

    Returns the number of elements of this array.

    Specified by:

    size in interface Value

    Returns:

    the number of elements of this array

  • get

    public Value get(int index)

    Description copied from interface: Value

    Gets an element of this array.

    Specified by:

    get in interface Value

    Parameters:

    index - the index of the element, counted from 0

    Returns:

    the element

  • longs

    public long[] longs()

    Description copied from interface: Value

    Returns a copy of the integers of this one-dimensional array.

    Specified by:

    longs in interface Value

    Returns:

    a copy of the integers of this one-dimensional array

  • doubles

    public double[] doubles()

    Description copied from interface: Value

    Returns a copy of the numbers of this one-dimensional array, integers as floats.

    Specified by:

    doubles in interface Value

    Returns:

    a copy of the numbers of this one-dimensional array, integers as floats

  • strings

    public List<String> strings()

    Description copied from interface: Value

    Returns the strings of this one-dimensional array, as an unmodifiable list.

    Specified by:

    strings in interface Value

    Returns:

    the strings of this one-dimensional array, as an unmodifiable list

  • equals

    public boolean equals(@Nullable Object other)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • toString

    public String toString()

    Returns the array in canonical JSON.

    Overrides:

    toString in class Object

    Returns:

    the array in canonical JSON