org.glowroot.agent.config

Class ImmutablePropertyDescriptor.Builder

java.lang.Object

org.glowroot.agent.config.ImmutablePropertyDescriptor.Builder

Enclosing class:

ImmutablePropertyDescriptor

@NotThreadSafe
public static final class ImmutablePropertyDescriptor.Builder
extends Object

Builds instances of type ImmutablePropertyDescriptor. 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
ImmutablePropertyDescriptor	build() Builds a new ImmutablePropertyDescriptor.
ImmutablePropertyDescriptor.Builder	checkboxLabel(String checkboxLabel) Initializes the value for the checkboxLabel attribute.
ImmutablePropertyDescriptor.Builder	copyFrom(PropertyDescriptor instance) Fill a builder with attribute values from the provided PropertyDescriptor instance.
ImmutablePropertyDescriptor.Builder	defaultValue(PropertyValue defaultValue) Initializes the value for the defaultValue attribute.
ImmutablePropertyDescriptor.Builder	description(String description) Initializes the value for the description attribute.
ImmutablePropertyDescriptor.Builder	label(String label) Initializes the value for the label attribute.
ImmutablePropertyDescriptor.Builder	name(String name) Initializes the value for the name attribute.
ImmutablePropertyDescriptor.Builder	type(PropertyValue.PropertyType type) Initializes the value for the type attribute.

Methods inherited from class java.lang.Object

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

Method Detail

build

public ImmutablePropertyDescriptor build()

Builds a new ImmutablePropertyDescriptor.

Returns:

An immutable instance of PropertyDescriptor

Throws:

IllegalStateException - if any required attributes are missing

checkboxLabel

public final ImmutablePropertyDescriptor.Builder checkboxLabel(String checkboxLabel)

Initializes the value for the checkboxLabel attribute.

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

Parameters:

checkboxLabel - The value for checkboxLabel

Returns:

this builder for use in a chained invocation

copyFrom

public final ImmutablePropertyDescriptor.Builder copyFrom(PropertyDescriptor instance)

Fill a builder with attribute values from the provided PropertyDescriptor instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

defaultValue

public final ImmutablePropertyDescriptor.Builder defaultValue(PropertyValue defaultValue)

Initializes the value for the defaultValue attribute.

Parameters:

defaultValue - The value for defaultValue (can be null)

Returns:

this builder for use in a chained invocation

description

public final ImmutablePropertyDescriptor.Builder description(String description)

Initializes the value for the description attribute.

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

Parameters:

description - The value for description

Returns:

this builder for use in a chained invocation

label

public final ImmutablePropertyDescriptor.Builder label(String label)

Initializes the value for the label attribute.

Parameters:

label - The value for label

Returns:

this builder for use in a chained invocation

name

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

type

public final ImmutablePropertyDescriptor.Builder type(PropertyValue.PropertyType type)

Initializes the value for the type attribute.

Parameters:

type - The value for type

Returns:

this builder for use in a chained invocation