org.immutables.fixture.module.subpackage.ImmutableHasModuleField Maven / Gradle / Ivy
Show all versions of value-fixture Show documentation
package org.immutables.fixture.module.subpackage;
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.fixture.module.Module;
import org.immutables.value.Generated;
/**
* Immutable implementation of {@link HasModuleField}.
*
* Use the builder to create immutable instances:
* {@code ImmutableHasModuleField.builder()}.
*/
@Generated(from = "HasModuleField", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableHasModuleField implements HasModuleField {
private final Module module;
private ImmutableHasModuleField(Module module) {
this.module = module;
}
/**
* @return The value of the {@code module} attribute
*/
@Override
public Module getModule() {
return module;
}
/**
* Copy the current immutable object by setting a value for the {@link HasModuleField#getModule() module} attribute.
* A shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for module
* @return A modified copy of the {@code this} object
*/
public final ImmutableHasModuleField withModule(Module value) {
if (this.module == value) return this;
Module newValue = Objects.requireNonNull(value, "module");
return new ImmutableHasModuleField(newValue);
}
/**
* This instance is equal to all instances of {@code ImmutableHasModuleField} 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 ImmutableHasModuleField
&& equalTo(0, (ImmutableHasModuleField) another);
}
private boolean equalTo(int synthetic, ImmutableHasModuleField another) {
return module.equals(another.module);
}
/**
* Computes a hash code from attributes: {@code module}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + module.hashCode();
return h;
}
/**
* Prints the immutable value {@code HasModuleField} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("HasModuleField")
.omitNullValues()
.add("module", module)
.toString();
}
/**
* Creates an immutable copy of a {@link HasModuleField} 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 HasModuleField instance
*/
public static ImmutableHasModuleField copyOf(HasModuleField instance) {
if (instance instanceof ImmutableHasModuleField) {
return (ImmutableHasModuleField) instance;
}
return ImmutableHasModuleField.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableHasModuleField ImmutableHasModuleField}.
*
* ImmutableHasModuleField.builder()
* .module(org.immutables.fixture.module.Module) // required {@link HasModuleField#getModule() module}
* .build();
*
* @return A new ImmutableHasModuleField builder
*/
public static ImmutableHasModuleField.Builder builder() {
return new ImmutableHasModuleField.Builder();
}
/**
* Builds instances of type {@link ImmutableHasModuleField ImmutableHasModuleField}.
* 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 = "HasModuleField", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_MODULE = 0x1L;
private long initBits = 0x1L;
private @Nullable Module module;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code HasModuleField} 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(HasModuleField instance) {
Objects.requireNonNull(instance, "instance");
module(instance.getModule());
return this;
}
/**
* Initializes the value for the {@link HasModuleField#getModule() module} attribute.
* @param module The value for module
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder module(Module module) {
this.module = Objects.requireNonNull(module, "module");
initBits &= ~INIT_BIT_MODULE;
return this;
}
/**
* Builds a new {@link ImmutableHasModuleField ImmutableHasModuleField}.
* @return An immutable instance of HasModuleField
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableHasModuleField build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableHasModuleField(module);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_MODULE) != 0) attributes.add("module");
return "Cannot build HasModuleField, some of required attributes are not set " + attributes;
}
}
}