Package com.io7m.jsx.api.lexer

Class JSXLexerConfiguration

java.lang.Object

com.io7m.jsx.api.lexer.JSXLexerConfiguration

All Implemented Interfaces:

JSXLexerConfigurationType

public final class JSXLexerConfiguration
extends java.lang.Object
implements JSXLexerConfigurationType

The type of lexer configurations.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static JSXLexerConfiguration.Builder	builder()	Creates a builder for JSXLexerConfiguration.
java.util.EnumSet<JSXLexerComment>	comments()
static JSXLexerConfiguration	copyOf(JSXLexerConfigurationType instance)	Creates an immutable copy of a JSXLexerConfigurationType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of JSXLexerConfiguration that have equal attribute values.
java.util.Optional<java.nio.file.Path>	file()
int	hashCode()	Computes a hash code from attributes: squareBrackets, newlinesInQuotedStrings, file, comments, startAtLine.
boolean	newlinesInQuotedStrings()
static JSXLexerConfiguration	of(boolean squareBrackets, boolean newlinesInQuotedStrings, java.util.Optional<? extends java.nio.file.Path> file, java.util.EnumSet<JSXLexerComment> comments, int startAtLine)	Construct a new immutable JSXLexerConfiguration instance.
boolean	squareBrackets()
int	startAtLine()
java.lang.String	toString()	Prints the immutable value JSXLexerConfiguration with attribute values.
JSXLexerConfiguration	withComments(java.util.EnumSet<JSXLexerComment> value)	Copy the current immutable object by setting a value for the comments attribute.
JSXLexerConfiguration	withFile(java.nio.file.Path value)	Copy the current immutable object by setting a present value for the optional file attribute.
JSXLexerConfiguration	withFile(java.util.Optional<? extends java.nio.file.Path> optional)	Copy the current immutable object by setting an optional value for the file attribute.
JSXLexerConfiguration	withNewlinesInQuotedStrings(boolean value)	Copy the current immutable object by setting a value for the newlinesInQuotedStrings attribute.
JSXLexerConfiguration	withSquareBrackets(boolean value)	Copy the current immutable object by setting a value for the squareBrackets attribute.
JSXLexerConfiguration	withStartAtLine(int value)	Copy the current immutable object by setting a value for the startAtLine attribute.

Methods inherited from class java.lang.Object

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

Method Detail

squareBrackets

public boolean squareBrackets()

Specified by:

squareBrackets in interface JSXLexerConfigurationType

Returns:

true iff square brackets are allowed to denote lists

newlinesInQuotedStrings

public boolean newlinesInQuotedStrings()

Specified by:

newlinesInQuotedStrings in interface JSXLexerConfigurationType

Returns:

true iff newlines are allowed in quoted strings

file

public java.util.Optional<java.nio.file.Path> file()

Specified by:

file in interface JSXLexerConfigurationType

Returns:

The file name that will be used in lexical information, if any

comments

public java.util.EnumSet<JSXLexerComment> comments()

Specified by:

comments in interface JSXLexerConfigurationType

Returns:

The string(s) used to start line comments

startAtLine

public int startAtLine()

Specified by:

startAtLine in interface JSXLexerConfigurationType

Returns:

The starting line number (for lexical information)

withSquareBrackets

public final JSXLexerConfiguration withSquareBrackets(boolean value)

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

Parameters:

value - A new value for squareBrackets

Returns:

A modified copy of the this object

withNewlinesInQuotedStrings

public final JSXLexerConfiguration withNewlinesInQuotedStrings(boolean value)

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

Parameters:

value - A new value for newlinesInQuotedStrings

Returns:

A modified copy of the this object

withFile

public final JSXLexerConfiguration withFile(java.nio.file.Path value)

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

Parameters:

value - The value for file

Returns:

A modified copy of this object

withFile

public final JSXLexerConfiguration withFile(java.util.Optional<? extends java.nio.file.Path> optional)

Copy the current immutable object by setting an optional value for the file 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 file

Returns:

A modified copy of this object

withComments

public final JSXLexerConfiguration withComments(java.util.EnumSet<JSXLexerComment> value)

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

Parameters:

value - A new value for comments

Returns:

A modified copy of the this object

withStartAtLine

public final JSXLexerConfiguration withStartAtLine(int value)

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

Parameters:

value - A new value for startAtLine

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

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

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: squareBrackets, newlinesInQuotedStrings, file, comments, startAtLine.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value JSXLexerConfiguration with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static JSXLexerConfiguration of(boolean squareBrackets,
                                       boolean newlinesInQuotedStrings,
                                       java.util.Optional<? extends java.nio.file.Path> file,
                                       java.util.EnumSet<JSXLexerComment> comments,
                                       int startAtLine)

Construct a new immutable JSXLexerConfiguration instance.

Parameters:

squareBrackets - The value for the squareBrackets attribute

newlinesInQuotedStrings - The value for the newlinesInQuotedStrings attribute

file - The value for the file attribute

comments - The value for the comments attribute

startAtLine - The value for the startAtLine attribute

Returns:

An immutable JSXLexerConfiguration instance

copyOf

public static JSXLexerConfiguration copyOf(JSXLexerConfigurationType instance)

Creates an immutable copy of a JSXLexerConfigurationType 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 JSXLexerConfiguration instance

builder

public static JSXLexerConfiguration.Builder builder()

Creates a builder for JSXLexerConfiguration.

Returns:

A new JSXLexerConfiguration builder