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

eu.lunisolar.magma.func.tuple.LBiObjCharTriple Maven / Gradle / Ivy

There is a newer version: 3.0.0
Show newest version
/*
 * This file is part of "lunisolar-magma".
 *
 * (C) Copyright 2014-2019 Lunisolar (http://lunisolar.eu/).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package eu.lunisolar.magma.func.tuple;

import eu.lunisolar.magma.basics.meta.LTuple;
import eu.lunisolar.magma.basics.Null;
import eu.lunisolar.magma.basics.fluent.Fluent;
import eu.lunisolar.magma.func.function.LFunction;
import eu.lunisolar.magma.func.function.to.*;
import eu.lunisolar.magma.func.operator.unary.*;
import eu.lunisolar.magma.func.operator.binary.*;
import eu.lunisolar.magma.func.predicate.*;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import java.util.*;

/**
 * Exact equivalent of input parameters used in LBiObjCharConsumer.
 */
@SuppressWarnings("UnusedDeclaration")
public interface LBiObjCharTriple extends LTuple, LPair {

	int SIZE = 3;

	T1 first();

	default T1 value() {
		return first();
	}

	T2 second();

	char third();

	default Object get(int index) {
		switch (index) {
			case 1 :
				return first();
			case 2 :
				return second();
			case 3 :
				return third();
			default :
				throw new NoSuchElementException();
		}
	}

	/** Tuple size */
	default int size() {
		return SIZE;
	}

	/** Static hashCode() implementation method that takes same arguments as fields of the LBiObjCharTriple and calculates hash from it. */
	static  int argHashCode(T1 a1, T2 a2, char a3) {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((a1 == null) ? 0 : a1.hashCode());
		result = prime * result + ((a2 == null) ? 0 : a2.hashCode());
		result = prime * result + Character.hashCode(a3);
		return result;
	}

	/** Static equals() implementation that takes same arguments (doubled) as fields of the LBiObjCharTriple and checks if all values are equal. */
	static  boolean argEquals(T1 a1, T2 a2, char a3, T1 b1, T2 b2, char b3) {
		return Null.equals(a1, b1) && //
				Null.equals(a2, b2) && //
				a3 == b3; //
	}

	/**
	 * Static equals() implementation that takes two tuples asnd checks if they are equal.
	 *
	 * Tuples are considered equal if are implementing same interface and their tuple values are equal regardless of the implementing class.
	 */
	static boolean argEquals(LBiObjCharTriple the, Object that) {
		return Null.equals(the, that, (one, two) -> {
			// Intentionally all implementations of LBiObjCharTriple are allowed.
				if (!(two instanceof LBiObjCharTriple)) {
					return false;
				}

				LBiObjCharTriple other = (LBiObjCharTriple) two;

				return argEquals(one.first(), one.second(), one.third(), other.first(), other.second(), other.third());
			});
	}

	default Iterator iterator() {
		return new Iterator() {

			private int index;

			@Override
			public boolean hasNext() {
				return index < SIZE;
			}

			@Override
			public Object next() {
				index++;
				return get(index);
			}
		};
	}

	interface ComparableBiObjCharTriple, T2 extends Comparable> extends LBiObjCharTriple, Comparable> {

		@Override
		default int compareTo(LBiObjCharTriple that) {
			return Null.compare(this, that, (one, two) -> {
				int retval = 0;

				return (retval = Null.compare(one.first(), two.first())) != 0 ? retval : //
						(retval = Null.compare(one.second(), two.second())) != 0 ? retval : //
								(retval = Character.compare(one.third(), two.third())) != 0 ? retval : 0; //
				});
		}

	}

	abstract class AbstractBiObjCharTriple implements LBiObjCharTriple {

		@Override
		public boolean equals(Object that) {
			return LBiObjCharTriple.argEquals(this, that);
		}

		@Override
		public int hashCode() {
			return LBiObjCharTriple.argHashCode(first(), second(), third());
		}

		@Override
		public String toString() {
			StringBuilder sb = new StringBuilder();
			sb.append('(');
			sb.append(first());
			sb.append(',');
			sb.append(second());
			sb.append(',');
			sb.append(third());
			sb.append(')');
			return sb.toString();
		}

	}

	/**
	 * Mutable, non-comparable tuple.
	 */
	final class MutBiObjCharTriple extends AbstractBiObjCharTriple {

