com.io7m.jpra.model.names

Class PackageNameUnqualified

java.lang.Object

com.io7m.jpra.model.names.PackageNameUnqualified

All Implemented Interfaces:

ModelElementType

@Immutable
public final class PackageNameUnqualified
extends Object
implements ModelElementType

An unqualified package name.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	PATTERN The pattern that defines a valid package name.

Constructor Summary

Constructors

Constructor and Description
PackageNameUnqualified(Optional<com.io7m.jlexing.core.ImmutableLexicalPositionType<Path>> in_lex, String in_value) Construct a package name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Optional<com.io7m.jlexing.core.ImmutableLexicalPositionType<Path>>	getLexicalInformation() Fetch the lexical information for the element.
String	getValue()
int	hashCode()
static PackageNameUnqualified	of(String value) Construct a name.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN

public static final Pattern PATTERN

The pattern that defines a valid package name.

Constructor Detail

PackageNameUnqualified

public PackageNameUnqualified(Optional<com.io7m.jlexing.core.ImmutableLexicalPositionType<Path>> in_lex,
                              String in_value)

Construct a package name.

Parameters:

in_lex - The lexical information for the name

in_value - The raw string value

Method Detail

of

public static PackageNameUnqualified of(String value)
                                 throws org.valid4j.exceptions.RequireViolation

Construct a name.

Parameters:

value - The raw string value

Returns:

A new name, if valid

Throws:

org.valid4j.exceptions.RequireViolation - If the name is not valid

toString

public String toString()

Overrides:

toString in class Object

getValue

public String getValue()

Returns:

The raw package name

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getLexicalInformation

public Optional<com.io7m.jlexing.core.ImmutableLexicalPositionType<Path>> getLexicalInformation()

Description copied from interface: ModelElementType

Fetch the lexical information for the element. This is used to localize error messages to a position in a file when referring to specific elements.

Specified by:

getLexicalInformation in interface ModelElementType

Returns:

The original lexical information, if any