org.glowroot.agent.config

Class ImmutablePluginDescriptor

java.lang.Object

org.glowroot.agent.config.PluginDescriptor

org.glowroot.agent.config.ImmutablePluginDescriptor

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutablePluginDescriptor
extends PluginDescriptor

Immutable implementation of PluginDescriptor.

Use the builder to create immutable instances: ImmutablePluginDescriptor.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutablePluginDescriptor.Builder Builds instances of type ImmutablePluginDescriptor.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<String>	aspects()
static ImmutablePluginDescriptor.Builder	builder() Creates a builder for ImmutablePluginDescriptor.
boolean	collocate()
static ImmutablePluginDescriptor	copyOf(PluginDescriptor instance) Creates an immutable copy of a PluginDescriptor value.
boolean	equals(Object another) This instance is equal to all instances of ImmutablePluginDescriptor that have equal attribute values.
int	hashCode() Computes a hash code from attributes: id, name, properties, instrumentationConfigs, aspects, collocate, pluginJar.
String	id()
com.google.common.collect.ImmutableList<InstrumentationConfig>	instrumentationConfigs()
String	name()
File	pluginJar()
com.google.common.collect.ImmutableList<PropertyDescriptor>	properties()
String	toString() Prints the immutable value PluginDescriptor with attribute values.
ImmutablePluginDescriptor	withAspects(Iterable<String> elements) Copy the current immutable object with elements that replace the content of aspects.
ImmutablePluginDescriptor	withAspects(String... elements) Copy the current immutable object with elements that replace the content of aspects.
ImmutablePluginDescriptor	withCollocate(boolean value) Copy the current immutable object by setting a value for the collocate attribute.
ImmutablePluginDescriptor	withId(String value) Copy the current immutable object by setting a value for the id attribute.
ImmutablePluginDescriptor	withInstrumentationConfigs(InstrumentationConfig... elements) Copy the current immutable object with elements that replace the content of instrumentationConfigs.
ImmutablePluginDescriptor	withInstrumentationConfigs(Iterable<? extends InstrumentationConfig> elements) Copy the current immutable object with elements that replace the content of instrumentationConfigs.
ImmutablePluginDescriptor	withName(String value) Copy the current immutable object by setting a value for the name attribute.
ImmutablePluginDescriptor	withPluginJar(File value) Copy the current immutable object by setting a value for the pluginJar attribute.
ImmutablePluginDescriptor	withProperties(Iterable<? extends PropertyDescriptor> elements) Copy the current immutable object with elements that replace the content of properties.
ImmutablePluginDescriptor	withProperties(PropertyDescriptor... elements) Copy the current immutable object with elements that replace the content of properties.

Methods inherited from class org.glowroot.agent.config.PluginDescriptor

readValue, writeValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

aspects

public com.google.common.collect.ImmutableList<String> aspects()

Specified by:

aspects in class PluginDescriptor

Returns:

The value of the aspects attribute

builder

public static ImmutablePluginDescriptor.Builder builder()

Creates a builder for ImmutablePluginDescriptor.

 ImmutablePluginDescriptor.builder()
    .id(String) // required id
    .name(String) // required name
    .addProperties|addAllProperties(org.glowroot.agent.config.PropertyDescriptor) // properties elements
    .addInstrumentationConfigs|addAllInstrumentationConfigs(org.glowroot.common.config.InstrumentationConfig) // instrumentationConfigs elements
    .addAspects|addAllAspects(String) // aspects elements
    .collocate(boolean) // optional collocate
    .pluginJar(java.io.File | null) // nullable pluginJar
    .build();
 

Returns:

A new ImmutablePluginDescriptor builder

collocate

public boolean collocate()

Overrides:

collocate in class PluginDescriptor

Returns:

The value of the collocate attribute

copyOf

public static ImmutablePluginDescriptor copyOf(PluginDescriptor instance)

Creates an immutable copy of a PluginDescriptor value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable PluginDescriptor instance

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutablePluginDescriptor that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: id, name, properties, instrumentationConfigs, aspects, collocate, pluginJar.

Overrides:

hashCode in class Object

Returns:

hashCode value

id

public String id()

Specified by:

id in class PluginDescriptor

Returns:

The value of the id attribute

instrumentationConfigs

public com.google.common.collect.ImmutableList<InstrumentationConfig> instrumentationConfigs()

Specified by:

instrumentationConfigs in class PluginDescriptor

Returns:

The value of the instrumentationConfigs attribute

name

public String name()

Specified by:

name in class PluginDescriptor

Returns:

The value of the name attribute

pluginJar

@Nullable
public File pluginJar()

Specified by:

pluginJar in class PluginDescriptor

Returns:

The value of the pluginJar attribute

properties

public com.google.common.collect.ImmutableList<PropertyDescriptor> properties()

Specified by:

properties in class PluginDescriptor

Returns:

The value of the properties attribute

toString

public String toString()

Prints the immutable value PluginDescriptor with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

withAspects

public final ImmutablePluginDescriptor withAspects(Iterable<String> elements)

Copy the current immutable object with elements that replace the content of aspects. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of aspects elements to set

Returns:

A modified copy of this object

withAspects

public final ImmutablePluginDescriptor withAspects(String... elements)

Copy the current immutable object with elements that replace the content of aspects.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withCollocate

public final ImmutablePluginDescriptor withCollocate(boolean value)

Copy the current immutable object by setting a value for the collocate attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for collocate

Returns:

A modified copy of the this object

withId

public final ImmutablePluginDescriptor withId(String value)

Copy the current immutable object by setting a value for the id attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for id

Returns:

A modified copy of the this object

withInstrumentationConfigs

public final ImmutablePluginDescriptor withInstrumentationConfigs(InstrumentationConfig... elements)

Copy the current immutable object with elements that replace the content of instrumentationConfigs.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withInstrumentationConfigs

public final ImmutablePluginDescriptor withInstrumentationConfigs(Iterable<? extends InstrumentationConfig> elements)

Copy the current immutable object with elements that replace the content of instrumentationConfigs. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of instrumentationConfigs elements to set

Returns:

A modified copy of this object

withName

public final ImmutablePluginDescriptor withName(String value)

Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withPluginJar

public final ImmutablePluginDescriptor withPluginJar(@Nullable
                                                     File value)

Copy the current immutable object by setting a value for the pluginJar attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for pluginJar (can be null)

Returns:

A modified copy of the this object

withProperties

public final ImmutablePluginDescriptor withProperties(Iterable<? extends PropertyDescriptor> elements)

Copy the current immutable object with elements that replace the content of properties. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of properties elements to set

Returns:

A modified copy of this object

withProperties

public final ImmutablePluginDescriptor withProperties(PropertyDescriptor... elements)

Copy the current immutable object with elements that replace the content of properties.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object