org.glowroot.agent.config

Class ImmutablePluginDescriptor.Builder

java.lang.Object

org.glowroot.agent.config.ImmutablePluginDescriptor.Builder

Enclosing class:

ImmutablePluginDescriptor

@NotThreadSafe
public static final class ImmutablePluginDescriptor.Builder
extends Object

Builds instances of type ImmutablePluginDescriptor. 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
ImmutablePluginDescriptor.Builder	addAllAspects(Iterable<String> elements) Adds elements to aspects list.
ImmutablePluginDescriptor.Builder	addAllInstrumentationConfigs(Iterable<? extends InstrumentationConfig> elements) Adds elements to instrumentationConfigs list.
ImmutablePluginDescriptor.Builder	addAllProperties(Iterable<? extends PropertyDescriptor> elements) Adds elements to properties list.
ImmutablePluginDescriptor.Builder	addAspects(String... elements) Adds elements to aspects list.
ImmutablePluginDescriptor.Builder	addAspects(String element) Adds one element to aspects list.
ImmutablePluginDescriptor.Builder	addInstrumentationConfigs(InstrumentationConfig... elements) Adds elements to instrumentationConfigs list.
ImmutablePluginDescriptor.Builder	addInstrumentationConfigs(InstrumentationConfig element) Adds one element to instrumentationConfigs list.
ImmutablePluginDescriptor.Builder	addProperties(PropertyDescriptor... elements) Adds elements to properties list.
ImmutablePluginDescriptor.Builder	addProperties(PropertyDescriptor element) Adds one element to properties list.
ImmutablePluginDescriptor.Builder	aspects(Iterable<String> elements) Sets or replaces all elements for aspects list.
ImmutablePluginDescriptor	build() Builds a new ImmutablePluginDescriptor.
ImmutablePluginDescriptor.Builder	collocate(boolean collocate) Initializes the value for the collocate attribute.
ImmutablePluginDescriptor.Builder	copyFrom(PluginDescriptor instance) Fill a builder with attribute values from the provided PluginDescriptor instance.
ImmutablePluginDescriptor.Builder	id(String id) Initializes the value for the id attribute.
ImmutablePluginDescriptor.Builder	instrumentationConfigs(Iterable<? extends InstrumentationConfig> elements) Sets or replaces all elements for instrumentationConfigs list.
ImmutablePluginDescriptor.Builder	name(String name) Initializes the value for the name attribute.
ImmutablePluginDescriptor.Builder	pluginJar(File pluginJar) Initializes the value for the pluginJar attribute.
ImmutablePluginDescriptor.Builder	properties(Iterable<? extends PropertyDescriptor> elements) Sets or replaces all elements for properties list.

Methods inherited from class java.lang.Object

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

Method Detail

addAllAspects

public final ImmutablePluginDescriptor.Builder addAllAspects(Iterable<String> elements)

Adds elements to aspects list.

Parameters:

elements - An iterable of aspects elements

Returns:

this builder for use in a chained invocation

addAllInstrumentationConfigs

public final ImmutablePluginDescriptor.Builder addAllInstrumentationConfigs(Iterable<? extends InstrumentationConfig> elements)

Adds elements to instrumentationConfigs list.

Parameters:

elements - An iterable of instrumentationConfigs elements

Returns:

this builder for use in a chained invocation

addAllProperties

public final ImmutablePluginDescriptor.Builder addAllProperties(Iterable<? extends PropertyDescriptor> elements)

Adds elements to properties list.

Parameters:

elements - An iterable of properties elements

Returns:

this builder for use in a chained invocation

addAspects

public final ImmutablePluginDescriptor.Builder addAspects(String... elements)

Adds elements to aspects list.

Parameters:

elements - An array of aspects elements

Returns:

this builder for use in a chained invocation

addAspects

public final ImmutablePluginDescriptor.Builder addAspects(String element)

Adds one element to aspects list.

Parameters:

element - A aspects element

Returns:

this builder for use in a chained invocation

addInstrumentationConfigs

public final ImmutablePluginDescriptor.Builder addInstrumentationConfigs(InstrumentationConfig... elements)

Adds elements to instrumentationConfigs list.

Parameters:

elements - An array of instrumentationConfigs elements

Returns:

this builder for use in a chained invocation

addInstrumentationConfigs

public final ImmutablePluginDescriptor.Builder addInstrumentationConfigs(InstrumentationConfig element)

Adds one element to instrumentationConfigs list.

Parameters:

element - A instrumentationConfigs element

Returns:

this builder for use in a chained invocation

addProperties

public final ImmutablePluginDescriptor.Builder addProperties(PropertyDescriptor... elements)

Adds elements to properties list.

Parameters:

elements - An array of properties elements

Returns:

this builder for use in a chained invocation

addProperties

public final ImmutablePluginDescriptor.Builder addProperties(PropertyDescriptor element)

Adds one element to properties list.

Parameters:

element - A properties element

Returns:

this builder for use in a chained invocation

aspects

public final ImmutablePluginDescriptor.Builder aspects(Iterable<String> elements)

Sets or replaces all elements for aspects list.

Parameters:

elements - An iterable of aspects elements

Returns:

this builder for use in a chained invocation

build

public ImmutablePluginDescriptor build()

Builds a new ImmutablePluginDescriptor.

Returns:

An immutable instance of PluginDescriptor

Throws:

IllegalStateException - if any required attributes are missing

collocate

public final ImmutablePluginDescriptor.Builder collocate(boolean collocate)

Initializes the value for the collocate attribute.

If not set, this attribute will have a default value as returned by the initializer of collocate.

Parameters:

collocate - The value for collocate

Returns:

this builder for use in a chained invocation

copyFrom

public final ImmutablePluginDescriptor.Builder copyFrom(PluginDescriptor instance)

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

id

public final ImmutablePluginDescriptor.Builder id(String id)

Initializes the value for the id attribute.

Parameters:

id - The value for id

Returns:

this builder for use in a chained invocation

instrumentationConfigs

public final ImmutablePluginDescriptor.Builder instrumentationConfigs(Iterable<? extends InstrumentationConfig> elements)

Sets or replaces all elements for instrumentationConfigs list.

Parameters:

elements - An iterable of instrumentationConfigs elements

Returns:

this builder for use in a chained invocation

name

public final ImmutablePluginDescriptor.Builder name(String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

pluginJar

public final ImmutablePluginDescriptor.Builder pluginJar(@Nullable
                                                         File pluginJar)

Initializes the value for the pluginJar attribute.

Parameters:

pluginJar - The value for pluginJar (can be null)

Returns:

this builder for use in a chained invocation

properties

public final ImmutablePluginDescriptor.Builder properties(Iterable<? extends PropertyDescriptor> elements)

Sets or replaces all elements for properties list.

Parameters:

elements - An iterable of properties elements

Returns:

this builder for use in a chained invocation