CRelease (io7m-changelog-documentation 3.0.1 API)

java.lang.Object
- com.io7m.changelog.core.CRelease

All Implemented Interfaces:: CReleaseType

@Generated(value={"Immutables.generator","CReleaseType"})
public final class CRelease
extends Object
implements CReleaseType

A specific release in a changelog.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CRelease.Builder
Builds instances of type CRelease.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CRelease.Builder` Builds instances of type `CRelease`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CRelease.Builder`	`builder()` Creates a builder for `CRelease`.
`static CRelease`	`copyOf(CReleaseType instance)` Creates an immutable copy of a `CReleaseType` value.
`LocalDate`	`date()`
`boolean`	`equals(Object another)` This instance is equal to all instances of `CRelease` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `date`, `items`, `ticketSystemID`, `version`.
`List<CItem>`	`items()`
`static CRelease`	`of(LocalDate date, Iterable<? extends CItem> items, String ticketSystemID, CVersionType version)` Construct a new immutable `CRelease` instance.
`static CRelease`	`of(LocalDate date, List<CItem> items, String ticketSystemID, CVersionType version)` Construct a new immutable `CRelease` instance.
`String`	`ticketSystemID()`
`String`	`toString()` Prints the immutable value `CRelease` with attribute values.
`CVersionType`	`version()`
`CRelease`	`withDate(LocalDate value)` Copy the current immutable object by setting a value for the `date` attribute.
`CRelease`	`withItems(CItem... elements)` Copy the current immutable object with elements that replace the content of `items`.
`CRelease`	`withItems(Iterable<? extends CItem> elements)` Copy the current immutable object with elements that replace the content of `items`.
`CRelease`	`withTicketSystemID(String value)` Copy the current immutable object by setting a value for the `ticketSystemID` attribute.
`CRelease`	`withVersion(CVersionType value)` Copy the current immutable object by setting a value for the `version` attribute.

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

- Method Detail
  - date
```
public LocalDate date()
```
    Specified by:
    
    date in interface CReleaseType
    
    Returns:
    
    The release date
  - items
```
public List<CItem> items()
```
    Specified by:
    
    items in interface CReleaseType
    
    Returns:
    
    The list of release changes
  - ticketSystemID
```
public String ticketSystemID()
```
    Specified by:
    
    ticketSystemID in interface CReleaseType
    
    Returns:
    
    The ticket system ID
  - version
```
public CVersionType version()
```
    Specified by:
    
    version in interface CReleaseType
    
    Returns:
    
    The version number
  - withDate
```
public final CRelease withDate(LocalDate value)
```
    Copy the current immutable object by setting a value for the date attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for date
    
    Returns:
    
    A modified copy of the this object
  - withItems
```
public final CRelease withItems(CItem... elements)
```
    Copy the current immutable object with elements that replace the content of items.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withItems
```
public final CRelease withItems(Iterable<? extends CItem> elements)
```
    Copy the current immutable object with elements that replace the content of items. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of items elements to set
    
    Returns:
    
    A modified copy of this object
  - withTicketSystemID
```
public final CRelease withTicketSystemID(String value)
```
    Copy the current immutable object by setting a value for the ticketSystemID attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for ticketSystemID
    
    Returns:
    
    A modified copy of the this object
  - withVersion
```
public final CRelease withVersion(CVersionType value)
```
    Copy the current immutable object by setting a value for the version attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for version
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of CRelease 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: date, items, ticketSystemID, version.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value CRelease with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - of
```
public static CRelease of(LocalDate date,
                          List<CItem> items,
                          String ticketSystemID,
                          CVersionType version)
```
    Construct a new immutable CRelease instance.
    
    Parameters:
    
    date - The value for the date attribute
    
    items - The value for the items attribute
    
    ticketSystemID - The value for the ticketSystemID attribute
    
    version - The value for the version attribute
    
    Returns:
    
    An immutable CRelease instance
  - of
```
public static CRelease of(LocalDate date,
                          Iterable<? extends CItem> items,
                          String ticketSystemID,
                          CVersionType version)
```
    Construct a new immutable CRelease instance.
    
    Parameters:
    
    date - The value for the date attribute
    
    items - The value for the items attribute
    
    ticketSystemID - The value for the ticketSystemID attribute
    
    version - The value for the version attribute
    
    Returns:
    
    An immutable CRelease instance
  - copyOf
```
public static CRelease copyOf(CReleaseType instance)
```
    Creates an immutable copy of a CReleaseType 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 CRelease instance
  - builder
```
public static CRelease.Builder builder()
```
    Creates a builder for CRelease.
    
    Returns:
    
    A new CRelease builder

Class CRelease

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

date

items

ticketSystemID

version

withDate

withItems

withItems

withTicketSystemID

withVersion

equals

hashCode

toString

of

of

copyOf

builder