com.io7m.smfj.parser.api

Class SMFParseWarning

java.lang.Object

com.io7m.smfj.parser.api.SMFParseWarning

All Implemented Interfaces:

SMFWarningType, SMFParseWarningType

@Generated(value={"Immutables.generator","SMFParseWarningType"})
public final class SMFParseWarning
extends Object
implements SMFParseWarningType

The type of parse warnings.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SMFParseWarning.Builder	builder() Creates a builder for SMFParseWarning.
static SMFParseWarning	copyOf(SMFParseWarningType instance) Creates an immutable copy of a SMFParseWarningType value.
boolean	equals(Object another) This instance is equal to all instances of SMFParseWarning that have equal attribute values.
Optional<Exception>	exception()
String	fullMessage()
int	hashCode() Computes a hash code from attributes: lexical, message, exception.
com.io7m.jlexing.core.LexicalPosition<URI>	lexical()
String	message()
static SMFParseWarning	of(com.io7m.jlexing.core.LexicalPosition<URI> lexical, String message, Optional<Exception> exception) Construct a new immutable SMFParseWarning instance.
String	toString() Prints the immutable value SMFParseWarning with attribute values.
SMFParseWarning	withException(Exception value) Copy the current immutable object by setting a present value for the optional exception attribute.
SMFParseWarning	withException(Optional<? extends Exception> optional) Copy the current immutable object by setting an optional value for the exception attribute.
SMFParseWarning	withLexical(com.io7m.jlexing.core.LexicalPosition<URI> value) Copy the current immutable object by setting a value for the lexical attribute.
SMFParseWarning	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

lexical

public com.io7m.jlexing.core.LexicalPosition<URI> lexical()

Specified by:

lexical in interface SMFParseWarningType

Returns:

Lexical information

message

public String message()

Specified by:

message in interface SMFWarningType

Specified by:

message in interface SMFParseWarningType

Returns:

The value of the message attribute

exception

public Optional<Exception> exception()

Specified by:

exception in interface SMFWarningType

Specified by:

exception in interface SMFParseWarningType

Returns:

The value of the exception attribute

withLexical

public final SMFParseWarning withLexical(com.io7m.jlexing.core.LexicalPosition<URI> value)

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

Parameters:

value - A new value for lexical

Returns:

A modified copy of the this object

withMessage

public final SMFParseWarning 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

withException

public final SMFParseWarning withException(Exception value)

Copy the current immutable object by setting a present value for the optional exception attribute.

Parameters:

value - The value for exception

Returns:

A modified copy of this object

withException

public final SMFParseWarning withException(Optional<? extends Exception> optional)

Copy the current immutable object by setting an optional value for the exception attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - A value for exception

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of SMFParseWarning 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: lexical, message, exception.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SMFParseWarning with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

fullMessage

public String fullMessage()

Returns a lazily initialized value of the fullMessage attribute. Initialized once and only once and stored for subsequent access with proper synchronization.

Specified by:

fullMessage in interface SMFWarningType

Specified by:

fullMessage in interface SMFParseWarningType

Returns:

A lazily initialized value of the l.name attribute

of

public static SMFParseWarning of(com.io7m.jlexing.core.LexicalPosition<URI> lexical,
                                 String message,
                                 Optional<Exception> exception)

Construct a new immutable SMFParseWarning instance.

Parameters:

lexical - The value for the lexical attribute

message - The value for the message attribute

exception - The value for the exception attribute

Returns:

An immutable SMFParseWarning instance

copyOf

public static SMFParseWarning copyOf(SMFParseWarningType instance)

Creates an immutable copy of a SMFParseWarningType 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 SMFParseWarning instance

builder

public static SMFParseWarning.Builder builder()

Creates a builder for SMFParseWarning.

Returns:

A new SMFParseWarning builder