NTSource.Builder

java.lang.Object

com.io7m.jnoisetype.api.NTSource.Builder

Enclosing class:: NTSource

public static final class NTSource.Builder
extends java.lang.Object

Builds instances of type NTSource. 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
`NTSource`	`build()`	Builds a new `NTSource`.
`NTSource.Builder`	`from(NTSourceType instance)`	Fill a builder with attribute values from the provided `NTSourceType` instance.
`NTSource.Builder`	`setOffset(long offset)`	Initializes the value for the `offset` attribute.
`NTSource.Builder`	`setSource(java.net.URI source)`	Initializes the value for the `source` attribute.

Methods inherited from class java.lang.Object

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

Method Details
- from
  
  public final NTSource.Builder from(NTSourceType instance)
  
  Fill a builder with attribute values from the provided NTSourceType 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
- setSource
  
  public final NTSource.Builder setSource(java.net.URI source)
  
  Initializes the value for the source attribute.
  
  Parameters:
  
  source - The value for source
  
  Returns:
  
  this builder for use in a chained invocation
- setOffset
  
  public final NTSource.Builder setOffset(long offset)
  
  Initializes the value for the offset attribute.
  
  Parameters:
  
  offset - The value for offset
  
  Returns:
  
  this builder for use in a chained invocation
- build
  
  public NTSource build()
  
  Builds a new NTSource.
  
  Returns:
  
  An immutable instance of NTSource
  
  Throws:
  
  java.lang.IllegalStateException - if any required attributes are missing