NTSampleIndex.Builder

java.lang.Object

com.io7m.jnoisetype.api.NTSampleIndex.Builder

Enclosing class:: NTSampleIndex

public static final class NTSampleIndex.Builder extends Object

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

NTSampleIndex

build()

Builds a new NTSampleIndex.

final NTSampleIndex.Builder

from(NTSampleIndexType instance)

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

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