io.syndesis.integration.component.proxy

Class ImmutableComponentDefinition.Builder

java.lang.Object

io.syndesis.integration.component.proxy.ImmutableComponentDefinition.Builder

Enclosing class:

ImmutableComponentDefinition

public static final class ImmutableComponentDefinition.Builder
extends Object

Builds instances of type ImmutableComponentDefinition. 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.

Constructor Summary

Constructors

Constructor and Description
Builder() Creates a builder for ImmutableComponentDefinition instances.

Method Summary

Modifier and Type	Method and Description
ImmutableComponentDefinition	build() Builds a new ImmutableComponentDefinition.
ImmutableComponentDefinition.Builder	component(ComponentDefinition.Component component) Initializes the value for the component attribute.
ImmutableComponentDefinition.Builder	componentProperties(Map<String,? extends ComponentDefinition.Property> entries) Sets or replaces all mappings from the specified map as entries for the componentProperties map.
ImmutableComponentDefinition.Builder	endpointProperties(Map<String,? extends ComponentDefinition.Property> entries) Sets or replaces all mappings from the specified map as entries for the endpointProperties map.
ImmutableComponentDefinition.Builder	from(ComponentDefinition instance) Fill a builder with attribute values from the provided ComponentDefinition instance.
ImmutableComponentDefinition.Builder	putAllComponentProperties(Map<String,? extends ComponentDefinition.Property> entries) Put all mappings from the specified map as entries to componentProperties map.
ImmutableComponentDefinition.Builder	putAllEndpointProperties(Map<String,? extends ComponentDefinition.Property> entries) Put all mappings from the specified map as entries to endpointProperties map.
ImmutableComponentDefinition.Builder	putComponentProperties(Map.Entry<String,? extends ComponentDefinition.Property> entry) Put one entry to the componentProperties map.
ImmutableComponentDefinition.Builder	putComponentProperties(String key, ComponentDefinition.Property value) Put one entry to the componentProperties map.
ImmutableComponentDefinition.Builder	putEndpointProperties(Map.Entry<String,? extends ComponentDefinition.Property> entry) Put one entry to the endpointProperties map.
ImmutableComponentDefinition.Builder	putEndpointProperties(String key, ComponentDefinition.Property value) Put one entry to the endpointProperties map.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a builder for ImmutableComponentDefinition instances.

 new ImmutableComponentDefinition.Builder()
    .component(io.syndesis.integration.component.proxy.ComponentDefinition.Component) // required component
    .putComponentProperties|putAllComponentProperties(String => io.syndesis.integration.component.proxy.ComponentDefinition.Property) // componentProperties mappings
    .putEndpointProperties|putAllEndpointProperties(String => io.syndesis.integration.component.proxy.ComponentDefinition.Property) // endpointProperties mappings
    .build();
 

Method Detail

from

public final ImmutableComponentDefinition.Builder from(ComponentDefinition instance)

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

component

public final ImmutableComponentDefinition.Builder component(ComponentDefinition.Component component)

Initializes the value for the component attribute.

Parameters:

component - The value for component

Returns:

this builder for use in a chained invocation

putComponentProperties

public final ImmutableComponentDefinition.Builder putComponentProperties(String key,
                                                                         ComponentDefinition.Property value)

Put one entry to the componentProperties map.

Parameters:

key - The key in the componentProperties map

value - The associated value in the componentProperties map

Returns:

this builder for use in a chained invocation

putComponentProperties

public final ImmutableComponentDefinition.Builder putComponentProperties(Map.Entry<String,? extends ComponentDefinition.Property> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

componentProperties

public final ImmutableComponentDefinition.Builder componentProperties(Map<String,? extends ComponentDefinition.Property> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllComponentProperties

public final ImmutableComponentDefinition.Builder putAllComponentProperties(Map<String,? extends ComponentDefinition.Property> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putEndpointProperties

public final ImmutableComponentDefinition.Builder putEndpointProperties(String key,
                                                                        ComponentDefinition.Property value)

Put one entry to the endpointProperties map.

Parameters:

key - The key in the endpointProperties map

value - The associated value in the endpointProperties map

Returns:

this builder for use in a chained invocation

putEndpointProperties

public final ImmutableComponentDefinition.Builder putEndpointProperties(Map.Entry<String,? extends ComponentDefinition.Property> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

endpointProperties

public final ImmutableComponentDefinition.Builder endpointProperties(Map<String,? extends ComponentDefinition.Property> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllEndpointProperties

public final ImmutableComponentDefinition.Builder putAllEndpointProperties(Map<String,? extends ComponentDefinition.Property> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

build

public ImmutableComponentDefinition build()

Builds a new ImmutableComponentDefinition.

Returns:

An immutable instance of ComponentDefinition

Throws:

IllegalStateException - if any required attributes are missing