Package com.io7m.jspatial.api.quadtrees
Class QuadTreeConfigurationL.Builder
- java.lang.Object
-
- com.io7m.jspatial.api.quadtrees.QuadTreeConfigurationL.Builder
-
- Enclosing class:
- QuadTreeConfigurationL
public static final class QuadTreeConfigurationL.Builder extends java.lang.ObjectBuilds instances of typeQuadTreeConfigurationL. 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 QuadTreeConfigurationLbuild()Builds a newQuadTreeConfigurationL.QuadTreeConfigurationL.Builderfrom(QuadTreeConfigurationLType instance)Fill a builder with attribute values from the providedQuadTreeConfigurationLTypeinstance.QuadTreeConfigurationL.BuildersetArea(com.io7m.jregions.core.unparameterized.areas.AreaL area)Initializes the value for theareaattribute.QuadTreeConfigurationL.BuildersetMinimumQuadrantHeight(long minimumQuadrantHeight)Initializes the value for theminimumQuadrantHeightattribute.QuadTreeConfigurationL.BuildersetMinimumQuadrantWidth(long minimumQuadrantWidth)Initializes the value for theminimumQuadrantWidthattribute.QuadTreeConfigurationL.BuildersetTrimOnRemove(boolean trimOnRemove)Initializes the value for thetrimOnRemoveattribute.
-
-
-
Method Detail
-
from
public final QuadTreeConfigurationL.Builder from(QuadTreeConfigurationLType instance)
Fill a builder with attribute values from the providedQuadTreeConfigurationLTypeinstance. 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 QuadTreeConfigurationL.Builder setArea(com.io7m.jregions.core.unparameterized.areas.AreaL area)
Initializes the value for theareaattribute.- Parameters:
area- The value for area- Returns:
thisbuilder for use in a chained invocation
-
setMinimumQuadrantWidth
public final QuadTreeConfigurationL.Builder setMinimumQuadrantWidth(long 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 QuadTreeConfigurationL.Builder setMinimumQuadrantHeight(long 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 QuadTreeConfigurationL.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 QuadTreeConfigurationL build()
Builds a newQuadTreeConfigurationL.- Returns:
- An immutable instance of QuadTreeConfigurationL
- Throws:
java.lang.IllegalStateException- if any required attributes are missing
-
-