CVersion.Builder

java.lang.Object

com.io7m.changelog.core.CVersion.Builder

Enclosing class:: CVersion

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

Builds instances of type CVersion. 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
`CVersion`	`build()`	Builds a new `CVersion`.
`CVersion.Builder`	`from(CVersionType instance)`	Fill a builder with attribute values from the provided `CVersionType` instance.
`CVersion.Builder`	`setMajor(java.math.BigInteger major)`	Initializes the value for the `major` attribute.
`CVersion.Builder`	`setMinor(java.math.BigInteger minor)`	Initializes the value for the `minor` attribute.
`CVersion.Builder`	`setPatch(java.math.BigInteger patch)`	Initializes the value for the `patch` attribute.

Methods inherited from class java.lang.Object

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

Method Details
- from
  
  public final CVersion.Builder from(CVersionType instance)
  
  Fill a builder with attribute values from the provided CVersionType 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
- setMajor
  
  public final CVersion.Builder setMajor(java.math.BigInteger major)
  
  Initializes the value for the major attribute.
  
  Parameters:
  
  major - The value for major
  
  Returns:
  
  this builder for use in a chained invocation
- setMinor
  
  public final CVersion.Builder setMinor(java.math.BigInteger minor)
  
  Initializes the value for the minor attribute.
  
  Parameters:
  
  minor - The value for minor
  
  Returns:
  
  this builder for use in a chained invocation
- setPatch
  
  public final CVersion.Builder setPatch(java.math.BigInteger patch)
  
  Initializes the value for the patch attribute.
  
  Parameters:
  
  patch - The value for patch
  
  Returns:
  
  this builder for use in a chained invocation
- build
  
  public CVersion build()
  
  Builds a new CVersion.
  
  Returns:
  
  An immutable instance of CVersion
  
  Throws:
  
  java.lang.IllegalStateException - if any required attributes are missing