com.spotify.github.v3.checks.ImmutableCheckSuite Maven / Gradle / Ivy
package com.spotify.github.v3.checks;
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.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 CheckSuite}.
*
* Use the builder to create immutable instances:
* {@code ImmutableCheckSuite.builder()}.
*/
@Generated(from = "CheckSuite", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableCheckSuite implements CheckSuite {
private final Integer id;
private ImmutableCheckSuite(Integer id) {
this.id = id;
}
/**
* The Check Suite Id.
* @return the integer
*/
@JsonProperty
@Override
public Integer id() {
return id;
}
/**
* Copy the current immutable object by setting a value for the {@link CheckSuite#id() id} attribute.
* An equals check used to prevent copying of the same value by returning {@code this}.
* @param value A new value for id
* @return A modified copy of the {@code this} object
*/
public final ImmutableCheckSuite withId(Integer value) {
Integer newValue = Objects.requireNonNull(value, "id");
if (this.id.equals(newValue)) return this;
return new ImmutableCheckSuite(newValue);
}
/**
* This instance is equal to all instances of {@code ImmutableCheckSuite} 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 ImmutableCheckSuite
&& equalTo((ImmutableCheckSuite) another);
}
private boolean equalTo(ImmutableCheckSuite another) {
return id.equals(another.id);
}
/**
* Computes a hash code from attributes: {@code id}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + id.hashCode();
return h;
}
/**
* Prints the immutable value {@code CheckSuite} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return "CheckSuite{"
+ "id=" + id
+ "}";
}
/**
* 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 = "CheckSuite", generator = "Immutables")
@Deprecated
@SuppressWarnings("Immutable")
@JsonDeserialize
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE)
static final class Json implements CheckSuite {
@Nullable Integer id;
@JsonProperty
public void setId(Integer id) {
this.id = id;
}
@Override
public Integer id() { 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 ImmutableCheckSuite fromJson(Json json) {
ImmutableCheckSuite.Builder builder = ImmutableCheckSuite.builder();
if (json.id != null) {
builder.id(json.id);
}
return builder.build();
}
/**
* Creates an immutable copy of a {@link CheckSuite} 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 CheckSuite instance
*/
public static ImmutableCheckSuite copyOf(CheckSuite instance) {
if (instance instanceof ImmutableCheckSuite) {
return (ImmutableCheckSuite) instance;
}
return ImmutableCheckSuite.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableCheckSuite ImmutableCheckSuite}.
*
* ImmutableCheckSuite.builder()
* .id(Integer) // required {@link CheckSuite#id() id}
* .build();
*
* @return A new ImmutableCheckSuite builder
*/
public static ImmutableCheckSuite.Builder builder() {
return new ImmutableCheckSuite.Builder();
}
/**
* Builds instances of type {@link ImmutableCheckSuite ImmutableCheckSuite}.
* 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 = "CheckSuite", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_ID = 0x1L;
private long initBits = 0x1L;
private @Nullable Integer id;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code CheckSuite} 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(CheckSuite instance) {
Objects.requireNonNull(instance, "instance");
id(instance.id());
return this;
}
/**
* Initializes the value for the {@link CheckSuite#id() id} attribute.
* @param id The value for id
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty
public final Builder id(Integer id) {
this.id = Objects.requireNonNull(id, "id");
initBits &= ~INIT_BIT_ID;
return this;
}
/**
* Builds a new {@link ImmutableCheckSuite ImmutableCheckSuite}.
* @return An immutable instance of CheckSuite
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableCheckSuite build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableCheckSuite(id);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_ID) != 0) attributes.add("id");
return "Cannot build CheckSuite, some of required attributes are not set " + attributes;
}
}
}