		private T1 first;
		private T2 second;
		private char third;

		public MutBiObjCharTriple(T1 a1, T2 a2, char a3) {
			this.first = a1;
			this.second = a2;
			this.third = a3;
		}

		public static  MutBiObjCharTriple of(T1 a1, T2 a2, char a3) {
			return new MutBiObjCharTriple(a1, a2, a3);
		}

		public static  MutBiObjCharTriple copyOf(LBiObjCharTriple tuple) {
			return of(tuple.first(), tuple.second(), tuple.third());
		}

		public T1 first() {
			return first;
		}

		public MutBiObjCharTriple first(T1 first) {
			this.first = first;
			return this;
		}

		public T2 second() {
			return second;
		}

		public MutBiObjCharTriple second(T2 second) {
			this.second = second;
			return this;
		}

		public char third() {
			return third;
		}

		public MutBiObjCharTriple third(char third) {
			this.third = third;
			return this;
		}

		public MutBiObjCharTriple setFirst(T1 first) {
			this.first = first;
			return this;
		}

		/** Sets value if predicate(newValue) OR newValue::predicate is true */
		public MutBiObjCharTriple setFirstIfArg(T1 first, LPredicate predicate) {
			if (predicate.test(first)) {
				this.first = first;
			}
			return this;
		}

		/** Sets value derived from non-null argument, only if argument is not null. */
		public  MutBiObjCharTriple setFirstIfArgNotNull(R arg, LFunction func) {
			if (arg != null) {
				this.first = func.apply(arg);
			}
			return this;
		}

		/** Sets value if predicate(current) OR current::predicate is true */
		public MutBiObjCharTriple setFirstIf(LPredicate predicate, T1 first) {
			if (predicate.test(this.first)) {
				this.first = first;
			}
			return this;
		}

		/** Sets new value if predicate predicate(newValue, current) OR newValue::something(current) is true. */
		public MutBiObjCharTriple setFirstIf(T1 first, LBiPredicate predicate) {
			// the order of arguments is intentional, to allow predicate:
			if (predicate.test(first, this.first)) {
				this.first = first;
			}
			return this;
		}

		/** Sets new value if predicate predicate(current, newValue) OR current::something(newValue) is true. */
		public MutBiObjCharTriple setFirstIf(LBiPredicate predicate, T1 first) {

			if (predicate.test(this.first, first)) {
				this.first = first;
			}
			return this;
		}

		public MutBiObjCharTriple setSecond(T2 second) {
			this.second = second;
			return this;
		}

		/** Sets value if predicate(newValue) OR newValue::predicate is true */
		public MutBiObjCharTriple setSecondIfArg(T2 second, LPredicate predicate) {
			if (predicate.test(second)) {
				this.second = second;
			}
			return this;
		}

		/** Sets value derived from non-null argument, only if argument is not null. */
		public  MutBiObjCharTriple setSecondIfArgNotNull(R arg, LFunction func) {
			if (arg != null) {
				this.second = func.apply(arg);
			}
			return this;
		}

		/** Sets value if predicate(current) OR current::predicate is true */
		public MutBiObjCharTriple setSecondIf(LPredicate predicate, T2 second) {
			if (predicate.test(this.second)) {
				this.second = second;
			}
			return this;
		}

		/** Sets new value if predicate predicate(newValue, current) OR newValue::something(current) is true. */
		public MutBiObjCharTriple setSecondIf(T2 second, LBiPredicate predicate) {
			// the order of arguments is intentional, to allow predicate:
			if (predicate.test(second, this.second)) {
				this.second = second;
			}
			return this;
		}

		/** Sets new value if predicate predicate(current, newValue) OR current::something(newValue) is true. */
		public MutBiObjCharTriple setSecondIf(LBiPredicate predicate, T2 second) {

			if (predicate.test(this.second, second)) {
				this.second = second;
			}
			return this;
		}

		public MutBiObjCharTriple setThird(char third) {
			this.third = third;
			return this;
		}

		/** Sets value if predicate(newValue) OR newValue::predicate is true */
		public MutBiObjCharTriple setThirdIfArg(char third, LCharPredicate predicate) {
			if (predicate.test(third)) {
				this.third = third;
			}
			return this;
		}

		/** Sets value derived from non-null argument, only if argument is not null. */
		public  MutBiObjCharTriple setThirdIfArgNotNull(R arg, LToCharFunction func) {
			if (arg != null) {
				this.third = func.applyAsChar(arg);
			}
			return this;
		}

