org.glowroot.agent.config

Class ImmutablePluginConfig

java.lang.Object

org.glowroot.agent.config.PluginConfig

org.glowroot.agent.config.ImmutablePluginConfig

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

Immutable implementation of PluginConfig.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutablePluginConfig.Builder	builder() Creates a builder for ImmutablePluginConfig.
static ImmutablePluginConfig	copyOf(PluginConfig instance) Creates an immutable copy of a PluginConfig value.
boolean	equals(Object another) This instance is equal to all instances of ImmutablePluginConfig that have equal attribute values.
int	hashCode() Computes a hash code from attributes: pluginDescriptor, id, properties, booleanProperties, stringProperties, doubleProperties, listProperties.
String	id()
PluginDescriptor	pluginDescriptor()
com.google.common.collect.ImmutableMap<String,PropertyValue>	properties()
String	toString() Prints the immutable value PluginConfig with attribute values.
ImmutablePluginConfig	withPluginDescriptor(PluginDescriptor value) Copy the current immutable object by setting a value for the pluginDescriptor attribute.
ImmutablePluginConfig	withProperties(Map<String,? extends PropertyValue> entries) Copy the current immutable object by replacing the properties map with the specified map.

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

create, getBooleanProperty, getDoubleProperty, getListProperty, getStringProperty, toProto

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ImmutablePluginConfig.Builder builder()

Creates a builder for ImmutablePluginConfig.

 ImmutablePluginConfig.builder()
    .pluginDescriptor(org.glowroot.agent.config.PluginDescriptor) // required pluginDescriptor
    .putProperties|putAllProperties(String => org.glowroot.common.config.PropertyValue) // properties mappings
    .build();
 

Returns:

A new ImmutablePluginConfig builder

copyOf

public static ImmutablePluginConfig copyOf(PluginConfig instance)

Creates an immutable copy of a PluginConfig 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 PluginConfig instance

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutablePluginConfig 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: pluginDescriptor, id, properties, booleanProperties, stringProperties, doubleProperties, listProperties.

Overrides:

hashCode in class Object

Returns:

hashCode value

id

public String id()

Overrides:

id in class PluginConfig

Returns:

The computed-at-construction value of the id attribute

pluginDescriptor

public PluginDescriptor pluginDescriptor()

Specified by:

pluginDescriptor in class PluginConfig

Returns:

The value of the pluginDescriptor attribute

properties

public com.google.common.collect.ImmutableMap<String,PropertyValue> properties()

Specified by:

properties in class PluginConfig

Returns:

The value of the properties attribute

toString

public String toString()

Prints the immutable value PluginConfig with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

withPluginDescriptor

public final ImmutablePluginConfig withPluginDescriptor(PluginDescriptor value)

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

Parameters:

value - A new value for pluginDescriptor

Returns:

A modified copy of the this object

withProperties

public final ImmutablePluginConfig withProperties(Map<String,? extends PropertyValue> entries)

Copy the current immutable object by replacing the properties map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the properties map

Returns:

A modified copy of this object