Module swim.codec

Package swim.codec

Class Diagnostic

java.lang.Object

swim.codec.Diagnostic

All Implemented Interfaces:

Display

public final class Diagnostic
extends Object
implements Display

Informational message attached to an input location.

Method Summary

Modifier and Type	Method	Description
Diagnostic	cause()	Returns the Diagnostic cause of this diagnostic, forming a linked chain of diagnostics, or null if this diagnostic has no cause.
static Diagnostic	create(Input input, Tag tag, Severity severity)
static Diagnostic	create(Input input, Tag tag, Severity severity, String message)
static Diagnostic	create(Input input, Tag tag, Severity severity, String message, String note)
static Diagnostic	create(Input input, Tag tag, Severity severity, String message, String note, Diagnostic cause)
static Diagnostic	create(Input input, Tag tag, Severity severity, String message, Diagnostic cause)
static Diagnostic	create(Input input, Tag tag, Severity severity, Diagnostic cause)
<T> Output<T>	display(Output<T> output)	Writes a human readable, display-formatted string representation of this object to output.
static Diagnostic	expected(int expected, Input input)
static Diagnostic	expected(int expected, Input input, String note)
static Diagnostic	expected(int expected, Input input, String note, Diagnostic cause)
static Diagnostic	expected(int expected, Input input, Diagnostic cause)
static Diagnostic	expected(int expected, Input input, Severity severity)
static Diagnostic	expected(int expected, Input input, Severity severity, String note)
static Diagnostic	expected(int expected, Input input, Severity severity, String note, Diagnostic cause)
static Diagnostic	expected(int expected, Input input, Severity severity, Diagnostic cause)
static Diagnostic	expected(String expected, Input input)
static Diagnostic	expected(String expected, Input input, String note)
static Diagnostic	expected(String expected, Input input, String note, Diagnostic cause)
static Diagnostic	expected(String expected, Input input, Diagnostic cause)
static Diagnostic	expected(String expected, Input input, Severity severity)
static Diagnostic	expected(String expected, Input input, Severity severity, String note)
static Diagnostic	expected(String expected, Input input, Severity severity, String note, Diagnostic cause)
static Diagnostic	expected(String expected, Input input, Severity severity, Diagnostic cause)
Input	input()	Returns the Input source to which this diagnostic is attached.
String	message()	Returns the help message that describes this diagnostic.
static Diagnostic	message(String message, Input input)
static Diagnostic	message(String message, Input input, String note)
static Diagnostic	message(String message, Input input, String note, Diagnostic cause)
static Diagnostic	message(String message, Input input, Diagnostic cause)
static Diagnostic	message(String message, Input input, Severity severity)
static Diagnostic	message(String message, Input input, Severity severity, String note)
static Diagnostic	message(String message, Input input, Severity severity, String note, Diagnostic cause)
static Diagnostic	message(String message, Input input, Severity severity, Diagnostic cause)
String	note()	Returns an informative comment on the source context to which this diagnostic is attached.
Severity	severity()	Returns the level of importance of this diagnostic.
Tag	tag()	Returns the annotated location Tag in the input to which this diagnostic is attached.
String	toString()
String	toString(OutputSettings settings)
static Diagnostic	unexpected(Input input)
static Diagnostic	unexpected(Input input, String note)
static Diagnostic	unexpected(Input input, String note, Diagnostic cause)
static Diagnostic	unexpected(Input input, Diagnostic cause)
static Diagnostic	unexpected(Input input, Severity severity)
static Diagnostic	unexpected(Input input, Severity severity, String note)
static Diagnostic	unexpected(Input input, Severity severity, String note, Diagnostic cause)
static Diagnostic	unexpected(Input input, Severity severity, Diagnostic cause)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

input

public Input input()

Returns the Input source to which this diagnostic is attached.

tag

public Tag tag()

Returns the annotated location Tag in the input to which this diagnostic is attached.

severity

public Severity severity()

Returns the level of importance of this diagnostic.

message

public String message()

Returns the help message that describes this diagnostic.

note

public String note()

Returns an informative comment on the source context to which this diagnostic is attached.

cause

public Diagnostic cause()

Returns the Diagnostic cause of this diagnostic, forming a linked chain of diagnostics, or null if this diagnostic has no cause.

