io.riada.insight.model

Class ImmutableDocumentationProvider.Builder

java.lang.Object

io.riada.insight.model.ImmutableDocumentationProvider.Builder

Enclosing class:

ImmutableDocumentationProvider

@NotThreadSafe
public static final class ImmutableDocumentationProvider.Builder
extends Object

Builds instances of type ImmutableDocumentationProvider. 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
ImmutableDocumentationProvider	build() Builds a new ImmutableDocumentationProvider.
ImmutableDocumentationProvider.Builder	from(DocumentationProvider instance) Fill a builder with attribute values from the provided DocumentationProvider instance.
ImmutableDocumentationProvider.Builder	setId(String id) Initializes the value for the id attribute.
ImmutableDocumentationProvider.Builder	setName(String name) Initializes the value for the name attribute.
ImmutableDocumentationProvider.Builder	setUri(String uri) Initializes the value for the uri attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableDocumentationProvider.Builder from(DocumentationProvider instance)

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

setId

@CanIgnoreReturnValue
public final ImmutableDocumentationProvider.Builder setId(String id)

Initializes the value for the id attribute.

Parameters:

id - The value for id

Returns:

this builder for use in a chained invocation

setName

@CanIgnoreReturnValue
public final ImmutableDocumentationProvider.Builder setName(String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

setUri

@CanIgnoreReturnValue
public final ImmutableDocumentationProvider.Builder setUri(String uri)

Initializes the value for the uri attribute.

Parameters:

uri - The value for uri

Returns:

this builder for use in a chained invocation

build

public ImmutableDocumentationProvider build()

Builds a new ImmutableDocumentationProvider.

Returns:

An immutable instance of DocumentationProvider

Throws:

IllegalStateException - if any required attributes are missing