org.glowroot.agent.config

Class ImmutablePropertyDescriptor

java.lang.Object

org.glowroot.agent.config.PropertyDescriptor

org.glowroot.agent.config.ImmutablePropertyDescriptor

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

Immutable implementation of PropertyDescriptor.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutablePropertyDescriptor.Builder	builder() Creates a builder for ImmutablePropertyDescriptor.
String	checkboxLabel()
static ImmutablePropertyDescriptor	copyOf(PropertyDescriptor instance) Creates an immutable copy of a PropertyDescriptor value.
PropertyValue	defaultValue()
String	description()
boolean	equals(Object another) This instance is equal to all instances of ImmutablePropertyDescriptor that have equal attribute values.
int	hashCode() Computes a hash code from attributes: name, type, defaultValue, label, checkboxLabel, description.
String	label()
String	name()
String	toString() Prints the immutable value PropertyDescriptor with attribute values.
PropertyValue.PropertyType	type()
ImmutablePropertyDescriptor	withCheckboxLabel(String value) Copy the current immutable object by setting a value for the checkboxLabel attribute.
ImmutablePropertyDescriptor	withDefaultValue(PropertyValue value) Copy the current immutable object by setting a value for the defaultValue attribute.
ImmutablePropertyDescriptor	withDescription(String value) Copy the current immutable object by setting a value for the description attribute.
ImmutablePropertyDescriptor	withLabel(String value) Copy the current immutable object by setting a value for the label attribute.
ImmutablePropertyDescriptor	withName(String value) Copy the current immutable object by setting a value for the name attribute.
ImmutablePropertyDescriptor	withType(PropertyValue.PropertyType value) Copy the current immutable object by setting a value for the type attribute.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ImmutablePropertyDescriptor.Builder builder()

Creates a builder for ImmutablePropertyDescriptor.

 ImmutablePropertyDescriptor.builder()
    .name(String) // required name
    .type(org.glowroot.common.config.PropertyValue.PropertyType) // required type
    .defaultValue(org.glowroot.common.config.PropertyValue | null) // nullable defaultValue
    .label(String) // required label
    .checkboxLabel(String) // optional checkboxLabel
    .description(String) // optional description
    .build();
 

Returns:

A new ImmutablePropertyDescriptor builder

checkboxLabel

public String checkboxLabel()

Overrides:

checkboxLabel in class PropertyDescriptor

Returns:

The value of the checkboxLabel attribute

copyOf

public static ImmutablePropertyDescriptor copyOf(PropertyDescriptor instance)

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

defaultValue

public PropertyValue defaultValue()

Specified by:

defaultValue in class PropertyDescriptor

Returns:

The value of the defaultValue attribute

description

public String description()

Overrides:

description in class PropertyDescriptor

Returns:

The value of the description attribute

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutablePropertyDescriptor 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: name, type, defaultValue, label, checkboxLabel, description.

Overrides:

hashCode in class Object

Returns:

hashCode value

label

public String label()

Specified by:

label in class PropertyDescriptor

Returns:

The value of the label attribute

name

public String name()

Specified by:

name in class PropertyDescriptor

Returns:

The value of the name attribute

toString

public String toString()

Prints the immutable value PropertyDescriptor with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

type

public PropertyValue.PropertyType type()

Specified by:

type in class PropertyDescriptor

Returns:

The value of the type attribute

withCheckboxLabel

public final ImmutablePropertyDescriptor withCheckboxLabel(String value)

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

Parameters:

value - A new value for checkboxLabel

Returns:

A modified copy of the this object

withDefaultValue

public final ImmutablePropertyDescriptor withDefaultValue(PropertyValue value)

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

Parameters:

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

Returns:

A modified copy of the this object

withDescription

public final ImmutablePropertyDescriptor withDescription(String value)

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

Parameters:

value - A new value for description

Returns:

A modified copy of the this object

withLabel

public final ImmutablePropertyDescriptor withLabel(String value)

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

Parameters:

value - A new value for label

Returns:

A modified copy of the this object

withName

public final ImmutablePropertyDescriptor 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

withType

public final ImmutablePropertyDescriptor withType(PropertyValue.PropertyType value)

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

Parameters:

value - A new value for type

Returns:

A modified copy of the this object