io.syndesis.verifier

Class ImmutableError.Builder

java.lang.Object

io.syndesis.verifier.ImmutableError.Builder

Enclosing class:

ImmutableError

public static final class ImmutableError.Builder
extends Object

Builds instances of type ImmutableError. 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
ImmutableError.Builder	addAllParameters(Iterable<String> elements) Adds elements to parameters list.
ImmutableError.Builder	addParameters(String... elements) Adds elements to parameters list.
ImmutableError.Builder	addParameters(String element) Adds one element to parameters list.
ImmutableError.Builder	attributes(Map<String,? extends Object> attributes) Sets or replaces all mappings from the specified map as entries for the attributes map.
ImmutableError	build() Builds a new ImmutableError.
ImmutableError.Builder	code(String code) Initializes the value for the code attribute.
ImmutableError.Builder	description(Optional<String> description) Initializes the optional value description to description.
ImmutableError.Builder	description(String description) Initializes the optional value description to description.
ImmutableError.Builder	from(Verifier.Error instance) Fill a builder with attribute values from the provided Error instance.
ImmutableError.Builder	parameters(Iterable<String> elements) Sets or replaces all elements for parameters list.
ImmutableError.Builder	putAllAttributes(Map<String,? extends Object> attributes) Put all mappings from the specified map as entries to attributes map.
ImmutableError.Builder	putAttributes(Map.Entry<String,? extends Object> entry) Put one entry to the attributes map.
ImmutableError.Builder	putAttributes(String key, Object value) Put one entry to the attributes map.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableError.Builder from(Verifier.Error instance)

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

code

public final ImmutableError.Builder code(String code)

Initializes the value for the code attribute.

Parameters:

code - The value for code

Returns:

this builder for use in a chained invocation

description

public final ImmutableError.Builder description(String description)

Initializes the optional value description to description.

Parameters:

description - The value for description

Returns:

this builder for chained invocation

description

public final ImmutableError.Builder description(Optional<String> description)

Initializes the optional value description to description.

Parameters:

description - The value for description

Returns:

this builder for use in a chained invocation

addParameters

public final ImmutableError.Builder addParameters(String element)

Adds one element to parameters list.

Parameters:

element - A parameters element

Returns:

this builder for use in a chained invocation

addParameters

public final ImmutableError.Builder addParameters(String... elements)

Adds elements to parameters list.

Parameters:

elements - An array of parameters elements

Returns:

this builder for use in a chained invocation

parameters

public final ImmutableError.Builder parameters(Iterable<String> elements)

Sets or replaces all elements for parameters list.

Parameters:

elements - An iterable of parameters elements

Returns:

this builder for use in a chained invocation

addAllParameters

public final ImmutableError.Builder addAllParameters(Iterable<String> elements)

Adds elements to parameters list.

Parameters:

elements - An iterable of parameters elements

Returns:

this builder for use in a chained invocation

putAttributes

public final ImmutableError.Builder putAttributes(String key,
                                                  Object value)

Put one entry to the attributes map.

Parameters:

key - The key in the attributes map

value - The associated value in the attributes map

Returns:

this builder for use in a chained invocation

putAttributes

public final ImmutableError.Builder putAttributes(Map.Entry<String,? extends Object> entry)

Put one entry to the attributes map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

attributes

public final ImmutableError.Builder attributes(Map<String,? extends Object> attributes)

Sets or replaces all mappings from the specified map as entries for the attributes map. Nulls are not permitted

Parameters:

attributes - The entries that will be added to the attributes map

Returns:

this builder for use in a chained invocation

putAllAttributes

public final ImmutableError.Builder putAllAttributes(Map<String,? extends Object> attributes)

Put all mappings from the specified map as entries to attributes map. Nulls are not permitted

Parameters:

attributes - The entries that will be added to the attributes map

Returns:

this builder for use in a chained invocation

build

public ImmutableError build()

Builds a new ImmutableError.

Returns:

An immutable instance of Error

Throws:

IllegalStateException - if any required attributes are missing