NTTransform.Builder

java.lang.Object

com.io7m.jnoisetype.api.NTTransform.Builder

Enclosing class:: NTTransform

public static final class NTTransform.Builder extends Object

Builds instances of type NTTransform. 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

NTTransform

build()

Builds a new NTTransform.

final NTTransform.Builder

from(NTTransformType instance)

Fill a builder with attribute values from the provided NTTransformType instance.

final NTTransform.Builder

setIndex(NTTransformIndex index)

Initializes the value for the index attribute.

final NTTransform.Builder

setName(String name)

Initializes the value for the name attribute.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- from
  
  public final NTTransform.Builder from(NTTransformType instance)
  
  Fill a builder with attribute values from the provided NTTransformType 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
- setIndex
  
  public final NTTransform.Builder setIndex(NTTransformIndex index)
  
  Initializes the value for the index attribute.
  
  Parameters:
  
  index - The value for index
  
  Returns:
  
  this builder for use in a chained invocation
- setName
  
  public final NTTransform.Builder setName(String name)
  
  Initializes the value for the name attribute.
  
  Parameters:
  
  name - The value for name
  
  Returns:
  
  this builder for use in a chained invocation
- build
  
  public NTTransform build()
  
  Builds a new NTTransform.
  
  Returns:
  
  An immutable instance of NTTransform
  
  Throws:
  
  IllegalStateException - if any required attributes are missing