Package com.io7m.changelog.core

Class CItem

java.lang.Object

com.io7m.changelog.core.CItem

All Implemented Interfaces:

CItemType

public final class CItem
extends java.lang.Object
implements CItemType

A changelog item for a specific release.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CItem.Builder	builder()	Creates a builder for CItem.
static CItem	copyOf(CItemType instance)	Creates an immutable copy of a CItemType value.
java.time.LocalDate	date()
boolean	equals(java.lang.Object another)	This instance is equal to all instances of CItem that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: date, summary, tickets, type.
static CItem	of(java.time.LocalDate date, java.lang.String summary, java.lang.Iterable<java.lang.String> tickets, CChangeType type)	Construct a new immutable CItem instance.
static CItem	of(java.time.LocalDate date, java.lang.String summary, java.util.List<java.lang.String> tickets, CChangeType type)	Construct a new immutable CItem instance.
java.lang.String	summary()
java.util.List<java.lang.String>	tickets()
java.lang.String	toString()	Prints the immutable value CItem with attribute values.
CChangeType	type()
CItem	withDate(java.time.LocalDate value)	Copy the current immutable object by setting a value for the date attribute.
CItem	withSummary(java.lang.String value)	Copy the current immutable object by setting a value for the summary attribute.
CItem	withTickets(java.lang.Iterable<java.lang.String> elements)	Copy the current immutable object with elements that replace the content of tickets.
CItem	withTickets(java.lang.String... elements)	Copy the current immutable object with elements that replace the content of tickets.
CItem	withType(CChangeType value)	Copy the current immutable object by setting a value for the type attribute.

Methods inherited from class java.lang.Object

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

Method Detail

date

public java.time.LocalDate date()

Specified by:

date in interface CItemType

Returns:

The change date

summary

public java.lang.String summary()

Specified by:

summary in interface CItemType

Returns:

The change summary

tickets

public java.util.List<java.lang.String> tickets()

Specified by:

tickets in interface CItemType

Returns:

The change tickets

type

public CChangeType type()

Specified by:

type in interface CItemType

Returns:

The change type

withDate

public final CItem withDate(java.time.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

withSummary

public final CItem withSummary(java.lang.String value)

Copy the current immutable object by setting a value for the summary attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for summary

Returns:

A modified copy of the this object

withTickets

public final CItem withTickets(java.lang.String... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withTickets

public final CItem withTickets(java.lang.Iterable<java.lang.String> elements)

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

Parameters:

elements - An iterable of tickets elements to set

Returns:

A modified copy of this object

withType

public final CItem withType(CChangeType value)

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

Parameters:

value - A new value for type

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of CItem 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: date, summary, tickets, type.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value CItem with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static CItem of(java.time.LocalDate date,
                       java.lang.String summary,
                       java.util.List<java.lang.String> tickets,
                       CChangeType type)

Construct a new immutable CItem instance.

Parameters:

date - The value for the date attribute

summary - The value for the summary attribute

tickets - The value for the tickets attribute

type - The value for the type attribute

Returns:

An immutable CItem instance

of

public static CItem of(java.time.LocalDate date,
                       java.lang.String summary,
                       java.lang.Iterable<java.lang.String> tickets,
                       CChangeType type)

Construct a new immutable CItem instance.

Parameters:

date - The value for the date attribute

summary - The value for the summary attribute

tickets - The value for the tickets attribute

type - The value for the type attribute

Returns:

An immutable CItem instance

copyOf

public static CItem copyOf(CItemType instance)

Creates an immutable copy of a CItemType 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 CItem instance

builder

public static CItem.Builder builder()

Creates a builder for CItem.

Returns:

A new CItem builder