Module com.io7m.jsx.combinators

Package com.io7m.jsx.combinators

Class JSXValidationError

java.lang.Object

com.io7m.jsx.combinators.JSXValidationError

All Implemented Interfaces:

JSXValidationErrorType

public final class JSXValidationError
extends Object
implements JSXValidationErrorType

An error produced during validation of an S-expression.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JSXValidationError.Builder	Builds instances of type JSXValidationError.

Method Summary

Modifier and Type	Method	Description
static JSXValidationError.Builder	builder()	Creates a builder for JSXValidationError.
static JSXValidationError	copyOf(JSXValidationErrorType instance)	Creates an immutable copy of a JSXValidationErrorType value.
boolean	equals(Object another)	This instance is equal to all instances of JSXValidationError that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: lex, message.
com.io7m.jlexing.core.LexicalPositionType<URI>	lex()
String	message()
static JSXValidationError	of(com.io7m.jlexing.core.LexicalPositionType<URI> lex, String message)	Construct a new immutable JSXValidationError instance.
String	toString()	Prints the immutable value JSXValidationError with attribute values.
JSXValidationError	withLex(com.io7m.jlexing.core.LexicalPositionType<URI> value)	Copy the current immutable object by setting a value for the lex attribute.
JSXValidationError	withMessage(String value)	Copy the current immutable object by setting a value for the message attribute.

Methods inherited from class java.lang.Object

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

Method Detail

lex

public com.io7m.jlexing.core.LexicalPositionType<URI> lex()

Specified by:

lex in interface JSXValidationErrorType

Returns:

The lexical information

message

public String message()

Specified by:

message in interface JSXValidationErrorType

Returns:

The error message

withLex

public final JSXValidationError withLex(com.io7m.jlexing.core.LexicalPositionType<URI> value)

Copy the current immutable object by setting a value for the lex attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for lex

Returns:

A modified copy of the this object

withMessage

public final JSXValidationError withMessage(String value)

Copy the current immutable object by setting a value for the message attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for message

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of JSXValidationError that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: lex, message.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value JSXValidationError with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static JSXValidationError of(com.io7m.jlexing.core.LexicalPositionType<URI> lex,
                                    String message)

Construct a new immutable JSXValidationError instance.

Parameters:

lex - The value for the lex attribute

message - The value for the message attribute

Returns:

An immutable JSXValidationError instance

copyOf

public static JSXValidationError copyOf(JSXValidationErrorType instance)

Creates an immutable copy of a JSXValidationErrorType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable JSXValidationError instance

builder

public static JSXValidationError.Builder builder()

Creates a builder for JSXValidationError.

Returns:

A new JSXValidationError builder