Class Vector3I
java.lang.Object
com.io7m.jtensors.core.unparameterized.vectors.Vector3I
- All Implemented Interfaces:
Vector3IType
,VectorReadable2IType
,VectorReadable3IType
,VectorComputationalType
public final class Vector3I extends java.lang.Object implements Vector3IType
The type of 3D
int
-typed vectors.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Vector3I.Builder
Builds instances of typeVector3I
. -
Method Summary
Modifier and Type Method Description static Vector3I.Builder
builder()
Creates a builder forVector3I
.static Vector3I
copyOf(Vector3IType instance)
Creates an immutable copy of aVector3IType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofVector3I
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:x
,y
,z
.static Vector3I
of(int x, int y, int z)
Construct a new immutableVector3I
instance.java.lang.String
toString()
Prints the immutable valueVector3I
with attribute values.Vector3I
withX(int value)
Copy the current immutable object by setting a value for thex
attribute.Vector3I
withY(int value)
Copy the current immutable object by setting a value for they
attribute.Vector3I
withZ(int value)
Copy the current immutable object by setting a value for thez
attribute.int
x()
int
y()
int
z()
-
Method Details
-
x
public int x()- Specified by:
x
in interfaceVector3IType
- Specified by:
x
in interfaceVectorReadable2IType
- Returns:
- The value of the
x
attribute
-
y
public int y()- Specified by:
y
in interfaceVector3IType
- Specified by:
y
in interfaceVectorReadable2IType
- Returns:
- The value of the
y
attribute
-
z
public int z()- Specified by:
z
in interfaceVector3IType
- Specified by:
z
in interfaceVectorReadable3IType
- Returns:
- The value of the
z
attribute
-
withX
Copy the current immutable object by setting a value for thex
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for x- Returns:
- A modified copy of the
this
object
-
withY
Copy the current immutable object by setting a value for they
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for y- Returns:
- A modified copy of the
this
object
-
withZ
Copy the current immutable object by setting a value for thez
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for z- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(java.lang.Object another)This instance is equal to all instances ofVector3I
that have equal attribute values.- Overrides:
equals
in classjava.lang.Object
- Returns:
true
ifthis
is equal toanother
instance
-
hashCode
public int hashCode()Computes a hash code from attributes:x
,y
,z
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()Prints the immutable valueVector3I
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
Construct a new immutableVector3I
instance.- Parameters:
x
- The value for thex
attributey
- The value for they
attributez
- The value for thez
attribute- Returns:
- An immutable Vector3I instance
-
copyOf
Creates an immutable copy of aVector3IType
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 Vector3I instance
-
builder
Creates a builder forVector3I
.Vector3I.builder() .setX(int) // required
x
.setY(int) // requiredy
.setZ(int) // requiredz
.build();- Returns:
- A new Vector3I builder
-