com.io7m.changelog.core

Class CItem.Builder

java.lang.Object

com.io7m.changelog.core.CItem.Builder

Enclosing class:

CItem

public static final class CItem.Builder
extends Object

Builds instances of type CItem. 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
CItem.Builder	addAllTickets(Iterable<String> elements) Adds elements to tickets list.
CItem.Builder	addTickets(String... elements) Adds elements to tickets list.
CItem.Builder	addTickets(String element) Adds one element to tickets list.
CItem	build() Builds a new CItem.
CItem.Builder	from(CItemType instance) Fill a builder with attribute values from the provided CItemType instance.
CItem.Builder	setDate(LocalDate date) Initializes the value for the date attribute.
CItem.Builder	setSummary(String summary) Initializes the value for the summary attribute.
CItem.Builder	setTickets(Iterable<String> elements) Sets or replaces all elements for tickets list.
CItem.Builder	setType(CChangeType type) Initializes the value for the type attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final CItem.Builder from(CItemType instance)

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

setSummary

public final CItem.Builder setSummary(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 final CItem.Builder addTickets(String element)

Adds one element to tickets list.

Parameters:

element - A tickets element

Returns:

this builder for use in a chained invocation

addTickets

public final CItem.Builder addTickets(String... elements)

Adds elements to tickets list.

Parameters:

elements - An array of tickets elements

Returns:

this builder for use in a chained invocation

setTickets

public final CItem.Builder setTickets(Iterable<String> elements)

Sets or replaces all elements for tickets list.

Parameters:

elements - An iterable of tickets elements

Returns:

this builder for use in a chained invocation

addAllTickets

public final CItem.Builder addAllTickets(Iterable<String> elements)

Adds elements to tickets list.

Parameters:

elements - An iterable of tickets elements

Returns:

this builder for use in a chained invocation

setType

public final CItem.Builder setType(CChangeType type)

Initializes the value for the type attribute.

Parameters:

type - The value for type

Returns:

this builder for use in a chained invocation

build

public CItem build()

Builds a new CItem.

Returns:

An immutable instance of CItem

Throws:

IllegalStateException - if any required attributes are missing