Package com.io7m.changelog.xml.api

Class CAtomChangelogWriterConfiguration

java.lang.Object
com.io7m.changelog.xml.api.CAtomChangelogWriterConfiguration
All Implemented Interfaces:
CAtomChangelogWriterConfigurationType
public final class CAtomChangelogWriterConfiguration extends Object implements CAtomChangelogWriterConfigurationType
The type of configurations for Atom feed writers.

  • Method Details

    • updated

      public ZonedDateTime updated()
      Specified by:
      updated in interface CAtomChangelogWriterConfigurationType
      Returns:
      The updated time for the feed

    • authorEmail

      public String authorEmail()
      Specified by:
      authorEmail in interface CAtomChangelogWriterConfigurationType
      Returns:
      The email of the feed author

    • authorName

      public String authorName()
      Specified by:
      authorName in interface CAtomChangelogWriterConfigurationType
      Returns:
      The name of the feed author

    • title

      public String title()
      Specified by:
      title in interface CAtomChangelogWriterConfigurationType
      Returns:
      The feed title

    • uri

      public URI uri()
      Specified by:
      uri in interface CAtomChangelogWriterConfigurationType
      Returns:
      The URI of the feed

    • withUpdated

      public final CAtomChangelogWriterConfiguration withUpdated(ZonedDateTime value)
      Copy the current immutable object by setting a value for the updated attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for updated
      Returns:
      A modified copy of the this object

    • withAuthorEmail

      public final CAtomChangelogWriterConfiguration withAuthorEmail(String value)
      Copy the current immutable object by setting a value for the authorEmail attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for authorEmail
      Returns:
      A modified copy of the this object

    • withAuthorName

      public final CAtomChangelogWriterConfiguration withAuthorName(String value)
      Copy the current immutable object by setting a value for the authorName attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for authorName
      Returns:
      A modified copy of the this object

    • withTitle

      public final CAtomChangelogWriterConfiguration withTitle(String value)
      Copy the current immutable object by setting a value for the title attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for title
      Returns:
      A modified copy of the this object

    • withUri

      public final CAtomChangelogWriterConfiguration withUri(URI value)
      Copy the current immutable object by setting a value for the uri attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for uri
      Returns:
      A modified copy of the this object

    • equals

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

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: updated, authorEmail, authorName, title, uri.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • of

      public static CAtomChangelogWriterConfiguration of(ZonedDateTime updated, String authorEmail, String authorName, String title, URI uri)
      Construct a new immutable CAtomChangelogWriterConfiguration instance.
      Parameters:
      updated - The value for the updated attribute
      authorEmail - The value for the authorEmail attribute
      authorName - The value for the authorName attribute
      title - The value for the title attribute
      uri - The value for the uri attribute
      Returns:
      An immutable CAtomChangelogWriterConfiguration instance

    • copyOf

      public static CAtomChangelogWriterConfiguration copyOf(CAtomChangelogWriterConfigurationType instance)
      Creates an immutable copy of a CAtomChangelogWriterConfigurationType 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 CAtomChangelogWriterConfiguration instance

    • builder

      public static CAtomChangelogWriterConfiguration.Builder builder()
      Creates a builder for CAtomChangelogWriterConfiguration. 
       CAtomChangelogWriterConfiguration.builder()
    .setUpdated(java.time.ZonedDateTime) // required updated
    .setAuthorEmail(String) // required authorEmail
    .setAuthorName(String) // required authorName
    .setTitle(String) // required title
    .setUri(java.net.URI) // required uri
    .build();
      Returns:
      A new CAtomChangelogWriterConfiguration builder