Module com.io7m.changelog.core

Package com.io7m.changelog.core

Class CChangelog

java.lang.Object

com.io7m.changelog.core.CChangelog

All Implemented Interfaces:

CChangelogType

public final class CChangelog
extends Object
implements CChangelogType

The type of changelogs.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CChangelog.Builder	builder()	Creates a builder for CChangelog.
static CChangelog	copyOf(CChangelogType instance)	Creates an immutable copy of a CChangelogType value.
boolean	equals(Object another)	This instance is equal to all instances of CChangelog that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: project, releases, ticketSystems.
static CChangelog	of(CProjectName project, io.vavr.collection.SortedMap<CVersionType,CRelease> releases, io.vavr.collection.Map<String,CTicketSystem> ticketSystems)	Construct a new immutable CChangelog instance.
CProjectName	project()
io.vavr.collection.SortedMap<CVersionType,CRelease>	releases()
io.vavr.collection.Map<String,CTicketSystem>	ticketSystems()
String	toString()	Prints the immutable value CChangelog with attribute values.
CChangelog	withProject(CProjectName value)	Copy the current immutable object by setting a value for the project attribute.
CChangelog	withReleases(io.vavr.collection.SortedMap<CVersionType,CRelease> value)
CChangelog	withTicketSystems(io.vavr.collection.Map<String,CTicketSystem> value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.io7m.changelog.core.CChangelogType

checkPreconditions

Method Detail

project

public CProjectName project()

Specified by:

project in interface CChangelogType

Returns:

The project name

releases

public io.vavr.collection.SortedMap<CVersionType,CRelease> releases()

Specified by:

releases in interface CChangelogType

Returns:

The list of releases

ticketSystems

public io.vavr.collection.Map<String,CTicketSystem> ticketSystems()

Specified by:

ticketSystems in interface CChangelogType

Returns:

The ticket systems

withProject

public final CChangelog withProject(CProjectName value)

Copy the current immutable object by setting a value for the project attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for project

Returns:

A modified copy of the this object

withReleases

public CChangelog withReleases(io.vavr.collection.SortedMap<CVersionType,CRelease> value)

withTicketSystems

public CChangelog withTicketSystems(io.vavr.collection.Map<String,CTicketSystem> value)

equals

public boolean equals(Object another)

This instance is equal to all instances of CChangelog 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: project, releases, ticketSystems.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value CChangelog with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static CChangelog of(CProjectName project,
                            io.vavr.collection.SortedMap<CVersionType,CRelease> releases,
                            io.vavr.collection.Map<String,CTicketSystem> ticketSystems)

Construct a new immutable CChangelog instance.

Parameters:

project - The value for the project attribute

releases - The value for the releases attribute

ticketSystems - The value for the ticketSystems attribute

Returns:

An immutable CChangelog instance

copyOf

public static CChangelog copyOf(CChangelogType instance)

Creates an immutable copy of a CChangelogType 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 CChangelog instance

builder

public static CChangelog.Builder builder()

Creates a builder for CChangelog.

Returns:

A new CChangelog builder