Class Vector2I
java.lang.Object
com.io7m.jtensors.core.unparameterized.vectors.Vector2I
- All Implemented Interfaces:
Vector2IType
,VectorReadable2IType
,VectorComputationalType
public final class Vector2I extends java.lang.Object implements Vector2IType
The type of 2D
int
-typed vectors.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Vector2I.Builder
Builds instances of typeVector2I
. -
Method Summary
Modifier and Type Method Description static Vector2I.Builder
builder()
Creates a builder forVector2I
.static Vector2I
copyOf(Vector2IType instance)
Creates an immutable copy of aVector2IType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofVector2I
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:x
,y
.static Vector2I
of(int x, int y)
Construct a new immutableVector2I
instance.java.lang.String
toString()
Prints the immutable valueVector2I
with attribute values.Vector2I
withX(int value)
Copy the current immutable object by setting a value for thex
attribute.Vector2I
withY(int value)
Copy the current immutable object by setting a value for they
attribute.int
x()
int
y()
-
Method Details
-
x
public int x()- Specified by:
x
in interfaceVector2IType
- Specified by:
x
in interfaceVectorReadable2IType
- Returns:
- The value of the
x
attribute
-
y
public int y()- Specified by:
y
in interfaceVector2IType
- Specified by:
y
in interfaceVectorReadable2IType
- Returns:
- The value of the
y
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
-
equals
public boolean equals(java.lang.Object another)This instance is equal to all instances ofVector2I
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
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()Prints the immutable valueVector2I
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
Construct a new immutableVector2I
instance.- Parameters:
x
- The value for thex
attributey
- The value for they
attribute- Returns:
- An immutable Vector2I instance
-
copyOf
Creates an immutable copy of aVector2IType
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 Vector2I instance
-
builder
Creates a builder forVector2I
.Vector2I.builder() .setX(int) // required
x
.setY(int) // requiredy
.build();- Returns:
- A new Vector2I builder
-