io.github.astrapi69.bean.enumeration.DecoratedEnum Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of silly-bean Show documentation
Utility library that provides some generic data beans like pair, triple and quattro
The newest version!
/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package io.github.astrapi69.bean.enumeration;

import java.util.Objects;

/**
 * The class {@link DecoratedEnum} can decorate an enum with a new value that may be extended in a
 * future release.
 */
public final class DecoratedEnum, T>
{

	/** The enumtype. */
	private final E enumtype;

	/** The value. */
	private final T value;

	/**
	 * Instantiates a new {@link DecoratedEnum}.
	 *
	 * @param enumtype
	 *            the type of the enum
	 * @param value
	 *            the value
	 */
	public DecoratedEnum(final E enumtype, final T value)
	{
		if (enumtype == null)
		{
			Objects.requireNonNull(value);
		}
		this.enumtype = enumtype;
		this.value = value;
	}

	public static , T> DecoratedEnumBuilder builder()
	{
		return new DecoratedEnumBuilder();
	}

	/**
	 * Returns the name of the decorated enum or if it is a new value it will return the result of
	 * the toString method of value
	 *
	 * @return the name of the decorated enum or if it is a new value it will return the result of
	 *         the toString method of value
	 */
	public String name()
	{
		if (enumtype != null)
		{
			return enumtype.name();
		}
		return value.toString();
	}

	public E getEnumtype()
	{
		return this.enumtype;
	}

	public T getValue()
	{
		return this.value;
	}

	public boolean equals(final Object o)
	{
		if (o == this)
			return true;
		if (!(o instanceof DecoratedEnum))
			return false;
		final DecoratedEnum other = (DecoratedEnum)o;
		final Object this$enumtype = this.getEnumtype();
		final Object other$enumtype = other.getEnumtype();
		if (this$enumtype == null ? other$enumtype != null : !this$enumtype.equals(other$enumtype))
			return false;
		final Object this$value = this.getValue();
		final Object other$value = other.getValue();
		if (this$value == null ? other$value != null : !this$value.equals(other$value))
			return false;
		return true;
	}

	public int hashCode()
	{
		final int PRIME = 59;
		int result = 1;
		final Object $enumtype = this.getEnumtype();
		result = result * PRIME + ($enumtype == null ? 43 : $enumtype.hashCode());
		final Object $value = this.getValue();
		result = result * PRIME + ($value == null ? 43 : $value.hashCode());
		return result;
	}

	public String toString()
	{
		return "DecoratedEnum(enumtype=" + this.getEnumtype() + ", value=" + this.getValue() + ")";
	}

	public static class DecoratedEnumBuilder, T>
	{
		private E enumtype;
		private T value;

		DecoratedEnumBuilder()
		{
		}

		public DecoratedEnumBuilder enumtype(E enumtype)
		{
			this.enumtype = enumtype;
			return this;
		}

		public DecoratedEnumBuilder value(T value)
		{
			this.value = value;
			return this;
		}

		public DecoratedEnum build()
		{
			return new DecoratedEnum<>(enumtype, value);
		}

		public String toString()
		{
			return "DecoratedEnum.DecoratedEnumBuilder(enumtype=" + this.enumtype + ", value="
				+ this.value + ")";
		}
	}
}