com.io7m.changelog.core

Class CRelease.Builder

java.lang.Object

com.io7m.changelog.core.CRelease.Builder

Enclosing class:

CRelease

public static final class CRelease.Builder
extends Object

Builds instances of type CRelease. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
CRelease.Builder	addAllItems(Iterable<? extends CItem> elements) Adds elements to items list.
CRelease.Builder	addItems(CItem... elements) Adds elements to items list.
CRelease.Builder	addItems(CItem element) Adds one element to items list.
CRelease	build() Builds a new CRelease.
CRelease.Builder	from(CReleaseType instance) Fill a builder with attribute values from the provided CReleaseType instance.
CRelease.Builder	setDate(LocalDate date) Initializes the value for the date attribute.
CRelease.Builder	setItems(Iterable<? extends CItem> elements) Sets or replaces all elements for items list.
CRelease.Builder	setTicketSystemID(String ticketSystemID) Initializes the value for the ticketSystemID attribute.
CRelease.Builder	setVersion(CVersionType version) Initializes the value for the version attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public final CRelease.Builder from(CReleaseType instance)

Fill a builder with attribute values from the provided CReleaseType instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setDate

public final CRelease.Builder setDate(LocalDate date)

Initializes the value for the date attribute.

Parameters:

date - The value for date

Returns:

this builder for use in a chained invocation

addItems

public final CRelease.Builder addItems(CItem element)

Adds one element to items list.

Parameters:

element - A items element

Returns:

this builder for use in a chained invocation

addItems

public final CRelease.Builder addItems(CItem... elements)

Adds elements to items list.

Parameters:

elements - An array of items elements

Returns:

this builder for use in a chained invocation

setItems

public final CRelease.Builder setItems(Iterable<? extends CItem> elements)

Sets or replaces all elements for items list.

Parameters:

elements - An iterable of items elements

Returns:

this builder for use in a chained invocation

addAllItems

public final CRelease.Builder addAllItems(Iterable<? extends CItem> elements)

Adds elements to items list.

Parameters:

elements - An iterable of items elements

Returns:

this builder for use in a chained invocation

setTicketSystemID

public final CRelease.Builder setTicketSystemID(String ticketSystemID)

Initializes the value for the ticketSystemID attribute.

Parameters:

ticketSystemID - The value for ticketSystemID

Returns:

this builder for use in a chained invocation

setVersion

public final CRelease.Builder setVersion(CVersionType version)

Initializes the value for the version attribute.

Parameters:

version - The value for version

Returns:

this builder for use in a chained invocation

build

public CRelease build()

Builds a new CRelease.

Returns:

An immutable instance of CRelease

Throws:

IllegalStateException - if any required attributes are missing