com.io7m.jspatial.api

Class Ray2D.Builder

java.lang.Object

com.io7m.jspatial.api.Ray2D.Builder

Enclosing class:

Ray2D

public static final class Ray2D.Builder
extends Object

Builds instances of type Ray2D. 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
Ray2D	build() Builds a new Ray2D.
Ray2D.Builder	from(Ray2DType instance) Fill a builder with attribute values from the provided Ray2DType instance.
Ray2D.Builder	setDirection(com.io7m.jtensors.core.unparameterized.vectors.Vector2D direction) Initializes the value for the direction attribute.
Ray2D.Builder	setOrigin(com.io7m.jtensors.core.unparameterized.vectors.Vector2D origin) Initializes the value for the origin attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Ray2D.Builder from(Ray2DType instance)

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

setOrigin

public final Ray2D.Builder setOrigin(com.io7m.jtensors.core.unparameterized.vectors.Vector2D origin)

Initializes the value for the origin attribute.

Parameters:

origin - The value for origin

Returns:

this builder for use in a chained invocation

setDirection

public final Ray2D.Builder setDirection(com.io7m.jtensors.core.unparameterized.vectors.Vector2D direction)

Initializes the value for the direction attribute.

Parameters:

direction - The value for direction

Returns:

this builder for use in a chained invocation

build

public Ray2D build()

Builds a new Ray2D.

Returns:

An immutable instance of Ray2D

Throws:

IllegalStateException - if any required attributes are missing