io.github.astrapi69.collection.pair.Pair 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.collection.pair;

import java.io.Serializable;

/**
 * The class {@link Pair} represents a pair of values with generic parameters for the values.
 *
 *
 * @param 
 *            The generic type of the left content of this Pair.
 * @param 
 *            The generic type of the right content of this Pair.
 */
public class Pair implements Serializable
{

	/**
	 * The Constant serialVersionUID.
	 */
	private static final long serialVersionUID = 1L;
	/**
	 * The left.
	 */
	private K leftContent;
	/**
	 * The right.
	 */
	private V rightContent;

	/**
	 * Instantiates a new pair.
	 */
	public Pair()
	{
	}

	/**
	 * Instantiates a new pair.
	 *
	 * @param leftContent
	 *            the left content
	 * @param rightContent
	 *            the right content
	 */
	public Pair(final K leftContent, final V rightContent)
	{
		this.leftContent = leftContent;
		this.rightContent = rightContent;
	}

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

	/**
	 * Can equal.
	 *
	 * @param other
	 *            the other
	 * @return true, if successful
	 */
	protected boolean canEqual(final Object other)
	{
		return other instanceof Pair;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean equals(final Object o)
	{
		if (o == this)
		{
			return true;
		}
		if (!(o instanceof Pair))
		{
			return false;
		}
		final Pair other = (Pair)o;
		if (!other.canEqual(this))
		{
			return false;
		}
		final Object this$leftContent = this.getLeftContent();
		final Object other$leftContent = other.getLeftContent();
		if (this$leftContent == null
			? other$leftContent != null
			: !this$leftContent.equals(other$leftContent))
		{
			return false;
		}
		final Object this$rightContent = this.getRightContent();
		final Object other$rightContent = other.getRightContent();
		if (this$rightContent == null
			? other$rightContent != null
			: !this$rightContent.equals(other$rightContent))
		{
			return false;
		}
		return true;
	}

	/**
	 * The left.
	 *
	 * @return the left content
	 */
	public K getLeftContent()
	{
		return this.leftContent;
	}

	/**
	 * The left.
	 *
	 * @param leftContent
	 *            the new left content
	 */
	public void setLeftContent(final K leftContent)
	{
		this.leftContent = leftContent;
	}

	/**
	 * The right.
	 *
	 * @return the right content
	 */
	public V getRightContent()
	{
		return this.rightContent;
	}

	/**
	 * The right.
	 *
	 * @param rightContent
	 *            the new right content
	 */
	public void setRightContent(final V rightContent)
	{
		this.rightContent = rightContent;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int hashCode()
	{
		final int PRIME = 59;
		int result = 1;
		final Object $leftContent = this.getLeftContent();
		result = result * PRIME + ($leftContent == null ? 43 : $leftContent.hashCode());
		final Object $rightContent = this.getRightContent();
		result = result * PRIME + ($rightContent == null ? 43 : $rightContent.hashCode());
		return result;
	}

	/**
	 * To builder.
	 *
	 * @return the pair builder
	 */
	public PairBuilder toBuilder()
	{
		return new PairBuilder().leftContent(this.leftContent)
			.rightContent(this.rightContent);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString()
	{
		return "Pair(leftContent=" + this.getLeftContent() + ", rightContent="
			+ this.getRightContent() + ")";
	}

	/**
	 * The class {@link PairBuilder}.
	 *
	 * @param 
	 *            the key type
	 * @param 
	 *            the value type
	 */
	public static class PairBuilder
	{

		/** The left content. */
		private K leftContent;

		/** The right content. */
		private V rightContent;

		/**
		 * Instantiates a new pair builder.
		 */
		PairBuilder()
		{
		}

		/**
		 * Build it
		 *
		 * @return the pair
		 */
		public Pair build()
		{
			return new Pair<>(leftContent, rightContent);
		}

		/**
		 * The left.
		 *
		 * @param leftContent
		 *            the left content
		 * @return the pair builder
		 */
		public PairBuilder leftContent(final K leftContent)
		{
			this.leftContent = leftContent;
			return this;
		}


		/**
		 * The right.
		 *
		 * @param rightContent
		 *            the right content
		 * @return the pair builder
		 */
		public PairBuilder rightContent(final V rightContent)
		{
			this.rightContent = rightContent;
			return this;
		}

		/**
		 * {@inheritDoc}
		 */
		@Override
		public String toString()
		{
			return "Pair.PairBuilder(leftContent=" + this.leftContent + ", rightContent="
				+ this.rightContent + ")";
		}
	}
}