display

public <T> Output<T> display(Output<T> output)

Description copied from interface: Display

Writes a human readable, display-formatted string representation of this object to output.

Specified by:

display in interface Display

Returns:

the continuation of the output.

toString

public String toString(OutputSettings settings)

toString

public String toString()

Overrides:

toString in class Object

create

public static Diagnostic create(Input input,
                                Tag tag,
                                Severity severity,
                                String message,
                                String note,
                                Diagnostic cause)

create

public static Diagnostic create(Input input,
                                Tag tag,
                                Severity severity,
                                String message,
                                String note)

create

public static Diagnostic create(Input input,
                                Tag tag,
                                Severity severity,
                                String message,
                                Diagnostic cause)

create

public static Diagnostic create(Input input,
                                Tag tag,
                                Severity severity,
                                String message)

create

public static Diagnostic create(Input input,
                                Tag tag,
                                Severity severity,
                                Diagnostic cause)

create

public static Diagnostic create(Input input,
                                Tag tag,
                                Severity severity)

message

public static Diagnostic message(String message,
                                 Input input,
                                 Severity severity,
                                 String note,
                                 Diagnostic cause)

message

public static Diagnostic message(String message,
                                 Input input,
                                 Severity severity,
                                 String note)

message

public static Diagnostic message(String message,
                                 Input input,
                                 Severity severity,
                                 Diagnostic cause)

message

public static Diagnostic message(String message,
                                 Input input,
                                 Severity severity)

message

public static Diagnostic message(String message,
                                 Input input,
                                 String note,
                                 Diagnostic cause)

message

public static Diagnostic message(String message,
                                 Input input,
                                 String note)

message

public static Diagnostic message(String message,
                                 Input input,
                                 Diagnostic cause)

message

public static Diagnostic message(String message,
                                 Input input)

unexpected

public static Diagnostic unexpected(Input input,
                                    Severity severity,
                                    String note,
                                    Diagnostic cause)

unexpected

public static Diagnostic unexpected(Input input,
                                    Severity severity,
                                    String note)

unexpected

public static Diagnostic unexpected(Input input,
                                    Severity severity,
                                    Diagnostic cause)

unexpected

public static Diagnostic unexpected(Input input,
                                    Severity severity)

unexpected

public static Diagnostic unexpected(Input input,
                                    String note,
                                    Diagnostic cause)

unexpected

public static Diagnostic unexpected(Input input,
                                    String note)

unexpected

public static Diagnostic unexpected(Input input,
                                    Diagnostic cause)

unexpected

public static Diagnostic unexpected(Input input)

expected

public static Diagnostic expected(int expected,
                                  Input input,
                                  Severity severity,
                                  String note,
                                  Diagnostic cause)

expected

public static Diagnostic expected(int expected,
                                  Input input,
                                  Severity severity,
                                  String note)

expected

public static Diagnostic expected(int expected,
                                  Input input,
                                  Severity severity,
                                  Diagnostic cause)

expected

public static Diagnostic expected(int expected,
                                  Input input,
                                  Severity severity)

expected

public static Diagnostic expected(int expected,
                                  Input input,
                                  String note,
                                  Diagnostic cause)

expected

public static Diagnostic expected(int expected,
                                  Input input,
                                  String note)

expected

public static Diagnostic expected(int expected,
                                  Input input,
                                  Diagnostic cause)

expected

public static Diagnostic expected(int expected,
                                  Input input)

expected

public static Diagnostic expected(String expected,
                                  Input input,
                                  Severity severity,
                                  String note,
                                  Diagnostic cause)

expected

public static Diagnostic expected(String expected,
                                  Input input,
                                  Severity severity,
                                  String note)

expected

public static Diagnostic expected(String expected,
                                  Input input,
                                  Severity severity,
                                  Diagnostic cause)

expected

public static Diagnostic expected(String expected,
                                  Input input,
                                  Severity severity)

expected

public static Diagnostic expected(String expected,
                                  Input input,
                                  String note,
                                  Diagnostic cause)

expected

public static Diagnostic expected(String expected,
                                  Input input,
                                  String note)

expected

public static Diagnostic expected(String expected,
                                  Input input,
                                  Diagnostic cause)

expected

public static Diagnostic expected(String expected,
                                  Input input)