com.io7m.jspatial.api.quadtrees

Class QuadTreeConfigurationI.Builder

java.lang.Object

com.io7m.jspatial.api.quadtrees.QuadTreeConfigurationI.Builder

Enclosing class:

QuadTreeConfigurationI

public static final class QuadTreeConfigurationI.Builder
extends Object

Builds instances of type QuadTreeConfigurationI. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
QuadTreeConfigurationI	build() Builds a new QuadTreeConfigurationI.
QuadTreeConfigurationI.Builder	from(QuadTreeConfigurationIType instance) Fill a builder with attribute values from the provided QuadTreeConfigurationIType instance.
QuadTreeConfigurationI.Builder	setArea(com.io7m.jregions.core.unparameterized.areas.AreaI area) Initializes the value for the area attribute.
QuadTreeConfigurationI.Builder	setMinimumQuadrantHeight(int minimumQuadrantHeight) Initializes the value for the minimumQuadrantHeight attribute.
QuadTreeConfigurationI.Builder	setMinimumQuadrantWidth(int minimumQuadrantWidth) Initializes the value for the minimumQuadrantWidth attribute.
QuadTreeConfigurationI.Builder	setTrimOnRemove(boolean trimOnRemove) Initializes the value for the trimOnRemove attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public final QuadTreeConfigurationI.Builder from(QuadTreeConfigurationIType instance)

Fill a builder with attribute values from the provided QuadTreeConfigurationIType instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setArea

public final QuadTreeConfigurationI.Builder setArea(com.io7m.jregions.core.unparameterized.areas.AreaI area)

Initializes the value for the area attribute.

Parameters:

area - The value for area

Returns:

this builder for use in a chained invocation

setMinimumQuadrantWidth

public final QuadTreeConfigurationI.Builder setMinimumQuadrantWidth(int minimumQuadrantWidth)

Initializes the value for the minimumQuadrantWidth attribute.

If not set, this attribute will have a default value as returned by the initializer of minimumQuadrantWidth.

Parameters:

minimumQuadrantWidth - The value for minimumQuadrantWidth

Returns:

this builder for use in a chained invocation

setMinimumQuadrantHeight

public final QuadTreeConfigurationI.Builder setMinimumQuadrantHeight(int minimumQuadrantHeight)

Initializes the value for the minimumQuadrantHeight attribute.

If not set, this attribute will have a default value as returned by the initializer of minimumQuadrantHeight.

Parameters:

minimumQuadrantHeight - The value for minimumQuadrantHeight

Returns:

this builder for use in a chained invocation

setTrimOnRemove

public final QuadTreeConfigurationI.Builder setTrimOnRemove(boolean trimOnRemove)

Initializes the value for the trimOnRemove attribute.

If not set, this attribute will have a default value as returned by the initializer of trimOnRemove.

Parameters:

trimOnRemove - The value for trimOnRemove

Returns:

this builder for use in a chained invocation

build

public QuadTreeConfigurationI build()

Builds a new QuadTreeConfigurationI.

Returns:

An immutable instance of QuadTreeConfigurationI

Throws:

IllegalStateException - if any required attributes are missing