org.glowroot.common.config.ImmutableGaugeConfig Maven / Gradle / Ivy
package org.glowroot.common.config;
import org.glowroot.agent.shaded.fasterxml.jackson.annotation.JsonCreator;
import org.glowroot.agent.shaded.fasterxml.jackson.annotation.JsonIgnore;
import org.glowroot.agent.shaded.fasterxml.jackson.annotation.JsonProperty;
import org.glowroot.agent.shaded.google.common.base.MoreObjects;
import org.glowroot.agent.shaded.google.common.base.Preconditions;
import org.glowroot.agent.shaded.google.common.collect.ImmutableList;
import org.glowroot.agent.shaded.google.common.collect.Lists;
import java.util.List;
import javax.annotation.Generated;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
/**
* Immutable implementation of {@link GaugeConfig}.
*
* Use builder to create immutable instances:
* {@code ImmutableGaugeConfig.builder()}.
*/
@SuppressWarnings("all")
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "GaugeConfig"})
@Immutable
public final class ImmutableGaugeConfig extends GaugeConfig {
private final String mbeanObjectName;
private final ImmutableList mbeanAttributes;
private final String version;
private ImmutableGaugeConfig(
String mbeanObjectName,
ImmutableList mbeanAttributes) {
this.mbeanObjectName = mbeanObjectName;
this.mbeanAttributes = mbeanAttributes;
this.version = Preconditions.checkNotNull(super.version());
}
/**
* @return value of {@code mbeanObjectName} attribute
*/
@JsonProperty
@Override
public String mbeanObjectName() {
return mbeanObjectName;
}
/**
* @return value of {@code mbeanAttributes} attribute
*/
@JsonProperty
@Override
public ImmutableList mbeanAttributes() {
return mbeanAttributes;
}
/**
* @return computed at construction value of {@code version} attribute
*/
@JsonProperty
@JsonIgnore
@Override
public String version() {
return version;
}
/**
* Copy current immutable object by setting value for {@link GaugeConfig#mbeanObjectName() mbeanObjectName}.
* Shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param value new value for mbeanObjectName
* @return modified copy of the {@code this} object
*/
public final ImmutableGaugeConfig withMbeanObjectName(String value) {
if (this.mbeanObjectName == value) return this;
String newValue = Preconditions.checkNotNull(value);
return new ImmutableGaugeConfig(newValue, this.mbeanAttributes);
}
/**
* Copy current immutable object with elements that replace content of {@link GaugeConfig#mbeanAttributes() mbeanAttributes}.
* @param elements elements to set
* @return modified copy of {@code this} object
*/
public final ImmutableGaugeConfig withMbeanAttributes(GaugeConfig.MBeanAttribute... elements) {
ImmutableList newValue = ImmutableList.copyOf(elements);
return new ImmutableGaugeConfig(this.mbeanObjectName, newValue);
}
/**
* Copy current immutable object with elements that replace content of {@link GaugeConfig#mbeanAttributes() mbeanAttributes}.
* Shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param elements iterable of mbeanAttributes elements to set
* @return modified copy of {@code this} object
*/
public final ImmutableGaugeConfig withMbeanAttributes(Iterable elements) {
if (this.mbeanAttributes == elements) return this;
ImmutableList newValue = ImmutableList.copyOf(elements);
return new ImmutableGaugeConfig(this.mbeanObjectName, newValue);
}
/**
* This instance is equal to instances of {@code ImmutableGaugeConfig} with equal attribute values.
* @return {@code true} if {@code this} is equal to {@code another} instance
*/
@Override
public boolean equals(@Nullable Object another) {
if (this == another) return true;
return another instanceof ImmutableGaugeConfig
&& equalTo((ImmutableGaugeConfig) another);
}
private boolean equalTo(ImmutableGaugeConfig another) {
return mbeanObjectName.equals(another.mbeanObjectName)
&& mbeanAttributes.equals(another.mbeanAttributes)
&& version.equals(another.version);
}
/**
* Computes hash code from attributes: {@code mbeanObjectName}, {@code mbeanAttributes}, {@code version}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 31;
h = h * 17 + mbeanObjectName.hashCode();
h = h * 17 + mbeanAttributes.hashCode();
h = h * 17 + version.hashCode();
return h;
}
/**
* Prints immutable value {@code GaugeConfig...} with attribute values,
* excluding any non-generated and auxiliary attributes.
* @return string representation of value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("GaugeConfig")
.add("mbeanObjectName", mbeanObjectName)
.add("mbeanAttributes", mbeanAttributes)
.add("version", version)
.toString();
}
/**
* Simple representation of this value type suitable Jackson binding
* @deprecated Do not use this type directly, it exists only for Jackson-binding infrastructure
*/
@Deprecated
static final class Json {
@JsonProperty
@Nullable String mbeanObjectName;
@JsonProperty
@Nullable ImmutableList mbeanAttributes;
@JsonProperty
@JsonIgnore
@Nullable String version;
}
/**
* @param json JSON-bindable data structure
* @return immutable value type
* @deprecated Do not use this method directly, it exists only for Jackson-binding infrastructure
*/
@Deprecated
@JsonCreator
static ImmutableGaugeConfig fromJson(Json json) {
ImmutableGaugeConfig.Builder builder = ImmutableGaugeConfig.builder();
if (json.mbeanObjectName != null) {
builder.mbeanObjectName(json.mbeanObjectName);
}
if (json.mbeanAttributes != null) {
builder.addAllMbeanAttributes(json.mbeanAttributes);
}
return builder.build();
}
/**
* Creates immutable copy of {@link GaugeConfig}.
* Uses accessors to get values to initialize immutable instance.
* If an instance is already immutable, it is returned as is.
* @param instance instance to copy
* @return copied immutable GaugeConfig instance
*/
public static ImmutableGaugeConfig copyOf(GaugeConfig instance) {
if (instance instanceof ImmutableGaugeConfig) {
return (ImmutableGaugeConfig) instance;
}
return ImmutableGaugeConfig.builder()
.copyFrom(instance)
.build();
}
/**
* Creates builder for {@link org.glowroot.common.config.ImmutableGaugeConfig ImmutableGaugeConfig}.
* @return new ImmutableGaugeConfig builder
*/
public static ImmutableGaugeConfig.Builder builder() {
return new ImmutableGaugeConfig.Builder();
}
/**
* Builds instances of {@link org.glowroot.common.config.ImmutableGaugeConfig ImmutableGaugeConfig}.
* Initialize attributes and then invoke {@link #build()} method to create
* immutable instance.
* {@code Builder} is not thread safe and generally should not be stored in field or collection,
* but used immediately to create instances.
*/
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_MBEAN_OBJECT_NAME = 0x1L;
private long initBits = 0x1;
private @Nullable String mbeanObjectName;
private ImmutableList.Builder mbeanAttributesBuilder = ImmutableList.builder();
private Builder() {}
/**
* Fill builder with attribute values from provided {@link GaugeConfig} instance.
* Regular attribute values will be replaced with ones of an instance.
* Instance's absent optional values will not replace present values.
* Collection elements and entries will be added, not replaced.
* @param instance instance to copy values from
* @return {@code this} builder for chained invocation
*/
public final Builder copyFrom(GaugeConfig instance) {
Preconditions.checkNotNull(instance);
mbeanObjectName(instance.mbeanObjectName());
addAllMbeanAttributes(instance.mbeanAttributes());
return this;
}
/**
* Initializes value for {@link GaugeConfig#mbeanObjectName() mbeanObjectName}.
* @param mbeanObjectName value for mbeanObjectName
* @return {@code this} builder for chained invocation
*/
public final Builder mbeanObjectName(String mbeanObjectName) {
this.mbeanObjectName = Preconditions.checkNotNull(mbeanObjectName);
initBits &= ~INIT_BIT_MBEAN_OBJECT_NAME;
return this;
}
/**
* Adds one element to {@link GaugeConfig#mbeanAttributes() mbeanAttributes} list.
* @param element mbeanAttributes element
* @return {@code this} builder for chained invocation
*/
public final Builder addMbeanAttributes(GaugeConfig.MBeanAttribute element) {
mbeanAttributesBuilder.add(element);
return this;
}
/**
* Adds elements to {@link GaugeConfig#mbeanAttributes() mbeanAttributes} list.
* @param elements array of mbeanAttributes elements
* @return {@code this} builder for chained invocation
*/
public final Builder addMbeanAttributes(GaugeConfig.MBeanAttribute... elements) {
mbeanAttributesBuilder.add(elements);
return this;
}
/**
* Sets or replaces all elements for {@link GaugeConfig#mbeanAttributes() mbeanAttributes} list.
* @param elements iterable of mbeanAttributes elements
* @return {@code this} builder for chained invocation
*/
public final Builder mbeanAttributes(Iterable elements) {
mbeanAttributesBuilder = ImmutableList.builder();
return addAllMbeanAttributes(elements);
}
/**
* Adds elements to {@link GaugeConfig#mbeanAttributes() mbeanAttributes} list.
* @param elements iterable of mbeanAttributes elements
* @return {@code this} builder for chained invocation
*/
public final Builder addAllMbeanAttributes(Iterable elements) {
mbeanAttributesBuilder.addAll(elements);
return this;
}
/**
* Builds new {@link org.glowroot.common.config.ImmutableGaugeConfig ImmutableGaugeConfig}.
* @return immutable instance of GaugeConfig
* @throws exception {@code java.lang.IllegalStateException} if any required attributes are missing
*/
public ImmutableGaugeConfig build()
throws IllegalStateException {
checkRequiredAttributes();
return new ImmutableGaugeConfig(mbeanObjectName, mbeanAttributesBuilder.build());
}
private boolean mbeanObjectNameIsSet() {
return (initBits & INIT_BIT_MBEAN_OBJECT_NAME) == 0;
}
private void checkRequiredAttributes() throws IllegalStateException {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if (!mbeanObjectNameIsSet()) attributes.add("mbeanObjectName");
return "Cannot build GaugeConfig, some of required attributes are not set " + attributes;
}
}
}