Package com.io7m.changelog.core

Class CChangelog

java.lang.Object

com.io7m.changelog.core.CChangelog

All Implemented Interfaces:

CChangelogType

public final class CChangelog
extends java.lang.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(java.lang.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(java.lang.String project, java.lang.Iterable<? extends CRelease> releases, java.util.Map<java.lang.String,? extends java.net.URI> ticketSystems)	Construct a new immutable CChangelog instance.
static CChangelog	of(java.lang.String project, java.util.List<CRelease> releases, java.util.Map<java.lang.String,java.net.URI> ticketSystems)	Construct a new immutable CChangelog instance.
java.lang.String	project()
java.util.List<CRelease>	releases()
java.util.Map<java.lang.String,java.net.URI>	ticketSystems()
java.lang.String	toString()	Prints the immutable value CChangelog with attribute values.
CChangelog	withProject(java.lang.String value)	Copy the current immutable object by setting a value for the project attribute.
CChangelog	withReleases(CRelease... elements)	Copy the current immutable object with elements that replace the content of releases.
CChangelog	withReleases(java.lang.Iterable<? extends CRelease> elements)	Copy the current immutable object with elements that replace the content of releases.
CChangelog	withTicketSystems(java.util.Map<java.lang.String,? extends java.net.URI> entries)	Copy the current immutable object by replacing the ticketSystems map with the specified map.

Methods inherited from class java.lang.Object

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

Method Detail

project

public java.lang.String project()

Specified by:

project in interface CChangelogType

Returns:

The project name

releases

public java.util.List<CRelease> releases()

Specified by:

releases in interface CChangelogType

Returns:

The list of releases

ticketSystems

public java.util.Map<java.lang.String,java.net.URI> ticketSystems()

Specified by:

ticketSystems in interface CChangelogType

Returns:

The ticket systems

withProject

public final CChangelog withProject(java.lang.String value)

Copy the current immutable object by setting a value for the project attribute. An equals check 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 final CChangelog withReleases(CRelease... elements)

Copy the current immutable object with elements that replace the content of releases.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withReleases

public final CChangelog withReleases(java.lang.Iterable<? extends CRelease> elements)

Copy the current immutable object with elements that replace the content of releases. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of releases elements to set

Returns:

A modified copy of this object

withTicketSystems

public final CChangelog withTicketSystems(java.util.Map<java.lang.String,? extends java.net.URI> entries)

Copy the current immutable object by replacing the ticketSystems map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the ticketSystems map

Returns:

A modified copy of this object

equals

public boolean equals(java.lang.Object another)

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

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value CChangelog with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static CChangelog of(java.lang.String project,
                            java.util.List<CRelease> releases,
                            java.util.Map<java.lang.String,java.net.URI> 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

of

public static CChangelog of(java.lang.String project,
                            java.lang.Iterable<? extends CRelease> releases,
                            java.util.Map<java.lang.String,? extends java.net.URI> 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