io.thestencil.client.api.ImmutableImageResource Maven / Gradle / Ivy
package io.thestencil.client.api;
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.Arrays;
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 Markdowns.ImageResource}.
*
* Use the builder to create immutable instances:
* {@code ImmutableImageResource.builder()}.
*/
@Generated(from = "Markdowns.ImageResource", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableImageResource implements Markdowns.ImageResource {
private final String path;
private final byte[] value;
private ImmutableImageResource(String path, byte[] value) {
this.path = path;
this.value = value;
}
/**
* @return The value of the {@code path} attribute
*/
@Override
public String getPath() {
return path;
}
/**
* @return A cloned {@code value} array
*/
@Override
public byte[] getValue() {
return value.clone();
}
/**
* Copy the current immutable object by setting a value for the {@link Markdowns.ImageResource#getPath() path} attribute.
* An equals check used to prevent copying of the same value by returning {@code this}.
* @param value A new value for path
* @return A modified copy of the {@code this} object
*/
public final ImmutableImageResource withPath(String value) {
String newValue = Objects.requireNonNull(value, "path");
if (this.path.equals(newValue)) return this;
return new ImmutableImageResource(newValue, this.value);
}
/**
* Copy the current immutable object with elements that replace the content of {@link Markdowns.ImageResource#getValue() value}.
* The array is cloned before being saved as attribute values.
* @param elements The non-null elements for value
* @return A modified copy of {@code this} object
*/
public final ImmutableImageResource withValue(byte... elements) {
byte[] newValue = elements.clone();
return new ImmutableImageResource(this.path, newValue);
}
/**
* This instance is equal to all instances of {@code ImmutableImageResource} 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 ImmutableImageResource
&& equalTo(0, (ImmutableImageResource) another);
}
private boolean equalTo(int synthetic, ImmutableImageResource another) {
return path.equals(another.path)
&& Arrays.equals(value, another.value);
}
/**
* Computes a hash code from attributes: {@code path}, {@code value}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + path.hashCode();
h += (h << 5) + Arrays.hashCode(value);
return h;
}
/**
* Prints the immutable value {@code ImageResource} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("ImageResource")
.omitNullValues()
.add("path", path)
.add("value", Arrays.toString(value))
.toString();
}
/**
* Creates an immutable copy of a {@link Markdowns.ImageResource} 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 ImageResource instance
*/
public static ImmutableImageResource copyOf(Markdowns.ImageResource instance) {
if (instance instanceof ImmutableImageResource) {
return (ImmutableImageResource) instance;
}
return ImmutableImageResource.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableImageResource ImmutableImageResource}.
*
* ImmutableImageResource.builder()
* .path(String) // required {@link Markdowns.ImageResource#getPath() path}
* .value(byte) // required {@link Markdowns.ImageResource#getValue() value}
* .build();
*
* @return A new ImmutableImageResource builder
*/
public static ImmutableImageResource.Builder builder() {
return new ImmutableImageResource.Builder();
}
/**
* Builds instances of type {@link ImmutableImageResource ImmutableImageResource}.
* 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 = "Markdowns.ImageResource", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_PATH = 0x1L;
private static final long INIT_BIT_VALUE = 0x2L;
private long initBits = 0x3L;
private @Nullable String path;
private @Nullable byte[] value;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code ImageResource} 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(Markdowns.ImageResource instance) {
Objects.requireNonNull(instance, "instance");
this.path(instance.getPath());
this.value(instance.getValue());
return this;
}
/**
* Initializes the value for the {@link Markdowns.ImageResource#getPath() path} attribute.
* @param path The value for path
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder path(String path) {
this.path = Objects.requireNonNull(path, "path");
initBits &= ~INIT_BIT_PATH;
return this;
}
/**
* Initializes the value for the {@link Markdowns.ImageResource#getValue() value} attribute.
* @param value The elements for value
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder value(byte... value) {
this.value = value.clone();
initBits &= ~INIT_BIT_VALUE;
return this;
}
/**
* Builds a new {@link ImmutableImageResource ImmutableImageResource}.
* @return An immutable instance of ImageResource
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableImageResource build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableImageResource(path, value);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_PATH) != 0) attributes.add("path");
if ((initBits & INIT_BIT_VALUE) != 0) attributes.add("value");
return "Cannot build ImageResource, some of required attributes are not set " + attributes;
}
}
}