Skip to content
IrisIris

Class Params

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.Params
public final class Params extends Object
The parameters of a read, as names with text values, in the order they were given (§9.1).

The order decides which unknown parameter a read reports. A Params is immutable.

  • Method Details

    • of

      public static Params of()
      Returns no parameters.
      Returns:
      no parameters

    • of

      public static Params of(String name, String value)
      Makes one parameter.
      Parameters:
      name - the name
      value - the text of the value
      Returns:
      the parameter
      Throws:
      IllegalArgumentException - if either has an unpaired surrogate, which is not text

    • of

      public static Params of(Map<String,String> values)
      Makes parameters from a map.
      Parameters:
      values - the names with their values, in the order of the parameters
      Returns:
      the parameters
      Throws:
      IllegalArgumentException - if a name or value has an unpaired surrogate, which is not text

    • with

      public Params with(String name, String value)
      Sets a parameter. A name already present keeps its position.
      Parameters:
      name - the name
      value - the text of the value
      Returns:
      these parameters with the change, which leaves this object as it is
      Throws:
      IllegalArgumentException - if either has an unpaired surrogate, which is not text

    • values

      public SequencedMap<String,String> values()
      Returns the parameters as an unmodifiable map, in the order they were given.
      Returns:
      the parameters as an unmodifiable map, in the order they were given