Package 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 java.lang.ObjectBuilds instances of typeQuadTreeConfigurationI. Initialize attributes and then invoke thebuild()method to create an immutable instance.Builderis not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description QuadTreeConfigurationIbuild()Builds a newQuadTreeConfigurationI.QuadTreeConfigurationI.Builderfrom(QuadTreeConfigurationIType instance)Fill a builder with attribute values from the providedQuadTreeConfigurationITypeinstance.QuadTreeConfigurationI.BuildersetArea(com.io7m.jregions.core.unparameterized.areas.AreaI area)Initializes the value for theareaattribute.QuadTreeConfigurationI.BuildersetMinimumQuadrantHeight(int minimumQuadrantHeight)Initializes the value for theminimumQuadrantHeightattribute.QuadTreeConfigurationI.BuildersetMinimumQuadrantWidth(int minimumQuadrantWidth)Initializes the value for theminimumQuadrantWidthattribute.QuadTreeConfigurationI.BuildersetTrimOnRemove(boolean trimOnRemove)Initializes the value for thetrimOnRemoveattribute.
-
-
-
Method Detail
-
from
public final QuadTreeConfigurationI.Builder from(QuadTreeConfigurationIType instance)
Fill a builder with attribute values from the providedQuadTreeConfigurationITypeinstance. 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:
thisbuilder for use in a chained invocation
-
setArea
public final QuadTreeConfigurationI.Builder setArea(com.io7m.jregions.core.unparameterized.areas.AreaI area)
Initializes the value for theareaattribute.- Parameters:
area- The value for area- Returns:
thisbuilder for use in a chained invocation
-
setMinimumQuadrantWidth
public final QuadTreeConfigurationI.Builder setMinimumQuadrantWidth(int minimumQuadrantWidth)
Initializes the value for theminimumQuadrantWidthattribute.If not set, this attribute will have a default value as returned by the initializer of
minimumQuadrantWidth.- Parameters:
minimumQuadrantWidth- The value for minimumQuadrantWidth- Returns:
thisbuilder for use in a chained invocation
-
setMinimumQuadrantHeight
public final QuadTreeConfigurationI.Builder setMinimumQuadrantHeight(int minimumQuadrantHeight)
Initializes the value for theminimumQuadrantHeightattribute.If not set, this attribute will have a default value as returned by the initializer of
minimumQuadrantHeight.- Parameters:
minimumQuadrantHeight- The value for minimumQuadrantHeight- Returns:
thisbuilder for use in a chained invocation
-
setTrimOnRemove
public final QuadTreeConfigurationI.Builder setTrimOnRemove(boolean trimOnRemove)
Initializes the value for thetrimOnRemoveattribute.If not set, this attribute will have a default value as returned by the initializer of
trimOnRemove.- Parameters:
trimOnRemove- The value for trimOnRemove- Returns:
thisbuilder for use in a chained invocation
-
build
public QuadTreeConfigurationI build()
Builds a newQuadTreeConfigurationI.- Returns:
- An immutable instance of QuadTreeConfigurationI
- Throws:
java.lang.IllegalStateException- if any required attributes are missing
-
-