org.glowroot.common.live.ImmutableAvailability Maven / Gradle / Ivy
package org.glowroot.common.live;
import org.glowroot.agent.shaded.fasterxml.jackson.annotation.JsonCreator;
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.Lists;
import org.glowroot.agent.shaded.google.common.primitives.Booleans;
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 LiveJvmService.Availability}.
*
* Use builder to create immutable instances:
* {@code ImmutableAvailability.builder()}.
* Use static factory method to create immutable instances:
* {@code ImmutableAvailability.of()}.
*/
@SuppressWarnings("all")
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "LiveJvmService.Availability"})
@Immutable
public final class ImmutableAvailability implements LiveJvmService.Availability {
private final boolean available;
private final String reason;
private ImmutableAvailability(boolean available, String reason) {
this.available = available;
this.reason = Preconditions.checkNotNull(reason);
}
private ImmutableAvailability(ImmutableAvailability original, boolean available, String reason) {
this.available = available;
this.reason = reason;
}
/**
* @return value of {@code available} attribute
*/
@JsonProperty
@Override
public boolean available() {
return available;
}
/**
* @return value of {@code reason} attribute
*/
@JsonProperty
@Override
public String getReason() {
return reason;
}
/**
* Copy current immutable object by setting value for {@link LiveJvmService.Availability#available() available}.
* Value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value new value for available
* @return modified copy of the {@code this} object
*/
public final ImmutableAvailability withAvailable(boolean value) {
if (this.available == value) return this;
boolean newValue = value;
return new ImmutableAvailability(this, newValue, this.reason);
}
/**
* Copy current immutable object by setting value for {@link LiveJvmService.Availability#getReason() reason}.
* Shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param value new value for reason
* @return modified copy of the {@code this} object
*/
public final ImmutableAvailability withReason(String value) {
if (this.reason == value) return this;
String newValue = Preconditions.checkNotNull(value);
return new ImmutableAvailability(this, this.available, newValue);
}
/**
* This instance is equal to instances of {@code ImmutableAvailability} 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 ImmutableAvailability
&& equalTo((ImmutableAvailability) another);
}
private boolean equalTo(ImmutableAvailability another) {
return available == another.available
&& reason.equals(another.reason);
}
/**
* Computes hash code from attributes: {@code available}, {@code reason}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 31;
h = h * 17 + Booleans.hashCode(available);
h = h * 17 + reason.hashCode();
return h;
}
/**
* Prints immutable value {@code Availability...} with attribute values,
* excluding any non-generated and auxiliary attributes.
* @return string representation of value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("Availability")
.add("available", available)
.add("reason", reason)
.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 Boolean available;
@JsonProperty
@Nullable String reason;
}
/**
* @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 ImmutableAvailability fromJson(Json json) {
ImmutableAvailability.Builder builder = ImmutableAvailability.builder();
if (json.available != null) {
builder.available(json.available);
}
if (json.reason != null) {
builder.reason(json.reason);
}
return builder.build();
}
/**
* Construct new immutable {@code Availability} instance.
* @param available value for {@code available}
* @param reason value for {@code reason}
* @return immutable Availability instance
*/
public static ImmutableAvailability of(boolean available, String reason) {
return new ImmutableAvailability(available, reason);
}
/**
* Creates immutable copy of {@link LiveJvmService.Availability}.
* 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 Availability instance
*/
public static ImmutableAvailability copyOf(LiveJvmService.Availability instance) {
if (instance instanceof ImmutableAvailability) {
return (ImmutableAvailability) instance;
}
return ImmutableAvailability.builder()
.copyFrom(instance)
.build();
}
/**
* Creates builder for {@link org.glowroot.common.live.ImmutableAvailability ImmutableAvailability}.
* @return new ImmutableAvailability builder
*/
public static ImmutableAvailability.Builder builder() {
return new ImmutableAvailability.Builder();
}
/**
* Builds instances of {@link org.glowroot.common.live.ImmutableAvailability ImmutableAvailability}.
* 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_AVAILABLE = 0x1L;
private static final long INIT_BIT_REASON = 0x2L;
private long initBits = 0x3;
private boolean available;
private @Nullable String reason;
private Builder() {}
/**
* Fill builder with attribute values from provided {@link LiveJvmService.Availability} instance.
* Regular attribute values will be replaced with ones of an instance.
* Instance's absent optional values will not replace present values.
* @param instance instance to copy values from
* @return {@code this} builder for chained invocation
*/
public final Builder copyFrom(LiveJvmService.Availability instance) {
Preconditions.checkNotNull(instance);
available(instance.available());
reason(instance.getReason());
return this;
}
/**
* Initializes value for {@link LiveJvmService.Availability#available() available}.
* @param available value for available
* @return {@code this} builder for chained invocation
*/
public final Builder available(boolean available) {
this.available = available;
initBits &= ~INIT_BIT_AVAILABLE;
return this;
}
/**
* Initializes value for {@link LiveJvmService.Availability#getReason() reason}.
* @param reason value for reason
* @return {@code this} builder for chained invocation
*/
public final Builder reason(String reason) {
this.reason = Preconditions.checkNotNull(reason);
initBits &= ~INIT_BIT_REASON;
return this;
}
/**
* Builds new {@link org.glowroot.common.live.ImmutableAvailability ImmutableAvailability}.
* @return immutable instance of Availability
* @throws exception {@code java.lang.IllegalStateException} if any required attributes are missing
*/
public ImmutableAvailability build()
throws IllegalStateException {
checkRequiredAttributes(); return new ImmutableAvailability(null, available, reason);
}
private boolean availableIsSet() {
return (initBits & INIT_BIT_AVAILABLE) == 0;
}
private boolean reasonIsSet() {
return (initBits & INIT_BIT_REASON) == 0;
}
private void checkRequiredAttributes() throws IllegalStateException {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if (!availableIsSet()) attributes.add("available");
if (!reasonIsSet()) attributes.add("reason");
return "Cannot build Availability, some of required attributes are not set " + attributes;
}
}
}