com.io7m.coffeepick.runtime.parser.spi.FormatVersion Maven / Gradle / Ivy
Show all versions of com.io7m.coffeepick.runtime.parser.spi Show documentation
package com.io7m.coffeepick.runtime.parser.spi;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
/**
* A format version.
*/
@SuppressWarnings({"all"})
public final class FormatVersion implements FormatVersionType {
private final int major;
private final int minor;
private FormatVersion(int major, int minor) {
this.major = major;
this.minor = minor;
}
/**
* @return The major number for a format
*/
@Override
public int major() {
return major;
}
/**
* @return The minor number for a format
*/
@Override
public int minor() {
return minor;
}
/**
* Copy the current immutable object by setting a value for the {@link FormatVersionType#major() major} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for major
* @return A modified copy of the {@code this} object
*/
public final FormatVersion withMajor(int value) {
if (this.major == value) return this;
return new FormatVersion(value, this.minor);
}
/**
* Copy the current immutable object by setting a value for the {@link FormatVersionType#minor() minor} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for minor
* @return A modified copy of the {@code this} object
*/
public final FormatVersion withMinor(int value) {
if (this.minor == value) return this;
return new FormatVersion(this.major, value);
}
/**
* This instance is equal to all instances of {@code FormatVersion} that have equal attribute values.
* @return {@code true} if {@code this} is equal to {@code another} instance
*/
@Override
public boolean equals(Object another) {
if (this == another) return true;
return another instanceof FormatVersion
&& equalTo((FormatVersion) another);
}
private boolean equalTo(FormatVersion another) {
return major == another.major
&& minor == another.minor;
}
/**
* Computes a hash code from attributes: {@code major}, {@code minor}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 5381;
h += (h << 5) + major;
h += (h << 5) + minor;
return h;
}
/**
* Prints the immutable value {@code FormatVersion} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return "FormatVersion{"
+ "major=" + major
+ ", minor=" + minor
+ "}";
}
/**
* Construct a new immutable {@code FormatVersion} instance.
* @param major The value for the {@code major} attribute
* @param minor The value for the {@code minor} attribute
* @return An immutable FormatVersion instance
*/
public static FormatVersion of(int major, int minor) {
return new FormatVersion(major, minor);
}
/**
* Creates an immutable copy of a {@link FormatVersionType} 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 FormatVersion instance
*/
public static FormatVersion copyOf(FormatVersionType instance) {
if (instance instanceof FormatVersion) {
return (FormatVersion) instance;
}
return FormatVersion.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link FormatVersion FormatVersion}.
*
* FormatVersion.builder()
* .setMajor(int) // required {@link FormatVersionType#major() major}
* .setMinor(int) // required {@link FormatVersionType#minor() minor}
* .build();
*
* @return A new FormatVersion builder
*/
public static FormatVersion.Builder builder() {
return new FormatVersion.Builder();
}
/**
* Builds instances of type {@link FormatVersion FormatVersion}.
* 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.
*/
public static final class Builder {
private static final long INIT_BIT_MAJOR = 0x1L;
private static final long INIT_BIT_MINOR = 0x2L;
private long initBits = 0x3L;
private int major;
private int minor;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code FormatVersionType} 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
*/
public final Builder from(FormatVersionType instance) {
Objects.requireNonNull(instance, "instance");
setMajor(instance.major());
setMinor(instance.minor());
return this;
}
/**
* Initializes the value for the {@link FormatVersionType#major() major} attribute.
* @param major The value for major
* @return {@code this} builder for use in a chained invocation
*/
public final Builder setMajor(int major) {
this.major = major;
initBits &= ~INIT_BIT_MAJOR;
return this;
}
/**
* Initializes the value for the {@link FormatVersionType#minor() minor} attribute.
* @param minor The value for minor
* @return {@code this} builder for use in a chained invocation
*/
public final Builder setMinor(int minor) {
this.minor = minor;
initBits &= ~INIT_BIT_MINOR;
return this;
}
/**
* Builds a new {@link FormatVersion FormatVersion}.
* @return An immutable instance of FormatVersion
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public FormatVersion build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new FormatVersion(major, minor);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_MAJOR) != 0) attributes.add("major");
if ((initBits & INIT_BIT_MINOR) != 0) attributes.add("minor");
return "Cannot build FormatVersion, some of required attributes are not set " + attributes;
}
}
}