org.glowroot.agent.config

Class ImmutablePluginConfig.Builder

java.lang.Object

org.glowroot.agent.config.ImmutablePluginConfig.Builder

Enclosing class:

ImmutablePluginConfig

@NotThreadSafe
public static final class ImmutablePluginConfig.Builder
extends Object

Builds instances of type ImmutablePluginConfig. 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
ImmutablePluginConfig	build() Builds a new ImmutablePluginConfig.
ImmutablePluginConfig.Builder	copyFrom(PluginConfig instance) Fill a builder with attribute values from the provided PluginConfig instance.
ImmutablePluginConfig.Builder	pluginDescriptor(PluginDescriptor pluginDescriptor) Initializes the value for the pluginDescriptor attribute.
ImmutablePluginConfig.Builder	properties(Map<String,? extends PropertyValue> entries) Sets or replaces all mappings from the specified map as entries for the properties map.
ImmutablePluginConfig.Builder	putAllProperties(Map<String,? extends PropertyValue> entries) Put all mappings from the specified map as entries to properties map.
ImmutablePluginConfig.Builder	putProperties(Map.Entry<String,? extends PropertyValue> entry) Put one entry to the properties map.
ImmutablePluginConfig.Builder	putProperties(String key, PropertyValue value) Put one entry to the properties map.

Methods inherited from class java.lang.Object

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

Method Detail

build

public ImmutablePluginConfig build()

Builds a new ImmutablePluginConfig.

Returns:

An immutable instance of PluginConfig

Throws:

IllegalStateException - if any required attributes are missing

copyFrom

public final ImmutablePluginConfig.Builder copyFrom(PluginConfig instance)

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

pluginDescriptor

public final ImmutablePluginConfig.Builder pluginDescriptor(PluginDescriptor pluginDescriptor)

Initializes the value for the pluginDescriptor attribute.

Parameters:

pluginDescriptor - The value for pluginDescriptor

Returns:

this builder for use in a chained invocation

properties

public final ImmutablePluginConfig.Builder properties(Map<String,? extends PropertyValue> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllProperties

public final ImmutablePluginConfig.Builder putAllProperties(Map<String,? extends PropertyValue> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putProperties

public final ImmutablePluginConfig.Builder putProperties(Map.Entry<String,? extends PropertyValue> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

putProperties

public final ImmutablePluginConfig.Builder putProperties(String key,
                                                         PropertyValue value)

Put one entry to the properties map.

Parameters:

key - The key in the properties map

value - The associated value in the properties map

Returns:

this builder for use in a chained invocation