All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

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;

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

	/**
	 * The serialVersionUID.
	 */
	private static final long serialVersionUID = 1L;
	/**
	 * The left value.
	 */
	private L left;
	/**
	 * The middle value.
	 */
	private M middle;
	/**
	 * The right value.
	 */
	private R right;

	/**
	 * Instantiates a new triple.
	 */
	public Triple()
	{
	}

	/**
	 * Instantiates a new triple.
	 *
	 * @param left
	 *            the left
	 * @param middle
	 *            the middle
	 * @param right
	 *            the right
	 */
	public Triple(final L left, final M middle, final R right)
	{
		this.left = left;
		this.middle = middle;
		this.right = right;
	}

	/**
	 * Builder.
	 *
	 * @param 
	 *            the generic type
	 * @param 
	 *            the generic type
	 * @param 
	 *            the generic type
	 * @return the triple builder
	 */
	public static  TripleBuilder builder()
	{
		return new TripleBuilder<>();
	}

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

	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean equals(final Object o)
	{
		if (o == this)
		{
			return true;
		}
		if (!(o instanceof Triple))
		{
			return false;
		}
		final Triple other = (Triple)o;
		if (!other.canEqual(this))
		{
			return false;
		}
		final Object this$left = this.getLeft();
		final Object other$left = other.getLeft();
		if (this$left == null ? other$left != null : !this$left.equals(other$left))
		{
			return false;
		}
		final Object this$middle = this.getMiddle();
		final Object other$middle = other.getMiddle();
		if (this$middle == null ? other$middle != null : !this$middle.equals(other$middle))
		{
			return false;
		}
		final Object this$right = this.getRight();
		final Object other$right = other.getRight();
		if (this$right == null ? other$right != null : !this$right.equals(other$right))
		{
			return false;
		}
		return true;
	}

	/**
	 * The left value.
	 *
	 * @return the left
	 */
	public L getLeft()
	{
		return this.left;
	}

	/**
	 * The left value.
	 *
	 * @param left
	 *            the new left
	 */
	public void setLeft(final L left)
	{
		this.left = left;
	}

	/**
	 * The middle value.
	 *
	 * @return the middle
	 */
	public M getMiddle()
	{
		return this.middle;
	}

	/**
	 * The middle value.
	 *
	 * @param middle
	 *            the new middle
	 */
	public void setMiddle(final M middle)
	{
		this.middle = middle;
	}

	/**
	 * The right value.
	 *
	 * @return the right
	 */
	public R getRight()
	{
		return this.right;
	}

	/**
	 * The right value.
	 *
	 * @param right
	 *            the new right
	 */
	public void setRight(final R right)
	{
		this.right = right;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int hashCode()
	{
		final int PRIME = 59;
		int result = 1;
		final Object $left = this.getLeft();
		result = result * PRIME + ($left == null ? 43 : $left.hashCode());
		final Object $middle = this.getMiddle();
		result = result * PRIME + ($middle == null ? 43 : $middle.hashCode());
		final Object $right = this.getRight();
		result = result * PRIME + ($right == null ? 43 : $right.hashCode());
		return result;
	}

	/**
	 * To builder.
	 *
	 * @return the triple builder
	 */
	public TripleBuilder toBuilder()
	{
		return new TripleBuilder().left(this.left).middle(this.middle).right(this.right);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString()
	{
		return "Triple(left=" + this.getLeft() + ", middle=" + this.getMiddle() + ", right="
			+ this.getRight() + ")";
	}

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

		/** The left. */
		private L left;

		/** The middle. */
		private M middle;

		/** The right. */
		private R right;

		/**
		 * Instantiates a new triple builder.
		 */
		TripleBuilder()
		{
		}

		/**
		 * Build it
		 *
		 * @return the triple
		 */
		public Triple build()
		{
			return new Triple<>(left, middle, right);
		}

		/**
		 * The left value.
		 *
		 * @param left
		 *            the left
		 * @return the triple builder
		 */
		public TripleBuilder left(final L left)
		{
			this.left = left;
			return this;
		}

		/**
		 * The middle value.
		 *
		 * @param middle
		 *            the middle
		 * @return the triple builder
		 */
		public TripleBuilder middle(final M middle)
		{
			this.middle = middle;
			return this;
		}

		/**
		 * The right value.
		 *
		 * @param right
		 *            the right
		 * @return the triple builder
		 */
		public TripleBuilder right(final R right)
		{
			this.right = right;
			return this;
		}

		/**
		 * {@inheritDoc}
		 */
		@Override
		public String toString()
		{
			return "Triple.TripleBuilder(left=" + this.left + ", middle=" + this.middle + ", right="
				+ this.right + ")";
		}
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy