com.io7m.changelog.core

Class CChangelog.Builder

java.lang.Object

com.io7m.changelog.core.CChangelog.Builder

Enclosing class:

CChangelog

public static final class CChangelog.Builder
extends Object

Builds instances of type CChangelog. 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
CChangelog.Builder	addAllReleases(Iterable<? extends CRelease> elements) Adds elements to releases list.
CChangelog.Builder	addReleases(CRelease... elements) Adds elements to releases list.
CChangelog.Builder	addReleases(CRelease element) Adds one element to releases list.
CChangelog	build() Builds a new CChangelog.
CChangelog.Builder	from(CChangelogType instance) Fill a builder with attribute values from the provided CChangelogType instance.
CChangelog.Builder	putAllTicketSystems(Map<String,? extends URI> ticketSystems) Put all mappings from the specified map as entries to ticketSystems map.
CChangelog.Builder	putTicketSystems(Map.Entry<String,? extends URI> entry) Put one entry to the ticketSystems map.
CChangelog.Builder	putTicketSystems(String key, URI value) Put one entry to the ticketSystems map.
CChangelog.Builder	setProject(String project) Initializes the value for the project attribute.
CChangelog.Builder	setReleases(Iterable<? extends CRelease> elements) Sets or replaces all elements for releases list.
CChangelog.Builder	setTicketSystems(Map<String,? extends URI> ticketSystems) Sets or replaces all mappings from the specified map as entries for the ticketSystems map.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final CChangelog.Builder from(CChangelogType instance)

Fill a builder with attribute values from the provided CChangelogType 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

setProject

public final CChangelog.Builder setProject(String project)

Initializes the value for the project attribute.

Parameters:

project - The value for project

Returns:

this builder for use in a chained invocation

addReleases

public final CChangelog.Builder addReleases(CRelease element)

Adds one element to releases list.

Parameters:

element - A releases element

Returns:

this builder for use in a chained invocation

addReleases

public final CChangelog.Builder addReleases(CRelease... elements)

Adds elements to releases list.

Parameters:

elements - An array of releases elements

Returns:

this builder for use in a chained invocation

setReleases

public final CChangelog.Builder setReleases(Iterable<? extends CRelease> elements)

Sets or replaces all elements for releases list.

Parameters:

elements - An iterable of releases elements

Returns:

this builder for use in a chained invocation

addAllReleases

public final CChangelog.Builder addAllReleases(Iterable<? extends CRelease> elements)

Adds elements to releases list.

Parameters:

elements - An iterable of releases elements

Returns:

this builder for use in a chained invocation

putTicketSystems

public final CChangelog.Builder putTicketSystems(String key,
                                                 URI value)

Put one entry to the ticketSystems map.

Parameters:

key - The key in the ticketSystems map

value - The associated value in the ticketSystems map

Returns:

this builder for use in a chained invocation

putTicketSystems

public final CChangelog.Builder putTicketSystems(Map.Entry<String,? extends URI> entry)

Put one entry to the ticketSystems map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

setTicketSystems

public final CChangelog.Builder setTicketSystems(Map<String,? extends URI> ticketSystems)

Sets or replaces all mappings from the specified map as entries for the ticketSystems map. Nulls are not permitted

Parameters:

ticketSystems - The entries that will be added to the ticketSystems map

Returns:

this builder for use in a chained invocation

putAllTicketSystems

public final CChangelog.Builder putAllTicketSystems(Map<String,? extends URI> ticketSystems)

Put all mappings from the specified map as entries to ticketSystems map. Nulls are not permitted

Parameters:

ticketSystems - The entries that will be added to the ticketSystems map

Returns:

this builder for use in a chained invocation

build

public CChangelog build()

Builds a new CChangelog.

Returns:

An immutable instance of CChangelog

Throws:

IllegalStateException - if any required attributes are missing