Package com.io7m.jnoisetype.api

Class NTGeneratorOperatorIndex

java.lang.Object

com.io7m.jnoisetype.api.NTGeneratorOperatorIndex

All Implemented Interfaces:

NTGeneratorOperatorIndexType, java.lang.Comparable<NTGeneratorOperatorIndexType>

public final class NTGeneratorOperatorIndex
extends java.lang.Object
implements NTGeneratorOperatorIndexType

The valid values for generator operator values.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NTGeneratorOperatorIndex.Builder	builder()	Creates a builder for NTGeneratorOperatorIndex.
static NTGeneratorOperatorIndex	copyOf(NTGeneratorOperatorIndexType instance)	Creates an immutable copy of a NTGeneratorOperatorIndexType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of NTGeneratorOperatorIndex that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: value.
static NTGeneratorOperatorIndex	of(int value)	Construct a new immutable NTGeneratorOperatorIndex instance.
java.lang.String	toString()	Prints the immutable value NTGeneratorOperatorIndex with attribute values.
int	value()
NTGeneratorOperatorIndex	withValue(int value)	Copy the current immutable object by setting a value for the value attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.jnoisetype.api.NTGeneratorOperatorIndexType

asUnsigned16, checkPreconditions, compareTo

Method Detail

value

public int value()

Specified by:

value in interface NTGeneratorOperatorIndexType

Returns:

The raw value in the range [0, 0xffff]

withValue

public final NTGeneratorOperatorIndex withValue(int value)

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

Parameters:

value - A new value for value

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of NTGeneratorOperatorIndex 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: value.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value NTGeneratorOperatorIndex with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static NTGeneratorOperatorIndex of(int value)

Construct a new immutable NTGeneratorOperatorIndex instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable NTGeneratorOperatorIndex instance

copyOf

public static NTGeneratorOperatorIndex copyOf(NTGeneratorOperatorIndexType instance)

Creates an immutable copy of a NTGeneratorOperatorIndexType 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 NTGeneratorOperatorIndex instance

builder

public static NTGeneratorOperatorIndex.Builder builder()

Creates a builder for NTGeneratorOperatorIndex.

 NTGeneratorOperatorIndex.builder()
    .setValue(int) // required value
    .build();
 

Returns:

A new NTGeneratorOperatorIndex builder