Skip to content

Package dev.gecode.iris

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.

@NullMarked package dev.gecode.iris
Reads text instance files described by Iris reader specs.

Spec parses a reader spec and reads inputs into Data, whose Values give the entries. Errors in a reader spec or an input throw IrisException.

  • Class
    Description
    The entries that a read or a catalog produced, in definition order (§3.1).
    An entry.
    Names the entry that a record component reads through Spec.reader(Class, MethodHandles.Lookup).
    A stable identifier for a kind of error, from the Specification's error registry.
    Field<V extends @Nullable Object>
    A typed handle: the name of an entry, and the Java type V that Data.get(Field) returns for it.
    The details of an error, in the terms of the Specification's canonical error document.
    A check that failed.
    An error found while reading an input.
    An error found while parsing a reader spec.
    Thrown for an error in a reader spec, or in an input that a reader spec reads.
    A position in a reader spec or an input.
    The parameters of a read, as names with text values, in the order they were given (§9.1).
    RecordReader<R extends Record>
    Reads data into records of type R.
    A parsed reader spec, checked against every parse-time rule of the Specification.
    A value that a read produced: a single integer, float or string, or an array of them, which can be nested and ragged (§3.2).
    An array, or a row of a larger array, whose elements stay in place until they are asked for.
    A single float.
    A single integer.
    A single string.
    The type of the leaves of a value.