com.arakelian.faker.reader.ImmutableColumn Maven / Gradle / Ivy
package com.arakelian.faker.reader;
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 TextReader.Column}.
*
* Use the builder to create immutable instances:
* {@code ImmutableColumn.builder()}.
*/
@Generated(from = "TextReader.Column", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableColumn implements TextReader.Column {
private final int length;
private final String name;
private final TextReader.Type type;
private ImmutableColumn(ImmutableColumn.Builder builder) {
this.name = builder.name;
if (builder.lengthIsSet()) {
initShim.length(builder.length);
}
if (builder.type != null) {
initShim.type(builder.type);
}
this.length = initShim.getLength();
this.type = initShim.getType();
this.initShim = null;
}
private ImmutableColumn(int length, String name, TextReader.Type type) {
this.length = length;
this.name = name;
this.type = type;
this.initShim = null;
}
private static final byte STAGE_INITIALIZING = -1;
private static final byte STAGE_UNINITIALIZED = 0;
private static final byte STAGE_INITIALIZED = 1;
@SuppressWarnings("Immutable")
private transient volatile InitShim initShim = new InitShim();
@Generated(from = "TextReader.Column", generator = "Immutables")
private final class InitShim {
private byte lengthBuildStage = STAGE_UNINITIALIZED;
private int length;
int getLength() {
if (lengthBuildStage == STAGE_INITIALIZING) throw new IllegalStateException(formatInitCycleMessage());
if (lengthBuildStage == STAGE_UNINITIALIZED) {
lengthBuildStage = STAGE_INITIALIZING;
this.length = getLengthInitialize();
lengthBuildStage = STAGE_INITIALIZED;
}
return this.length;
}
void length(int length) {
this.length = length;
lengthBuildStage = STAGE_INITIALIZED;
}
private byte typeBuildStage = STAGE_UNINITIALIZED;
private TextReader.Type type;
TextReader.Type getType() {
if (typeBuildStage == STAGE_INITIALIZING) throw new IllegalStateException(formatInitCycleMessage());
if (typeBuildStage == STAGE_UNINITIALIZED) {
typeBuildStage = STAGE_INITIALIZING;
this.type = Objects.requireNonNull(getTypeInitialize(), "type");
typeBuildStage = STAGE_INITIALIZED;
}
return this.type;
}
void type(TextReader.Type type) {
this.type = type;
typeBuildStage = STAGE_INITIALIZED;
}
private String formatInitCycleMessage() {
List attributes = new ArrayList<>();
if (lengthBuildStage == STAGE_INITIALIZING) attributes.add("length");
if (typeBuildStage == STAGE_INITIALIZING) attributes.add("type");
return "Cannot build Column, attribute initializers form cycle " + attributes;
}
}
private int getLengthInitialize() {
return TextReader.Column.super.getLength();
}
private TextReader.Type getTypeInitialize() {
return TextReader.Column.super.getType();
}
/**
* @return The value of the {@code length} attribute
*/
@Override
public int getLength() {
InitShim shim = this.initShim;
return shim != null
? shim.getLength()
: this.length;
}
/**
* @return The value of the {@code name} attribute
*/
@Override
public String getName() {
return name;
}
/**
* @return The value of the {@code type} attribute
*/
@Override
public TextReader.Type getType() {
InitShim shim = this.initShim;
return shim != null
? shim.getType()
: this.type;
}
/**
* Copy the current immutable object by setting a value for the {@link TextReader.Column#getLength() length} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for length
* @return A modified copy of the {@code this} object
*/
public final ImmutableColumn withLength(int value) {
if (this.length == value) return this;
return validate(new ImmutableColumn(value, this.name, this.type));
}
/**
* Copy the current immutable object by setting a value for the {@link TextReader.Column#getName() 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 ImmutableColumn withName(String value) {
String newValue = Objects.requireNonNull(value, "name");
if (this.name.equals(newValue)) return this;
return validate(new ImmutableColumn(this.length, newValue, this.type));
}
/**
* Copy the current immutable object by setting a value for the {@link TextReader.Column#getType() type} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for type
* @return A modified copy of the {@code this} object
*/
public final ImmutableColumn withType(TextReader.Type value) {
if (this.type == value) return this;
TextReader.Type newValue = Objects.requireNonNull(value, "type");
if (this.type.equals(newValue)) return this;
return validate(new ImmutableColumn(this.length, this.name, newValue));
}
/**
* This instance is equal to all instances of {@code ImmutableColumn} 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 ImmutableColumn
&& equalTo((ImmutableColumn) another);
}
private boolean equalTo(ImmutableColumn another) {
return length == another.length
&& name.equals(another.name)
&& type.equals(another.type);
}
/**
* Computes a hash code from attributes: {@code length}, {@code name}, {@code type}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + length;
h += (h << 5) + name.hashCode();
h += (h << 5) + type.hashCode();
return h;
}
/**
* Prints the immutable value {@code Column} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("Column")
.omitNullValues()
.add("length", length)
.add("name", name)
.add("type", type)
.toString();
}
private static ImmutableColumn validate(ImmutableColumn instance) {
instance.validate();
return instance;
}
/**
* Creates an immutable copy of a {@link TextReader.Column} 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 Column instance
*/
public static ImmutableColumn copyOf(TextReader.Column instance) {
if (instance instanceof ImmutableColumn) {
return (ImmutableColumn) instance;
}
return ImmutableColumn.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableColumn ImmutableColumn}.
* @return A new ImmutableColumn builder
*/
public static ImmutableColumn.Builder builder() {
return new ImmutableColumn.Builder();
}
/**
* Builds instances of type {@link ImmutableColumn ImmutableColumn}.
* 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 = "TextReader.Column", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_NAME = 0x1L;
private static final long OPT_BIT_LENGTH = 0x1L;
private long initBits = 0x1L;
private long optBits;
private int length;
private @Nullable String name;
private @Nullable TextReader.Type type;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code Column} 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(TextReader.Column instance) {
Objects.requireNonNull(instance, "instance");
length(instance.getLength());
name(instance.getName());
type(instance.getType());
return this;
}
/**
* Initializes the value for the {@link TextReader.Column#getLength() length} attribute.
*
If not set, this attribute will have a default value as returned by the initializer of {@link TextReader.Column#getLength() length}.
* @param length The value for length
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder length(int length) {
this.length = length;
optBits |= OPT_BIT_LENGTH;
return this;
}
/**
* Initializes the value for the {@link TextReader.Column#getName() name} attribute.
* @param name The value for name
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder name(String name) {
this.name = Objects.requireNonNull(name, "name");
initBits &= ~INIT_BIT_NAME;
return this;
}
/**
* Initializes the value for the {@link TextReader.Column#getType() type} attribute.
*
If not set, this attribute will have a default value as returned by the initializer of {@link TextReader.Column#getType() type}.
* @param type The value for type
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder type(TextReader.Type type) {
this.type = Objects.requireNonNull(type, "type");
return this;
}
/**
* Builds a new {@link ImmutableColumn ImmutableColumn}.
* @return An immutable instance of Column
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableColumn build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return ImmutableColumn.validate(new ImmutableColumn(this));
}
private boolean lengthIsSet() {
return (optBits & OPT_BIT_LENGTH) != 0;
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_NAME) != 0) attributes.add("name");
return "Cannot build Column, some of required attributes are not set " + attributes;
}
}
}