Package com.io7m.minisite.core

Class MinDocumentationFormat.Builder

java.lang.Object

com.io7m.minisite.core.MinDocumentationFormat.Builder

Enclosing class:

MinDocumentationFormat

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

Builds instances of type MinDocumentationFormat. 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
MinDocumentationFormat	build()	Builds a new MinDocumentationFormat.
MinDocumentationFormat.Builder	from(MinDocumentationFormatType instance)	Fill a builder with attribute values from the provided MinDocumentationFormatType instance.
MinDocumentationFormat.Builder	setName(java.lang.String name)	Initializes the value for the name attribute.
MinDocumentationFormat.Builder	setPath(java.nio.file.Path path)	Initializes the value for the path attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final MinDocumentationFormat.Builder from(MinDocumentationFormatType instance)

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

setPath

public final MinDocumentationFormat.Builder setPath(java.nio.file.Path path)

Initializes the value for the path attribute.

Parameters:

path - The value for path

Returns:

this builder for use in a chained invocation

build

public MinDocumentationFormat build()

Builds a new MinDocumentationFormat.

Returns:

An immutable instance of MinDocumentationFormat

Throws:

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