com.io7m.jspatial.api.octtrees

Class OctTreeRaycastResultI.Builder<T>

java.lang.Object

com.io7m.jspatial.api.octtrees.OctTreeRaycastResultI.Builder<T>

Enclosing class:

OctTreeRaycastResultI<T>

public static final class OctTreeRaycastResultI.Builder<T>
extends Object

Builds instances of type OctTreeRaycastResultI. 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
OctTreeRaycastResultI<T>	build() Builds a new OctTreeRaycastResultI.
OctTreeRaycastResultI.Builder<T>	from(OctTreeRaycastResultIType<T> instance) Fill a builder with attribute values from the provided OctTreeRaycastResultIType instance.
OctTreeRaycastResultI.Builder<T>	setDistance(double distance) Initializes the value for the distance attribute.
OctTreeRaycastResultI.Builder<T>	setItem(T item) Initializes the value for the item attribute.
OctTreeRaycastResultI.Builder<T>	setVolume(com.io7m.jregions.core.unparameterized.volumes.VolumeI volume) Initializes the value for the volume attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final OctTreeRaycastResultI.Builder<T> from(OctTreeRaycastResultIType<T> instance)

Fill a builder with attribute values from the provided OctTreeRaycastResultIType 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

setDistance

public final OctTreeRaycastResultI.Builder<T> setDistance(double distance)

Initializes the value for the distance attribute.

Parameters:

distance - The value for distance

Returns:

this builder for use in a chained invocation

setVolume

public final OctTreeRaycastResultI.Builder<T> setVolume(com.io7m.jregions.core.unparameterized.volumes.VolumeI volume)

Initializes the value for the volume attribute.

Parameters:

volume - The value for volume

Returns:

this builder for use in a chained invocation

setItem

public final OctTreeRaycastResultI.Builder<T> setItem(T item)

Initializes the value for the item attribute.

Parameters:

item - The value for item

Returns:

this builder for use in a chained invocation

build

public OctTreeRaycastResultI<T> build()

Builds a new OctTreeRaycastResultI.

Returns:

An immutable instance of OctTreeRaycastResultI

Throws:

IllegalStateException - if any required attributes are missing