NTGenerator.Builder

java.lang.Object

com.io7m.jnoisetype.api.NTGenerator.Builder

Enclosing class:: NTGenerator

public static final class NTGenerator.Builder extends Object

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

NTGenerator

build()

Builds a new NTGenerator.

final NTGenerator.Builder

from(NTGeneratorType instance)

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

final NTGenerator.Builder

setIndex(NTGeneratorOperatorIndex index)

Initializes the value for the index attribute.

final NTGenerator.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 NTGenerator.Builder from(NTGeneratorType instance)
  
  Fill a builder with attribute values from the provided NTGeneratorType 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 NTGenerator.Builder setIndex(NTGeneratorOperatorIndex 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 NTGenerator.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 NTGenerator build()
  
  Builds a new NTGenerator.
  
  Returns:
  
  An immutable instance of NTGenerator
  
  Throws:
  
  IllegalStateException - if any required attributes are missing