Package com.io7m.minisite.core

Class MinDocumentationItem.Builder

java.lang.Object

com.io7m.minisite.core.MinDocumentationItem.Builder

Enclosing class:

MinDocumentationItem

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

Builds instances of type MinDocumentationItem. 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
MinDocumentationItem	build()	Builds a new MinDocumentationItem.
MinDocumentationItem.Builder	from(MinDocumentationItemType instance)	Fill a builder with attribute values from the provided MinDocumentationItemType instance.
MinDocumentationItem.Builder	setFormats(io.vavr.collection.Vector<MinDocumentationFormat> formats)	Initializes the value for the formats attribute.
MinDocumentationItem.Builder	setName(java.lang.String name)	Initializes the value for the name attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final MinDocumentationItem.Builder from(MinDocumentationItemType instance)

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

setName

public final MinDocumentationItem.Builder setName(java.lang.String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

setFormats

public final MinDocumentationItem.Builder setFormats(io.vavr.collection.Vector<MinDocumentationFormat> formats)

Initializes the value for the formats attribute.

Parameters:

formats - The value for formats

Returns:

this builder for use in a chained invocation

build

public MinDocumentationItem build()

Builds a new MinDocumentationItem.

Returns:

An immutable instance of MinDocumentationItem

Throws:

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