Module com.io7m.changelog.core

Package 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	Description
CChangelog	build()	Builds a new CChangelog.
CChangelog.Builder	from(CChangelogType instance)	Fill a builder with attribute values from the provided CChangelogType instance.
CChangelog.Builder	putEntryReleases(io.vavr.Tuple2<CVersionType,CRelease> entry)
CChangelog.Builder	putEntryTicketSystems(io.vavr.Tuple2<String,CTicketSystem> entry)
CChangelog.Builder	putReleases(CVersionType key, CRelease value)
CChangelog.Builder	putTicketSystems(String key, CTicketSystem value)
CChangelog.Builder	setEntriesReleases(Iterable<io.vavr.Tuple2<CVersionType,CRelease>> entries)
CChangelog.Builder	setEntriesTicketSystems(Iterable<io.vavr.Tuple2<String,CTicketSystem>> entries)
CChangelog.Builder	setJavaMapReleases(Map<CVersionType,CRelease> in_map)
CChangelog.Builder	setJavaMapTicketSystems(Map<String,CTicketSystem> in_map)
CChangelog.Builder	setMapReleases(io.vavr.collection.Map<CVersionType,CRelease> in_map)
CChangelog.Builder	setProject(CProjectName project)	Initializes the value for the project attribute.
CChangelog.Builder	setReleases(io.vavr.collection.SortedMap<CVersionType,CRelease> elements)
CChangelog.Builder	setTicketSystems(io.vavr.collection.Map<String,CTicketSystem> elements)

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.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setProject

public final CChangelog.Builder setProject(CProjectName project)

Initializes the value for the project attribute.

Parameters:

project - The value for project

Returns:

this builder for use in a chained invocation

putReleases

public CChangelog.Builder putReleases(CVersionType key,
                                      CRelease value)

putEntryReleases

public CChangelog.Builder putEntryReleases(io.vavr.Tuple2<CVersionType,CRelease> entry)

setReleases

public CChangelog.Builder setReleases(io.vavr.collection.SortedMap<CVersionType,CRelease> elements)

setJavaMapReleases

public CChangelog.Builder setJavaMapReleases(Map<CVersionType,CRelease> in_map)

setMapReleases

public CChangelog.Builder setMapReleases(io.vavr.collection.Map<CVersionType,CRelease> in_map)

setEntriesReleases

public CChangelog.Builder setEntriesReleases(Iterable<io.vavr.Tuple2<CVersionType,CRelease>> entries)

putTicketSystems

public CChangelog.Builder putTicketSystems(String key,
                                           CTicketSystem value)

putEntryTicketSystems

public CChangelog.Builder putEntryTicketSystems(io.vavr.Tuple2<String,CTicketSystem> entry)

setTicketSystems

public CChangelog.Builder setTicketSystems(io.vavr.collection.Map<String,CTicketSystem> elements)

setJavaMapTicketSystems

public CChangelog.Builder setJavaMapTicketSystems(Map<String,CTicketSystem> in_map)

setEntriesTicketSystems

public CChangelog.Builder setEntriesTicketSystems(Iterable<io.vavr.Tuple2<String,CTicketSystem>> entries)

build

public CChangelog build()

Builds a new CChangelog.

Returns:

An immutable instance of CChangelog

Throws:

IllegalStateException - if any required attributes are missing