Package pl.poznan.put.rna

Class ImmutableStandardReferenceFrame.Builder

java.lang.Object

pl.poznan.put.rna.ImmutableStandardReferenceFrame.Builder

Enclosing class:

ImmutableStandardReferenceFrame

@NotThreadSafe
public static final class ImmutableStandardReferenceFrame.Builder
extends Object

Builds instances of type ImmutableStandardReferenceFrame. 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	Description
ImmutableStandardReferenceFrame	build()	Builds a new ImmutableStandardReferenceFrame.
ImmutableStandardReferenceFrame.Builder	from(StandardReferenceFrame instance)	Fill a builder with attribute values from the provided StandardReferenceFrame instance.
ImmutableStandardReferenceFrame.Builder	longAxisAtom(Optional<PdbAtomLine> longAxisAtom)	Initializes the value for the longAxisAtom attribute.
ImmutableStandardReferenceFrame.Builder	origin(org.apache.commons.math3.geometry.euclidean.threed.Vector3D origin)	Initializes the value for the origin attribute.
ImmutableStandardReferenceFrame.Builder	x(org.apache.commons.math3.geometry.euclidean.threed.Vector3D x)	Initializes the value for the x attribute.
ImmutableStandardReferenceFrame.Builder	y(org.apache.commons.math3.geometry.euclidean.threed.Vector3D y)	Initializes the value for the y attribute.
ImmutableStandardReferenceFrame.Builder	z(org.apache.commons.math3.geometry.euclidean.threed.Vector3D z)	Initializes the value for the z attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableStandardReferenceFrame.Builder from(StandardReferenceFrame instance)

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

origin

public final ImmutableStandardReferenceFrame.Builder origin(org.apache.commons.math3.geometry.euclidean.threed.Vector3D origin)

Initializes the value for the origin attribute.

Parameters:

origin - The value for origin

Returns:

this builder for use in a chained invocation

x

public final ImmutableStandardReferenceFrame.Builder x(org.apache.commons.math3.geometry.euclidean.threed.Vector3D x)

Initializes the value for the x attribute.

Parameters:

x - The value for x

Returns:

this builder for use in a chained invocation

y

public final ImmutableStandardReferenceFrame.Builder y(org.apache.commons.math3.geometry.euclidean.threed.Vector3D y)

Initializes the value for the y attribute.

Parameters:

y - The value for y

Returns:

this builder for use in a chained invocation

z

public final ImmutableStandardReferenceFrame.Builder z(org.apache.commons.math3.geometry.euclidean.threed.Vector3D z)

Initializes the value for the z attribute.

Parameters:

z - The value for z

Returns:

this builder for use in a chained invocation

longAxisAtom

public final ImmutableStandardReferenceFrame.Builder longAxisAtom(Optional<PdbAtomLine> longAxisAtom)

Initializes the value for the longAxisAtom attribute.

If not set, this attribute will have a default value as returned by the initializer of longAxisAtom.

Parameters:

longAxisAtom - The value for longAxisAtom

Returns:

this builder for use in a chained invocation

build

public ImmutableStandardReferenceFrame build()

Builds a new ImmutableStandardReferenceFrame.

Returns:

An immutable instance of StandardReferenceFrame

Throws:

IllegalStateException - if any required attributes are missing