Package com.io7m.changelog.text.api

Class CPlainChangelogWriterConfiguration

java.lang.Object
com.io7m.changelog.text.api.CPlainChangelogWriterConfiguration
All Implemented Interfaces:
CPlainChangelogWriterConfigurationType
public final class CPlainChangelogWriterConfiguration
extends java.lang.Object
implements CPlainChangelogWriterConfigurationType
The type of configurations for plain text writers.

  • Method Details

    • showDates

      public boolean showDates()
      Specified by:
      showDates in interface CPlainChangelogWriterConfigurationType
      Returns:
      true if dates should be shown in the output

    • withShowDates

      public final CPlainChangelogWriterConfiguration withShowDates​(boolean value)
      Copy the current immutable object by setting a value for the showDates attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for showDates
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals​(java.lang.Object another)
      This instance is equal to all instances of CPlainChangelogWriterConfiguration that have equal attribute values.
      Overrides:
      equals in class java.lang.Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: showDates.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      hashCode value

    • toString

      public java.lang.String toString()
      Prints the immutable value CPlainChangelogWriterConfiguration with attribute values.
      Overrides:
      toString in class java.lang.Object
      Returns:
      A string representation of the value

    • of

      public static CPlainChangelogWriterConfiguration of​(boolean showDates)
      Construct a new immutable CPlainChangelogWriterConfiguration instance.
      Parameters:
      showDates - The value for the showDates attribute
      Returns:
      An immutable CPlainChangelogWriterConfiguration instance

    • copyOf

      public static CPlainChangelogWriterConfiguration copyOf​(CPlainChangelogWriterConfigurationType instance)
      Creates an immutable copy of a CPlainChangelogWriterConfigurationType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable CPlainChangelogWriterConfiguration instance

    • builder

      public static CPlainChangelogWriterConfiguration.Builder builder()
      Creates a builder for CPlainChangelogWriterConfiguration. 
       CPlainChangelogWriterConfiguration.builder()
    .setShowDates(boolean) // optional showDates
    .build();
      Returns:
      A new CPlainChangelogWriterConfiguration builder