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