com.io7m.jspatial.api.quadtrees

Class QuadTreeConfigurationL

java.lang.Object

com.io7m.jspatial.api.quadtrees.QuadTreeConfigurationL

All Implemented Interfaces:

QuadTreeConfigurationLType

@Generated(value={"Immutables.generator","QuadTreeConfigurationLType"})
public final class QuadTreeConfigurationL
extends Object
implements QuadTreeConfigurationLType

The type of long integer quadtree configurations.

Since:

3.0.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
com.io7m.jregions.core.unparameterized.areas.AreaL	area()
static QuadTreeConfigurationL.Builder	builder() Creates a builder for QuadTreeConfigurationL.
static QuadTreeConfigurationL	copyOf(QuadTreeConfigurationLType instance) Creates an immutable copy of a QuadTreeConfigurationLType value.
boolean	equals(Object another) This instance is equal to all instances of QuadTreeConfigurationL that have equal attribute values.
int	hashCode() Computes a hash code from attributes: area, minimumQuadrantWidth, minimumQuadrantHeight, trimOnRemove.
long	minimumQuadrantHeight()
long	minimumQuadrantWidth()
static QuadTreeConfigurationL	of(com.io7m.jregions.core.unparameterized.areas.AreaL area, long minimumQuadrantWidth, long minimumQuadrantHeight, boolean trimOnRemove) Construct a new immutable QuadTreeConfigurationL instance.
String	toString() Prints the immutable value QuadTreeConfigurationL with attribute values.
boolean	trimOnRemove()
QuadTreeConfigurationL	withArea(com.io7m.jregions.core.unparameterized.areas.AreaL value) Copy the current immutable object by setting a value for the area attribute.
QuadTreeConfigurationL	withMinimumQuadrantHeight(long value) Copy the current immutable object by setting a value for the minimumQuadrantHeight attribute.
QuadTreeConfigurationL	withMinimumQuadrantWidth(long value) Copy the current immutable object by setting a value for the minimumQuadrantWidth attribute.
QuadTreeConfigurationL	withTrimOnRemove(boolean value) Copy the current immutable object by setting a value for the trimOnRemove attribute.

Methods inherited from class java.lang.Object

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

Method Detail

area

public com.io7m.jregions.core.unparameterized.areas.AreaL area()

Specified by:

area in interface QuadTreeConfigurationLType

Returns:

The maximum bounding area of the tree

minimumQuadrantWidth

public long minimumQuadrantWidth()

Specified by:

minimumQuadrantWidth in interface QuadTreeConfigurationLType

Returns:

The minimum width of quadrants (must be >= 2)

minimumQuadrantHeight

public long minimumQuadrantHeight()

Specified by:

minimumQuadrantHeight in interface QuadTreeConfigurationLType

Returns:

The minimum height of quadrants (must be >= 2)

trimOnRemove

public boolean trimOnRemove()

Specified by:

trimOnRemove in interface QuadTreeConfigurationLType

Returns:

true iff the implementation should attempt to trim empty leaf nodes when an item is removed

withArea

public final QuadTreeConfigurationL withArea(com.io7m.jregions.core.unparameterized.areas.AreaL value)

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

Parameters:

value - A new value for area

Returns:

A modified copy of the this object

withMinimumQuadrantWidth

public final QuadTreeConfigurationL withMinimumQuadrantWidth(long value)

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

Parameters:

value - A new value for minimumQuadrantWidth

Returns:

A modified copy of the this object

withMinimumQuadrantHeight

public final QuadTreeConfigurationL withMinimumQuadrantHeight(long value)

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

Parameters:

value - A new value for minimumQuadrantHeight

Returns:

A modified copy of the this object

withTrimOnRemove

public final QuadTreeConfigurationL withTrimOnRemove(boolean value)

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

Parameters:

value - A new value for trimOnRemove

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of QuadTreeConfigurationL that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: area, minimumQuadrantWidth, minimumQuadrantHeight, trimOnRemove.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value QuadTreeConfigurationL with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static QuadTreeConfigurationL of(com.io7m.jregions.core.unparameterized.areas.AreaL area,
                                        long minimumQuadrantWidth,
                                        long minimumQuadrantHeight,
                                        boolean trimOnRemove)

Construct a new immutable QuadTreeConfigurationL instance.

Parameters:

area - The value for the area attribute

minimumQuadrantWidth - The value for the minimumQuadrantWidth attribute

minimumQuadrantHeight - The value for the minimumQuadrantHeight attribute

trimOnRemove - The value for the trimOnRemove attribute

Returns:

An immutable QuadTreeConfigurationL instance

copyOf

public static QuadTreeConfigurationL copyOf(QuadTreeConfigurationLType instance)

Creates an immutable copy of a QuadTreeConfigurationLType 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 QuadTreeConfigurationL instance

builder

public static QuadTreeConfigurationL.Builder builder()

Creates a builder for QuadTreeConfigurationL.

Returns:

A new QuadTreeConfigurationL builder