Class PAreaSizeF<S>
java.lang.Object
com.io7m.jregions.core.parameterized.sizes.PAreaSizeF<S>
- Type Parameters:
S
- A phantom type parameter indicating the coordinate space of the area
- All Implemented Interfaces:
PAreaSizeFType<S>
,AreaSizeValuesFType
The size of an area with
float
coordinates.-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic <S> PAreaSizeF.Builder<S>
builder()
Creates a builder forPAreaSizeF
.static <S> PAreaSizeF<S>
copyOf
(PAreaSizeFType<S> instance) Creates an immutable copy of aPAreaSizeFType
value.boolean
This instance is equal to all instances ofPAreaSizeF
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:sizeX
,sizeY
.float
height()
Deprecated.static <S> PAreaSizeF<S>
of
(float sizeX, float sizeY) Construct a new immutablePAreaSizeF
instance.float
sizeX()
float
sizeY()
toString()
Prints the immutable valuePAreaSizeF
with attribute values.float
width()
Deprecated.UsesizeX()
final PAreaSizeF<S>
withSizeX
(float value) Copy the current immutable object by setting a value for thesizeX
attribute.final PAreaSizeF<S>
withSizeY
(float value) Copy the current immutable object by setting a value for thesizeY
attribute.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.io7m.jregions.core.parameterized.sizes.PAreaSizeFType
checkPreconditions
-
Method Details
-
width
Deprecated.UsesizeX()
- Specified by:
width
in interfaceAreaSizeValuesFType
- Returns:
- The width of the area
-
height
Deprecated.UsesizeY()
- Specified by:
height
in interfaceAreaSizeValuesFType
- Returns:
- The height of the area
-
sizeX
public float sizeX()- Specified by:
sizeX
in interfaceAreaSizeValuesFType
- Specified by:
sizeX
in interfacePAreaSizeFType<S>
- Returns:
- The value of the
sizeX
attribute
-
sizeY
public float sizeY()- Specified by:
sizeY
in interfaceAreaSizeValuesFType
- Specified by:
sizeY
in interfacePAreaSizeFType<S>
- Returns:
- The value of the
sizeY
attribute
-
withSizeX
Copy the current immutable object by setting a value for thesizeX
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for sizeX- Returns:
- A modified copy of the
this
object
-
withSizeY
Copy the current immutable object by setting a value for thesizeY
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for sizeY- Returns:
- A modified copy of the
this
object
-
equals
This instance is equal to all instances ofPAreaSizeF
that have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:sizeX
,sizeY
. -
toString
Prints the immutable valuePAreaSizeF
with attribute values. -
of
Construct a new immutablePAreaSizeF
instance.- Type Parameters:
S
- generic parameter S- Parameters:
sizeX
- The value for thesizeX
attributesizeY
- The value for thesizeY
attribute- Returns:
- An immutable PAreaSizeF instance
-
copyOf
Creates an immutable copy of aPAreaSizeFType
value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.- Type Parameters:
S
- generic parameter S- Parameters:
instance
- The instance to copy- Returns:
- A copied immutable PAreaSizeF instance
-
builder
Creates a builder forPAreaSizeF
.PAreaSizeF.<S>builder() .setSizeX(float) // required
sizeX
.setSizeY(float) // requiredsizeY
.build();- Type Parameters:
S
- generic parameter S- Returns:
- A new PAreaSizeF builder
-
sizeY()