com.io7m.jpra.runtime.java

Class JPRATypeModel.JPRAString

java.lang.Object

com.io7m.jpra.runtime.java.JPRATypeModelType.JPRAStringType

com.io7m.jpra.runtime.java.JPRATypeModel.JPRAString

All Implemented Interfaces:

JPRATypeModelType.JPRATypeType

Enclosing class:

JPRATypeModel

public static final class JPRATypeModel.JPRAString
extends JPRATypeModelType.JPRAStringType

Immutable implementation of JPRATypeModelType.JPRAStringType.

Use the static factory method to create immutable instances: JPRATypeModel.JPRAString.of().

Method Summary

Modifier and Type	Method and Description
static JPRATypeModel.JPRAString	copyOf(JPRATypeModelType.JPRAStringType instance) Creates an immutable copy of a JPRATypeModelType.JPRAStringType value.
String	encoding()
boolean	equals(Object another) This instance is equal to all instances of JPRAString that have equal attribute values.
int	hashCode() Returns a precomputed-on-construction hash code from attributes: length, encoding.
int	length()
static JPRATypeModel.JPRAString	of(int length, String encoding) Construct a new immutable JPRAString instance.
String	toString() Prints the immutable value JPRAString with attribute values.
JPRATypeModel.JPRAString	withEncoding(String encoding) Copy the current immutable object by setting a value for the encoding attribute.
JPRATypeModel.JPRAString	withLength(int length) Copy the current immutable object by setting a value for the length attribute.

Methods inherited from class com.io7m.jpra.runtime.java.JPRATypeModelType.JPRAStringType

matchType

Methods inherited from class java.lang.Object

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

Method Detail

length

public int length()

Returns:

The value of the length attribute

encoding

public String encoding()

Returns:

The value of the encoding attribute

withLength

public final JPRATypeModel.JPRAString withLength(int length)

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

Parameters:

length - A new value for length

Returns:

A modified copy of the this object

withEncoding

public final JPRATypeModel.JPRAString withEncoding(String encoding)

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

Parameters:

encoding - A new value for encoding

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

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

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Returns a precomputed-on-construction hash code from attributes: length, encoding.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value JPRAString with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static JPRATypeModel.JPRAString of(int length,
                                          String encoding)

Construct a new immutable JPRAString instance.

Parameters:

length - The value for the length attribute

encoding - The value for the encoding attribute

Returns:

An immutable JPRAString instance

copyOf

public static JPRATypeModel.JPRAString copyOf(JPRATypeModelType.JPRAStringType instance)

Creates an immutable copy of a JPRATypeModelType.JPRAStringType 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 JPRAString instance