BoxMutable (io7m-jboxes-documentation 0.1.0 API)

java.lang.Object
- com.io7m.jboxes.core.BoxMutable<S>

Type Parameters:

S - generic parameter S

All Implemented Interfaces:

BoxType<S>
```
@Generated(value={"Modifiables.generator","BoxType<S>"})
public final class BoxMutable<S>
extends Object
implements BoxType<S>
```
A modifiable implementation of the BoxType type.
Use the create() static factory methods to create new instances. Use the toImmutable() method to convert to canonical immutable instances.
BoxMutable is not thread-safe

See Also:

Box

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BoxMutable<S>`	`clear()` Clears the object by setting all attributes to their initial values.
`static <S> BoxMutable<S>`	`create()` Construct a modifiable instance of `BoxType`.
`static <S> BoxMutable<S>`	`create(int minimumX, int maximumX, int minimumY, int maximumY)` Construct a modifiable instance of `BoxType`.
`boolean`	`equals(Object another)` This instance is equal to all instances of `BoxMutable` that have equal attribute values.
`BoxMutable<S>`	`from(BoxType<S> instance)` Fill this modifiable instance with attribute values from the provided `BoxType` instance.
`int`	`hashCode()` Computes a hash code from attributes: `minimumX`, `maximumX`, `minimumY`, `maximumY`.
`boolean`	`isInitialized()` Returns `true` if all required attributes are set, indicating that the object is initialized.
`int`	`maximumX()`
`boolean`	`maximumXIsSet()` Returns `true` if the required attribute `maximumX` is set.
`int`	`maximumY()`
`boolean`	`maximumYIsSet()` Returns `true` if the required attribute `maximumY` is set.
`int`	`minimumX()`
`boolean`	`minimumXIsSet()` Returns `true` if the required attribute `minimumX` is set.
`int`	`minimumY()`
`boolean`	`minimumYIsSet()` Returns `true` if the required attribute `minimumY` is set.
`BoxMutable<S>`	`setMaximumX(int maximumX)` Assigns a value to the `maximumX` attribute.
`BoxMutable<S>`	`setMaximumY(int maximumY)` Assigns a value to the `maximumY` attribute.
`BoxMutable<S>`	`setMinimumX(int minimumX)` Assigns a value to the `minimumX` attribute.
`BoxMutable<S>`	`setMinimumY(int minimumY)` Assigns a value to the `minimumY` attribute.
`Box<S>`	`toImmutable()` Converts to `Box`.
`String`	`toString()` Generates a string representation of this `BoxType`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.io7m.jboxes.core.BoxType
checkPreconditions, height, width

- Method Detail
  - create
```
public static <S> BoxMutable<S> create(int minimumX,
                                       int maximumX,
                                       int minimumY,
                                       int maximumY)
```
    Construct a modifiable instance of BoxType.
    
    Type Parameters:
    
    S - generic parameter S
    
    Parameters:
    
    minimumX - The value for the minimumX attribute
    
    maximumX - The value for the maximumX attribute
    
    minimumY - The value for the minimumY attribute
    
    maximumY - The value for the maximumY attribute
    
    Returns:
    
    A new modifiable instance
  - create
```
public static <S> BoxMutable<S> create()
```
    Construct a modifiable instance of BoxType.
    
    Type Parameters:
    
    S - generic parameter S
    
    Returns:
    
    A new modifiable instance
  - minimumX
```
public final int minimumX()
```
    Specified by:
    
    minimumX in interface BoxType<S>
    
    Returns:
    
    The value on the X axis of the left edge of the box (inclusive)
  - maximumX
```
public final int maximumX()
```
    Specified by:
    
    maximumX in interface BoxType<S>
    
    Returns:
    
    The value on the X axis of the right edge of the box (exclusive)
  - minimumY
```
public final int minimumY()
```
    Specified by:
    
    minimumY in interface BoxType<S>
    
    Returns:
    
    The value on the Y axis of the top edge of the box (inclusive)
  - maximumY
```
public final int maximumY()
```
    Specified by:
    
    maximumY in interface BoxType<S>
    
    Returns:
    
    The value on the Y axis of the bottom edge of the box (exclusive)
  - clear
```
public BoxMutable<S> clear()
```
    Clears the object by setting all attributes to their initial values.
    
    Returns:
    
    this for use in a chained invocation
  - from
```
public BoxMutable<S> from(BoxType<S> instance)
```
    Fill this modifiable instance with attribute values from the provided BoxType instance. Regular attribute values will be overridden, i.e. replaced with ones of an instance. Any of the instance's absent optional values will not be copied (will not override current values).
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this for use in a chained invocation
  - setMinimumX
```
public BoxMutable<S> setMinimumX(int minimumX)
```
    Assigns a value to the minimumX attribute.
    
    Parameters:
    
    minimumX - The value for minimumX
    
    Returns:
    
    this for use in a chained invocation
  - setMaximumX
```
public BoxMutable<S> setMaximumX(int maximumX)
```
    Assigns a value to the maximumX attribute.
    
    Parameters:
    
    maximumX - The value for maximumX
    
    Returns:
    
    this for use in a chained invocation
  - setMinimumY
```
public BoxMutable<S> setMinimumY(int minimumY)
```
    Assigns a value to the minimumY attribute.
    
    Parameters:
    
    minimumY - The value for minimumY
    
    Returns:
    
    this for use in a chained invocation
  - setMaximumY
```
public BoxMutable<S> setMaximumY(int maximumY)
```
    Assigns a value to the maximumY attribute.
    
    Parameters:
    
    maximumY - The value for maximumY
    
    Returns:
    
    this for use in a chained invocation
  - minimumXIsSet
```
public final boolean minimumXIsSet()
```
    Returns true if the required attribute minimumX is set.
    
    Returns:
    
    true if set
  - maximumXIsSet
```
public final boolean maximumXIsSet()
```
    Returns true if the required attribute maximumX is set.
    
    Returns:
    
    true if set
  - minimumYIsSet
```
public final boolean minimumYIsSet()
```
    Returns true if the required attribute minimumY is set.
    
    Returns:
    
    true if set
  - maximumYIsSet
```
public final boolean maximumYIsSet()
```
    Returns true if the required attribute maximumY is set.
    
    Returns:
    
    true if set
  - isInitialized
```
public final boolean isInitialized()
```
    Returns true if all required attributes are set, indicating that the object is initialized.
    
    Returns:
    
    true if set
  - toImmutable
```
public final Box<S> toImmutable()
```
    Converts to Box.
    
    Returns:
    
    An immutable instance of Box
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of BoxMutable that have equal attribute values. An uninitialized instance is equal only to itself.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: minimumX, maximumX, minimumY, maximumY.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Generates a string representation of this BoxType. If uninitialized, some attribute values may appear as question marks.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation

Class BoxMutable<S>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.io7m.jboxes.core.BoxType

Method Detail

create

create

minimumX

maximumX

minimumY

maximumY

clear

from

setMinimumX

setMaximumX

setMinimumY

setMaximumY

minimumXIsSet

maximumXIsSet

minimumYIsSet

maximumYIsSet

isInitialized

toImmutable

equals

hashCode

toString