com.io7m.jpra.runtime.java

Class JPRATypeModel.JPRAMatrix

java.lang.Object

com.io7m.jpra.runtime.java.JPRATypeModelType.JPRAMatrixType

com.io7m.jpra.runtime.java.JPRATypeModel.JPRAMatrix

All Implemented Interfaces:

JPRATypeModelType.JPRATypeType

Enclosing class:

JPRATypeModel

public static final class JPRATypeModel.JPRAMatrix
extends JPRATypeModelType.JPRAMatrixType

Immutable implementation of JPRATypeModelType.JPRAMatrixType.

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

Method Summary

Modifier and Type	Method and Description
static JPRATypeModel.JPRAMatrix	copyOf(JPRATypeModelType.JPRAMatrixType instance) Creates an immutable copy of a JPRATypeModelType.JPRAMatrixType value.
JPRATypeModelType.JPRAScalarType	elementType()
boolean	equals(Object another) This instance is equal to all instances of JPRAMatrix that have equal attribute values.
int	hashCode() Returns a precomputed-on-construction hash code from attributes: width, height, elementType.
int	height()
static JPRATypeModel.JPRAMatrix	of(int width, int height, JPRATypeModelType.JPRAScalarType elementType) Construct a new immutable JPRAMatrix instance.
String	toString() Prints the immutable value JPRAMatrix... with all non-generated and non-auxiliary attribute values.
int	width()
JPRATypeModel.JPRAMatrix	withElementType(JPRATypeModelType.JPRAScalarType value) Copy the current immutable object by setting a value for the elementType attribute.
JPRATypeModel.JPRAMatrix	withHeight(int value) Copy the current immutable object by setting a value for the height attribute.
JPRATypeModel.JPRAMatrix	withWidth(int value) Copy the current immutable object by setting a value for the width attribute.

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

matchType

Methods inherited from class java.lang.Object

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

Method Detail

width

public int width()

Returns:

The value of the width attribute

height

public int height()

Returns:

The value of the height attribute

elementType

public JPRATypeModelType.JPRAScalarType elementType()

Returns:

The value of the elementType attribute

withWidth

public final JPRATypeModel.JPRAMatrix withWidth(int value)

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

Parameters:

value - A new value for width

Returns:

A modified copy of the this object

withHeight

public final JPRATypeModel.JPRAMatrix withHeight(int value)

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

Parameters:

value - A new value for height

Returns:

A modified copy of the this object

withElementType

public final JPRATypeModel.JPRAMatrix withElementType(JPRATypeModelType.JPRAScalarType value)

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

Parameters:

value - A new value for elementType

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of JPRAMatrix 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: width, height, elementType.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value JPRAMatrix... with all non-generated and non-auxiliary attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static JPRATypeModel.JPRAMatrix of(int width,
                                          int height,
                                          JPRATypeModelType.JPRAScalarType elementType)

Construct a new immutable JPRAMatrix instance.

Parameters:

width - The value for the width attribute

height - The value for the height attribute

elementType - The value for the elementType attribute

Returns:

An immutable JPRAMatrix instance

copyOf

public static JPRATypeModel.JPRAMatrix copyOf(JPRATypeModelType.JPRAMatrixType instance)

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