		/** Sets value if predicate(current) OR current::predicate is true */
		public MutBiObjCharTriple setThirdIf(LCharPredicate predicate, char third) {
			if (predicate.test(this.third)) {
				this.third = third;
			}
			return this;
		}

		/** Sets new value if predicate predicate(newValue, current) OR newValue::something(current) is true. */
		public MutBiObjCharTriple setThirdIf(char third, LBiCharPredicate predicate) {
			// the order of arguments is intentional, to allow predicate:
			if (predicate.test(third, this.third)) {
				this.third = third;
			}
			return this;
		}

		/** Sets new value if predicate predicate(current, newValue) OR current::something(newValue) is true. */
		public MutBiObjCharTriple setThirdIf(LBiCharPredicate predicate, char third) {

			if (predicate.test(this.third, third)) {
				this.third = third;
			}
			return this;
		}

		public void reset() {
			first = null;
			second = null;
			third = '\u0000';
		}
	}

	/**
	 * Mutable, comparable tuple.
	 */
	final class MutCompBiObjCharTriple, T2 extends Comparable> extends AbstractBiObjCharTriple implements ComparableBiObjCharTriple {

		private T1 first;
		private T2 second;
		private char third;

		public MutCompBiObjCharTriple(T1 a1, T2 a2, char a3) {
			this.first = a1;
			this.second = a2;
			this.third = a3;
		}

		public static , T2 extends Comparable> MutCompBiObjCharTriple of(T1 a1, T2 a2, char a3) {
			return new MutCompBiObjCharTriple(a1, a2, a3);
		}

		public static , T2 extends Comparable> MutCompBiObjCharTriple copyOf(LBiObjCharTriple tuple) {
			return of(tuple.first(), tuple.second(), tuple.third());
		}

		public T1 first() {
			return first;
		}

		public MutCompBiObjCharTriple first(T1 first) {
			this.first = first;
			return this;
		}

		public T2 second() {
			return second;
		}

		public MutCompBiObjCharTriple second(T2 second) {
			this.second = second;
			return this;
		}

		public char third() {
			return third;
		}

		public MutCompBiObjCharTriple third(char third) {
			this.third = third;
			return this;
		}

		public MutCompBiObjCharTriple setFirst(T1 first) {
			this.first = first;
			return this;
		}

		/** Sets value if predicate(newValue) OR newValue::predicate is true */
		public MutCompBiObjCharTriple setFirstIfArg(T1 first, LPredicate predicate) {
			if (predicate.test(first)) {
				this.first = first;
			}
			return this;
		}

		/** Sets value derived from non-null argument, only if argument is not null. */
		public  MutCompBiObjCharTriple setFirstIfArgNotNull(R arg, LFunction func) {
			if (arg != null) {
				this.first = func.apply(arg);
			}
			return this;
		}

		/** Sets value if predicate(current) OR current::predicate is true */
		public MutCompBiObjCharTriple setFirstIf(LPredicate predicate, T1 first) {
			if (predicate.test(this.first)) {
				this.first = first;
			}
			return this;
		}

		/** Sets new value if predicate predicate(newValue, current) OR newValue::something(current) is true. */
		public MutCompBiObjCharTriple setFirstIf(T1 first, LBiPredicate predicate) {
			// the order of arguments is intentional, to allow predicate:
			if (predicate.test(first, this.first)) {
				this.first = first;
			}
			return this;
		}

		/** Sets new value if predicate predicate(current, newValue) OR current::something(newValue) is true. */
		public MutCompBiObjCharTriple setFirstIf(LBiPredicate predicate, T1 first) {

			if (predicate.test(this.first, first)) {
				this.first = first;
			}
			return this;
		}

		public MutCompBiObjCharTriple setSecond(T2 second) {
			this.second = second;
			return this;
		}

		/** Sets value if predicate(newValue) OR newValue::predicate is true */
		public MutCompBiObjCharTriple setSecondIfArg(T2 second, LPredicate predicate) {
			if (predicate.test(second)) {
				this.second = second;
			}
			return this;
		}

		/** Sets value derived from non-null argument, only if argument is not null. */
		public  MutCompBiObjCharTriple setSecondIfArgNotNull(R arg, LFunction func) {
			if (arg != null) {
				this.second = func.apply(arg);
			}
			return this;
		}

