Record Class IrisError.CheckError

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

java.lang.Record

dev.gecode.iris.IrisError.CheckError

Record Components:

code - the stable code of the error

message - the main diagnostic text

inputLocation - the location in the input

specLocation - the location in the reader spec

context - the execution context, outermost first, or null if the error has none

recordPath - the indices of the witness

All Implemented Interfaces:

IrisError, Serializable

Enclosing interface:

IrisError

public static record IrisError.CheckError(ErrorCode code, String message, Location inputLocation, Location specLocation, @Nullable String context, List<Integer> recordPath) extends Record implements IrisError

A check that failed.

• Nested Class Summary

  Nested classes/interfaces inherited from interface IrisError

  IrisError.CheckError, IrisError.ReadError, IrisError.SpecError

  Modifier and Type

  Interface

  Description

  static final record 

  IrisError.CheckError

  A check that failed.

  static final record 

  IrisError.ReadError

  An error found while reading an input.

  static final record 

  IrisError.SpecError

  An error found while parsing a reader spec.

• Constructor Summary

  Constructors

  Constructor

  Description

  CheckError(ErrorCode code, String message, Location inputLocation, Location specLocation, @Nullable String context, List<Integer> recordPath)

  Copies the path into an immutable list.

• Method Summary

  Modifier and Type

  Method

  Description

  ErrorCode

  code()

  Returns the value of the code record component.

  @Nullable String

  context()

  Returns the value of the context record component.

  final boolean

  equals(Object o)

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

  final int

  hashCode()

  Returns a hash code value for this object.

  Location

  inputLocation()

  Returns the value of the inputLocation record component.

  String

  message()

  Returns the value of the message record component.

  List<Integer>

  recordPath()

  Returns the value of the recordPath record component.

  Location

  specLocation()

  Returns the value of the specLocation record component.

  final String

  toString()

  Returns a string representation of this record class.

  Methods inherited from class Object

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

  Methods inherited from interface IrisError

  toJson

  Modifier and Type

  Method

  Description

  default String

  toJson()

  Returns the canonical error document of this error (§3.7), with its final newline.

• Constructor Details

  • CheckError

    public CheckError(ErrorCode code, String message, Location inputLocation, Location specLocation, @Nullable String context, List<Integer> recordPath)

    Copies the path into an immutable list.

• Method Details

  • 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

  • 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

  • equals

    public final boolean equals(Object o)

    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:

    o - the object with which to compare

    Returns:

    true if this object is the same as the o argument; false otherwise.

  • code

    public ErrorCode code()

    Returns the value of the code record component.

    Specified by:

    code in interface IrisError

    Returns:

    the value of the code record component

  • message

    public String message()

    Returns the value of the message record component.

    Specified by:

    message in interface IrisError

    Returns:

    the value of the message record component

  • inputLocation

    public Location inputLocation()

    Returns the value of the inputLocation record component.

    Specified by:

    inputLocation in interface IrisError

    Returns:

    the value of the inputLocation record component

  • specLocation

    public Location specLocation()

    Returns the value of the specLocation record component.

    Specified by:

    specLocation in interface IrisError

    Returns:

    the value of the specLocation record component

  • context

    public @Nullable String context()

    Returns the value of the context record component.

    Specified by:

    context in interface IrisError

    Returns:

    the value of the context record component

  • recordPath

    public List<Integer> recordPath()

    Returns the value of the recordPath record component.

    Specified by:

    recordPath in interface IrisError

    Returns:

    the value of the recordPath record component