Package com.io7m.changelog.core

Class CChange.Builder

java.lang.Object

com.io7m.changelog.core.CChange.Builder

Enclosing class:

CChange

public static final class CChange.Builder
extends java.lang.Object

Builds instances of type CChange. 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
CChange.Builder	addAllTickets(java.lang.Iterable<java.lang.String> element)
CChange.Builder	addTickets(java.lang.String element)
CChange	build()	Builds a new CChange.
CChange.Builder	from(CChangeType instance)	Fill a builder with attribute values from the provided CChangeType instance.
CChange.Builder	setBackwardsCompatible(boolean backwardsCompatible)	Initializes the value for the backwardsCompatible attribute.
CChange.Builder	setDate(java.time.ZonedDateTime date)	Initializes the value for the date attribute.
CChange.Builder	setIterableTickets(java.lang.Iterable<java.lang.String> elements)
CChange.Builder	setModule(java.lang.String module)	Initializes the optional value module to module.
CChange.Builder	setModule(java.util.Optional<java.lang.String> module)	Initializes the optional value module to module.
CChange.Builder	setSummary(java.lang.String summary)	Initializes the value for the summary attribute.
CChange.Builder	setTickets(io.vavr.collection.List<java.lang.String> elements)

Methods inherited from class java.lang.Object

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

Method Detail

from

public final CChange.Builder from(CChangeType instance)

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

setDate

public final CChange.Builder setDate(java.time.ZonedDateTime date)

Initializes the value for the date attribute.

Parameters:

date - The value for date

Returns:

this builder for use in a chained invocation

setSummary

public final CChange.Builder setSummary(java.lang.String summary)

Initializes the value for the summary attribute.

Parameters:

summary - The value for summary

Returns:

this builder for use in a chained invocation

addTickets

public CChange.Builder addTickets(java.lang.String element)

addAllTickets

public CChange.Builder addAllTickets(java.lang.Iterable<java.lang.String> element)

setTickets

public CChange.Builder setTickets(io.vavr.collection.List<java.lang.String> elements)

setIterableTickets

public CChange.Builder setIterableTickets(java.lang.Iterable<java.lang.String> elements)

setModule

public final CChange.Builder setModule(java.lang.String module)

Initializes the optional value module to module.

Parameters:

module - The value for module

Returns:

this builder for chained invocation

setModule

public final CChange.Builder setModule(java.util.Optional<java.lang.String> module)

Initializes the optional value module to module.

Parameters:

module - The value for module

Returns:

this builder for use in a chained invocation

setBackwardsCompatible

public final CChange.Builder setBackwardsCompatible(boolean backwardsCompatible)

Initializes the value for the backwardsCompatible attribute.

If not set, this attribute will have a default value as returned by the initializer of backwardsCompatible.

Parameters:

backwardsCompatible - The value for backwardsCompatible

Returns:

this builder for use in a chained invocation

build

public CChange build()

Builds a new CChange.

Returns:

An immutable instance of CChange

Throws:

java.lang.IllegalStateException - if any required attributes are missing