Module com.io7m.changelog.core

Package com.io7m.changelog.core

Class CRelease

java.lang.Object

com.io7m.changelog.core.CRelease

All Implemented Interfaces:

CReleaseType

public final class CRelease
extends Object
implements CReleaseType

A specific release in a changelog.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CRelease.Builder	builder()	Creates a builder for CRelease.
io.vavr.collection.List<CChange>	changes()
static CRelease	copyOf(CReleaseType instance)	Creates an immutable copy of a CReleaseType value.
ZonedDateTime	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, changes, ticketSystemID, version.
static CRelease	of(ZonedDateTime date, io.vavr.collection.List<CChange> changes, 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	withChanges(io.vavr.collection.List<CChange> value)
CRelease	withDate(ZonedDateTime value)	Copy the current immutable object by setting a value for the date attribute.
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 ZonedDateTime date()

Specified by:

date in interface CReleaseType

Returns:

The release date

changes

public io.vavr.collection.List<CChange> changes()

Specified by:

changes 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(ZonedDateTime 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

withChanges

public CRelease withChanges(io.vavr.collection.List<CChange> value)

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, changes, 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(ZonedDateTime date,
                          io.vavr.collection.List<CChange> changes,
                          String ticketSystemID,
                          CVersionType version)

Construct a new immutable CRelease instance.

Parameters:

date - The value for the date attribute

changes - The value for the changes 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