		/** Sets value if predicate(current) OR current::predicate is true */
		public MutCompBiObjCharTriple setSecondIf(LPredicate predicate, T2 second) {
			if (predicate.test(this.second)) {
				this.second = second;
			}
			return this;
		}

		/** Sets new value if predicate predicate(newValue, current) OR newValue::something(current) is true. */
		public MutCompBiObjCharTriple setSecondIf(T2 second, LBiPredicate predicate) {
			// the order of arguments is intentional, to allow predicate:
			if (predicate.test(second, this.second)) {
				this.second = second;
			}
			return this;
		}

		/** Sets new value if predicate predicate(current, newValue) OR current::something(newValue) is true. */
		public MutCompBiObjCharTriple setSecondIf(LBiPredicate predicate, T2 second) {

			if (predicate.test(this.second, second)) {
				this.second = second;
			}
			return this;
		}

		public MutCompBiObjCharTriple setThird(char third) {
			this.third = third;
			return this;
		}

		/** Sets value if predicate(newValue) OR newValue::predicate is true */
		public MutCompBiObjCharTriple setThirdIfArg(char third, LCharPredicate predicate) {
			if (predicate.test(third)) {
				this.third = third;
			}
			return this;
		}

		/** Sets value derived from non-null argument, only if argument is not null. */
		public  MutCompBiObjCharTriple setThirdIfArgNotNull(R arg, LToCharFunction func) {
			if (arg != null) {
				this.third = func.applyAsChar(arg);
			}
			return this;
		}

		/** Sets value if predicate(current) OR current::predicate is true */
		public MutCompBiObjCharTriple setThirdIf(LCharPredicate predicate, char third) {
			if (predicate.test(this.third)) {
				this.third = third;
			}
			return this;
		}

		/** Sets new value if predicate predicate(newValue, current) OR newValue::something(current) is true. */
		public MutCompBiObjCharTriple setThirdIf(char third, LBiCharPredicate predicate) {
			// the order of arguments is intentional, to allow predicate:
			if (predicate.test(third, this.third)) {
				this.third = third;
			}
			return this;
		}

		/** Sets new value if predicate predicate(current, newValue) OR current::something(newValue) is true. */
		public MutCompBiObjCharTriple setThirdIf(LBiCharPredicate predicate, char third) {

			if (predicate.test(this.third, third)) {
				this.third = third;
			}
			return this;
		}

		public void reset() {
			first = null;
			second = null;
			third = '\u0000';
		}
	}

	/**
	 * Immutable, non-comparable tuple.
	 */
	@Immutable
	final class ImmBiObjCharTriple extends AbstractBiObjCharTriple {

		private final T1 first;
		private final T2 second;
		private final char third;

		public ImmBiObjCharTriple(T1 a1, T2 a2, char a3) {
			this.first = a1;
			this.second = a2;
			this.third = a3;
		}

		public static  ImmBiObjCharTriple of(T1 a1, T2 a2, char a3) {
			return new ImmBiObjCharTriple(a1, a2, a3);
		}

		public static  ImmBiObjCharTriple copyOf(LBiObjCharTriple tuple) {
			return of(tuple.first(), tuple.second(), tuple.third());
		}

		public T1 first() {
			return first;
		}

		public T2 second() {
			return second;
		}

		public char third() {
			return third;
		}

	}

	/**
	 * Immutable, comparable tuple.
	 */
	@Immutable
	final class ImmCompBiObjCharTriple, T2 extends Comparable> extends AbstractBiObjCharTriple implements ComparableBiObjCharTriple {

		private final T1 first;
		private final T2 second;
		private final char third;

		public ImmCompBiObjCharTriple(T1 a1, T2 a2, char a3) {
			this.first = a1;
			this.second = a2;
			this.third = a3;
		}

		public static , T2 extends Comparable> ImmCompBiObjCharTriple of(T1 a1, T2 a2, char a3) {
			return new ImmCompBiObjCharTriple(a1, a2, a3);
		}

		public static , T2 extends Comparable> ImmCompBiObjCharTriple copyOf(LBiObjCharTriple tuple) {
			return of(tuple.first(), tuple.second(), tuple.third());
		}

		public T1 first() {
			return first;
		}

		public T2 second() {
			return second;
		}

		public char third() {
			return third;
		}

	}

}