ImmutableHistogram.Builder (BioCommons 3.0.4 API)

java.lang.Object
- pl.poznan.put.circular.ImmutableHistogram.Builder

Enclosing class:

ImmutableHistogram
```
@NotThreadSafe
public static final class ImmutableHistogram.Builder
extends Object
```
Builds instances of type ImmutableHistogram. 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ImmutableHistogram.Builder`	`binWidth(double binWidth)`	Initializes the value for the `binWidth` attribute.
`ImmutableHistogram`	`build()`	Builds a new `ImmutableHistogram`.
`ImmutableHistogram.Builder`	`data(Collection<Angle> data)`	Initializes the value for the `data` attribute.
`ImmutableHistogram.Builder`	`from(Histogram instance)`	Fill a builder with attribute values from the provided `Histogram` instance.

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

- Method Detail
  - from
```
public final ImmutableHistogram.Builder from(Histogram instance)
```
    Fill a builder with attribute values from the provided Histogram 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
  - data
```
public final ImmutableHistogram.Builder data(Collection<Angle> data)
```
    Initializes the value for the data attribute.
    
    Parameters:
    
    data - The value for data
    
    Returns:
    
    this builder for use in a chained invocation
  - binWidth
```
public final ImmutableHistogram.Builder binWidth(double binWidth)
```
    Initializes the value for the binWidth attribute.
    
    Parameters:
    
    binWidth - The value for binWidth
    
    Returns:
    
    this builder for use in a chained invocation
  - build
```
public ImmutableHistogram build()
```
    Builds a new ImmutableHistogram.
    
    Returns:
    
    An immutable instance of Histogram
    
    Throws:
    
    IllegalStateException - if any required attributes are missing