CPlainChangelogWriterConfiguration.Builder

java.lang.Object

com.io7m.changelog.text.api.CPlainChangelogWriterConfiguration.Builder

Enclosing class:: CPlainChangelogWriterConfiguration

public static final class CPlainChangelogWriterConfiguration.Builder extends Object

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

CPlainChangelogWriterConfiguration

build()

Builds a new CPlainChangelogWriterConfiguration.

final CPlainChangelogWriterConfiguration.Builder

from(CPlainChangelogWriterConfigurationType instance)

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

final CPlainChangelogWriterConfiguration.Builder

setShowDates(boolean showDates)

Initializes the value for the showDates attribute.

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

Method Details
- from
  
  public final CPlainChangelogWriterConfiguration.Builder from(CPlainChangelogWriterConfigurationType instance)
  
  Fill a builder with attribute values from the provided CPlainChangelogWriterConfigurationType 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
- setShowDates
  
  public final CPlainChangelogWriterConfiguration.Builder setShowDates(boolean showDates)
  
  Initializes the value for the showDates attribute.
  If not set, this attribute will have a default value as returned by the initializer of showDates.
  
  Parameters:
  
  showDates - The value for showDates
  
  Returns:
  
  this builder for use in a chained invocation
- build
  
  public CPlainChangelogWriterConfiguration build()
  
  Builds a new CPlainChangelogWriterConfiguration.
  
  Returns:
  
  An immutable instance of CPlainChangelogWriterConfiguration
  
  Throws:
  
  IllegalStateException - if any required attributes are missing