io.protostuff.generator.html.json.pages.ImmutablePageIndexItem Maven / Gradle / Ivy
package io.protostuff.generator.html.json.pages;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.common.base.MoreObjects;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.errorprone.annotations.Var;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
import org.immutables.value.Generated;
/**
* Immutable implementation of {@link PageIndexItem}.
*
* Use the builder to create immutable instances:
* {@code ImmutablePageIndexItem.builder()}.
*/
@Generated(from = "PageIndexItem", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutablePageIndexItem implements PageIndexItem {
private final String name;
private final String ref;
private ImmutablePageIndexItem(String name, String ref) {
this.name = name;
this.ref = ref;
}
/**
* @return The value of the {@code name} attribute
*/
@JsonProperty("name")
@Override
public String name() {
return name;
}
/**
* @return The value of the {@code ref} attribute
*/
@JsonProperty("ref")
@Override
public String ref() {
return ref;
}
/**
* Copy the current immutable object by setting a value for the {@link PageIndexItem#name() name} attribute.
* An equals check used to prevent copying of the same value by returning {@code this}.
* @param value A new value for name
* @return A modified copy of the {@code this} object
*/
public final ImmutablePageIndexItem withName(String value) {
String newValue = Objects.requireNonNull(value, "name");
if (this.name.equals(newValue)) return this;
return new ImmutablePageIndexItem(newValue, this.ref);
}
/**
* Copy the current immutable object by setting a value for the {@link PageIndexItem#ref() ref} attribute.
* An equals check used to prevent copying of the same value by returning {@code this}.
* @param value A new value for ref
* @return A modified copy of the {@code this} object
*/
public final ImmutablePageIndexItem withRef(String value) {
String newValue = Objects.requireNonNull(value, "ref");
if (this.ref.equals(newValue)) return this;
return new ImmutablePageIndexItem(this.name, newValue);
}
/**
* This instance is equal to all instances of {@code ImmutablePageIndexItem} that have 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 ImmutablePageIndexItem
&& equalTo((ImmutablePageIndexItem) another);
}
private boolean equalTo(ImmutablePageIndexItem another) {
return name.equals(another.name)
&& ref.equals(another.ref);
}
/**
* Computes a hash code from attributes: {@code name}, {@code ref}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + name.hashCode();
h += (h << 5) + ref.hashCode();
return h;
}
/**
* Prints the immutable value {@code PageIndexItem} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("PageIndexItem")
.omitNullValues()
.add("name", name)
.add("ref", ref)
.toString();
}
/**
* Utility type used to correctly read immutable object from JSON representation.
* @deprecated Do not use this type directly, it exists only for the Jackson-binding infrastructure
*/
@Generated(from = "PageIndexItem", generator = "Immutables")
@Deprecated
@SuppressWarnings("Immutable")
@JsonDeserialize
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE)
static final class Json implements PageIndexItem {
@Nullable String name;
@Nullable String ref;
@JsonProperty("name")
public void setName(String name) {
this.name = name;
}
@JsonProperty("ref")
public void setRef(String ref) {
this.ref = ref;
}
@Override
public String name() { throw new UnsupportedOperationException(); }
@Override
public String ref() { throw new UnsupportedOperationException(); }
}
/**
* @param json A JSON-bindable data structure
* @return An immutable value type
* @deprecated Do not use this method directly, it exists only for the Jackson-binding infrastructure
*/
@Deprecated
@JsonCreator(mode = JsonCreator.Mode.DELEGATING)
static ImmutablePageIndexItem fromJson(Json json) {
ImmutablePageIndexItem.Builder builder = ImmutablePageIndexItem.builder();
if (json.name != null) {
builder.name(json.name);
}
if (json.ref != null) {
builder.ref(json.ref);
}
return builder.build();
}
/**
* Creates an immutable copy of a {@link PageIndexItem} value.
* Uses accessors to get values to initialize the new immutable instance.
* If an instance is already immutable, it is returned as is.
* @param instance The instance to copy
* @return A copied immutable PageIndexItem instance
*/
public static ImmutablePageIndexItem copyOf(PageIndexItem instance) {
if (instance instanceof ImmutablePageIndexItem) {
return (ImmutablePageIndexItem) instance;
}
return ImmutablePageIndexItem.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutablePageIndexItem ImmutablePageIndexItem}.
*
* ImmutablePageIndexItem.builder()
* .name(String) // required {@link PageIndexItem#name() name}
* .ref(String) // required {@link PageIndexItem#ref() ref}
* .build();
*
* @return A new ImmutablePageIndexItem builder
*/
public static ImmutablePageIndexItem.Builder builder() {
return new ImmutablePageIndexItem.Builder();
}
/**
* Builds instances of type {@link ImmutablePageIndexItem ImmutablePageIndexItem}.
* Initialize attributes and then invoke the {@link #build()} method to create an
* immutable instance.
* {@code Builder} is not thread-safe and generally should not be stored in a field or collection,
* but instead used immediately to create instances.
*/
@Generated(from = "PageIndexItem", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_NAME = 0x1L;
private static final long INIT_BIT_REF = 0x2L;
private long initBits = 0x3L;
private @Nullable String name;
private @Nullable String ref;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code PageIndexItem} instance.
* Regular attribute values will be replaced with those from the given instance.
* Absent optional values will not replace present values.
* @param instance The instance from which to copy values
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder from(PageIndexItem instance) {
Objects.requireNonNull(instance, "instance");
name(instance.name());
ref(instance.ref());
return this;
}
/**
* Initializes the value for the {@link PageIndexItem#name() name} attribute.
* @param name The value for name
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("name")
public final Builder name(String name) {
this.name = Objects.requireNonNull(name, "name");
initBits &= ~INIT_BIT_NAME;
return this;
}
/**
* Initializes the value for the {@link PageIndexItem#ref() ref} attribute.
* @param ref The value for ref
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("ref")
public final Builder ref(String ref) {
this.ref = Objects.requireNonNull(ref, "ref");
initBits &= ~INIT_BIT_REF;
return this;
}
/**
* Builds a new {@link ImmutablePageIndexItem ImmutablePageIndexItem}.
* @return An immutable instance of PageIndexItem
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutablePageIndexItem build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutablePageIndexItem(name, ref);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_NAME) != 0) attributes.add("name");
if ((initBits & INIT_BIT_REF) != 0) attributes.add("ref");
return "Cannot build PageIndexItem, some of required attributes are not set " + attributes;
}
}
}