NTPitch.Builder

java.lang.Object

com.io7m.jnoisetype.api.NTPitch.Builder

Enclosing class:: NTPitch

public static final class NTPitch.Builder extends Object

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

NTPitch

build()

Builds a new NTPitch.

final NTPitch.Builder

from(NTPitchType instance)

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

final NTPitch.Builder

setValue(int value)

Initializes the value for the value attribute.

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

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