io.github.astrapi69.collections.pairs.KeyMapPair Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of silly-beans 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.collections.pairs;

import java.io.Serializable;
import java.util.Map;

/**
 * The class {@link KeyMapPair} represents a key value pair with generic parameters for the key and
 * map value type.
 *
 * @param 
 *            The type of the key.
 * @param 
 *            the generic type of the map key.
 * @param 
 *            the generic type of the map value.
 */
public final class KeyMapPair implements Serializable
{

	/**
	 * The Constant serialVersionUID.
	 */
	private static final long serialVersionUID = 1L;
	/**
	 * The key.
	 */
	private K key;
	/**
	 * The map with the values.
	 */
	private Map values;

	/**
	 * Instantiates a new key map pair.
	 */
	public KeyMapPair()
	{
	}

	/**
	 * Instantiates a new key map pair.
	 *
	 * @param key
	 *            the key
	 * @param values
	 *            the values
	 */
	public KeyMapPair(final K key, final Map values)
	{
		this.key = key;
		this.values = values;
	}

	/**
	 * Builder.
	 *
	 * @param 
	 *            the key type
	 * @param 
	 *            the generic type
	 * @param 
	 *            the generic type
	 * @return the key map pair builder
	 */
	public static  KeyMapPairBuilder builder()
	{
		return new KeyMapPairBuilder<>();
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean equals(final Object o)
	{
		if (o == this)
		{
			return true;
		}
		if (!(o instanceof KeyMapPair))
		{
			return false;
		}
		final KeyMapPair other = (KeyMapPair)o;
		final Object this$key = this.getKey();
		final Object other$key = other.getKey();
		if (this$key == null ? other$key != null : !this$key.equals(other$key))
		{
			return false;
		}
		final Object this$values = this.getValues();
		final Object other$values = other.getValues();
		if (this$values == null ? other$values != null : !this$values.equals(other$values))
		{
			return false;
		}
		return true;
	}

	/**
	 * The key.
	 *
	 * @return the key
	 */
	public K getKey()
	{
		return this.key;
	}

	/**
	 * The key.
	 *
	 * @param key
	 *            the new key
	 */
	public void setKey(final K key)
	{
		this.key = key;
	}

	/**
	 * The map with the values.
	 *
	 * @return the values
	 */
	public Map getValues()
	{
		return this.values;
	}

	/**
	 * The map with the values.
	 *
	 * @param values
	 *            the values
	 */
	public void setValues(final Map values)
	{
		this.values = values;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int hashCode()
	{
		final int PRIME = 59;
		int result = 1;
		final Object $key = this.getKey();
		result = result * PRIME + ($key == null ? 43 : $key.hashCode());
		final Object $values = this.getValues();
		result = result * PRIME + ($values == null ? 43 : $values.hashCode());
		return result;
	}

	/**
	 * To builder.
	 *
	 * @return the key map pair builder
	 */
	public KeyMapPairBuilder toBuilder()
	{
		return new KeyMapPairBuilder().key(this.key).values(this.values);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString()
	{
		return "KeyMapPair(key=" + this.getKey() + ", values=" + this.getValues() + ")";
	}

	/**
	 * The class {@link KeyMapPairBuilder}.
	 *
	 * @param 
	 *            the key type
	 * @param 
	 *            the generic type
	 * @param 
	 *            the generic type
	 */
	public static class KeyMapPairBuilder
	{

		/** The key. */
		private K key;

		/** The values. */
		private Map values;

		/**
		 * Instantiates a new key map pair builder.
		 */
		KeyMapPairBuilder()
		{
		}

		/**
		 * Build it
		 *
		 * @return the key map pair
		 */
		public KeyMapPair build()
		{
			return new KeyMapPair<>(key, values);
		}

		/**
		 * The key.
		 *
		 * @param key
		 *            the key
		 * @return the key map pair builder
		 */
		public KeyMapPairBuilder key(final K key)
		{
			this.key = key;
			return this;
		}

		/**
		 * {@inheritDoc}
		 */
		@Override
		public String toString()
		{
			return "KeyMapPair.KeyMapPairBuilder(key=" + this.key + ", values=" + this.values + ")";
		}

		/**
		 * The map with the values.
		 *
		 * @param values
		 *            the values
		 * @return the key map pair builder
		 */
		public KeyMapPairBuilder values(final Map values)
		{
			this.values = values;
			return this;
		}
	}
}