io.vavr.Tuple8 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vavr Show documentation
Show all versions of vavr Show documentation
Vavr is an object-functional library for Java 8+
/* __ __ __ __ __ ___
* \ \ / / \ \ / / __/
* \ \/ / /\ \ \/ / /
* \____/__/ \__\____/__/
*
* Copyright 2014-2021 Vavr, http://vavr.io
*
* 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 io.vavr;
/*-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*\
G E N E R A T O R C R A F T E D
\*-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
import io.vavr.collection.List;
import io.vavr.collection.Seq;
import java.io.Serializable;
import java.util.Comparator;
import java.util.Objects;
import java.util.function.Function;
/**
* A tuple of 8 elements which can be seen as cartesian product of 8 components.
*
* @param type of the 1st element
* @param type of the 2nd element
* @param type of the 3rd element
* @param type of the 4th element
* @param type of the 5th element
* @param type of the 6th element
* @param type of the 7th element
* @param type of the 8th element
* @author Daniel Dietrich
*/
public final class Tuple8 implements Tuple, Comparable>, Serializable {
private static final long serialVersionUID = 1L;
/**
* The 1st element of this tuple.
*/
public final T1 _1;
/**
* The 2nd element of this tuple.
*/
public final T2 _2;
/**
* The 3rd element of this tuple.
*/
public final T3 _3;
/**
* The 4th element of this tuple.
*/
public final T4 _4;
/**
* The 5th element of this tuple.
*/
public final T5 _5;
/**
* The 6th element of this tuple.
*/
public final T6 _6;
/**
* The 7th element of this tuple.
*/
public final T7 _7;
/**
* The 8th element of this tuple.
*/
public final T8 _8;
/**
* Constructs a tuple of 8 elements.
*
* @param t1 the 1st element
* @param t2 the 2nd element
* @param t3 the 3rd element
* @param t4 the 4th element
* @param t5 the 5th element
* @param t6 the 6th element
* @param t7 the 7th element
* @param t8 the 8th element
*/
public Tuple8(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7, T8 t8) {
this._1 = t1;
this._2 = t2;
this._3 = t3;
this._4 = t4;
this._5 = t5;
this._6 = t6;
this._7 = t7;
this._8 = t8;
}
public static Comparator> comparator(Comparator t1Comp, Comparator t2Comp, Comparator t3Comp, Comparator t4Comp, Comparator t5Comp, Comparator t6Comp, Comparator t7Comp, Comparator t8Comp) {
return (Comparator> & Serializable) (t1, t2) -> {
final int check1 = t1Comp.compare(t1._1, t2._1);
if (check1 != 0) {
return check1;
}
final int check2 = t2Comp.compare(t1._2, t2._2);
if (check2 != 0) {
return check2;
}
final int check3 = t3Comp.compare(t1._3, t2._3);
if (check3 != 0) {
return check3;
}
final int check4 = t4Comp.compare(t1._4, t2._4);
if (check4 != 0) {
return check4;
}
final int check5 = t5Comp.compare(t1._5, t2._5);
if (check5 != 0) {
return check5;
}
final int check6 = t6Comp.compare(t1._6, t2._6);
if (check6 != 0) {
return check6;
}
final int check7 = t7Comp.compare(t1._7, t2._7);
if (check7 != 0) {
return check7;
}
final int check8 = t8Comp.compare(t1._8, t2._8);
if (check8 != 0) {
return check8;
}
// all components are equal
return 0;
};
}
@SuppressWarnings("unchecked")
private static , U2 extends Comparable, U3 extends Comparable, U4 extends Comparable, U5 extends Comparable, U6 extends Comparable, U7 extends Comparable, U8 extends Comparable> int compareTo(Tuple8 o1, Tuple8 o2) {
final Tuple8 t1 = (Tuple8) o1;
final Tuple8 t2 = (Tuple8) o2;
final int check1 = t1._1.compareTo(t2._1);
if (check1 != 0) {
return check1;
}
final int check2 = t1._2.compareTo(t2._2);
if (check2 != 0) {
return check2;
}
final int check3 = t1._3.compareTo(t2._3);
if (check3 != 0) {
return check3;
}
final int check4 = t1._4.compareTo(t2._4);
if (check4 != 0) {
return check4;
}
final int check5 = t1._5.compareTo(t2._5);
if (check5 != 0) {
return check5;
}
final int check6 = t1._6.compareTo(t2._6);
if (check6 != 0) {
return check6;
}
final int check7 = t1._7.compareTo(t2._7);
if (check7 != 0) {
return check7;
}
final int check8 = t1._8.compareTo(t2._8);
if (check8 != 0) {
return check8;
}
// all components are equal
return 0;
}
@Override
public int arity() {
return 8;
}
@Override
public int compareTo(Tuple8 that) {
return Tuple8.compareTo(this, that);
}
/**
* Getter of the 1st element of this tuple.
*
* @return the 1st element of this Tuple.
*/
public T1 _1() {
return _1;
}
/**
* Sets the 1st element of this tuple to the given {@code value}.
*
* @param value the new value
* @return a copy of this tuple with a new value for the 1st element of this Tuple.
*/
public Tuple8 update1(T1 value) {
return new Tuple8<>(value, _2, _3, _4, _5, _6, _7, _8);
}
/**
* Getter of the 2nd element of this tuple.
*
* @return the 2nd element of this Tuple.
*/
public T2 _2() {
return _2;
}
/**
* Sets the 2nd element of this tuple to the given {@code value}.
*
* @param value the new value
* @return a copy of this tuple with a new value for the 2nd element of this Tuple.
*/
public Tuple8 update2(T2 value) {
return new Tuple8<>(_1, value, _3, _4, _5, _6, _7, _8);
}
/**
* Getter of the 3rd element of this tuple.
*
* @return the 3rd element of this Tuple.
*/
public T3 _3() {
return _3;
}
/**
* Sets the 3rd element of this tuple to the given {@code value}.
*
* @param value the new value
* @return a copy of this tuple with a new value for the 3rd element of this Tuple.
*/
public Tuple8 update3(T3 value) {
return new Tuple8<>(_1, _2, value, _4, _5, _6, _7, _8);
}
/**
* Getter of the 4th element of this tuple.
*
* @return the 4th element of this Tuple.
*/
public T4 _4() {
return _4;
}
/**
* Sets the 4th element of this tuple to the given {@code value}.
*
* @param value the new value
* @return a copy of this tuple with a new value for the 4th element of this Tuple.
*/
public Tuple8 update4(T4 value) {
return new Tuple8<>(_1, _2, _3, value, _5, _6, _7, _8);
}
/**
* Getter of the 5th element of this tuple.
*
* @return the 5th element of this Tuple.
*/
public T5 _5() {
return _5;
}
/**
* Sets the 5th element of this tuple to the given {@code value}.
*
* @param value the new value
* @return a copy of this tuple with a new value for the 5th element of this Tuple.
*/
public Tuple8 update5(T5 value) {
return new Tuple8<>(_1, _2, _3, _4, value, _6, _7, _8);
}
/**
* Getter of the 6th element of this tuple.
*
* @return the 6th element of this Tuple.
*/
public T6 _6() {
return _6;
}
/**
* Sets the 6th element of this tuple to the given {@code value}.
*
* @param value the new value
* @return a copy of this tuple with a new value for the 6th element of this Tuple.
*/
public Tuple8 update6(T6 value) {
return new Tuple8<>(_1, _2, _3, _4, _5, value, _7, _8);
}
/**
* Getter of the 7th element of this tuple.
*
* @return the 7th element of this Tuple.
*/
public T7 _7() {
return _7;
}
/**
* Sets the 7th element of this tuple to the given {@code value}.
*
* @param value the new value
* @return a copy of this tuple with a new value for the 7th element of this Tuple.
*/
public Tuple8 update7(T7 value) {
return new Tuple8<>(_1, _2, _3, _4, _5, _6, value, _8);
}
/**
* Getter of the 8th element of this tuple.
*
* @return the 8th element of this Tuple.
*/
public T8 _8() {
return _8;
}
/**
* Sets the 8th element of this tuple to the given {@code value}.
*
* @param value the new value
* @return a copy of this tuple with a new value for the 8th element of this Tuple.
*/
public Tuple8 update8(T8 value) {
return new Tuple8<>(_1, _2, _3, _4, _5, _6, _7, value);
}
/**
* Maps the components of this tuple using a mapper function.
*
* @param mapper the mapper function
* @param new type of the 1st component
* @param new type of the 2nd component
* @param new type of the 3rd component
* @param new type of the 4th component
* @param new type of the 5th component
* @param new type of the 6th component
* @param new type of the 7th component
* @param new type of the 8th component
* @return A new Tuple of same arity.
* @throws NullPointerException if {@code mapper} is null
*/
public Tuple8 map(Function8> mapper) {
Objects.requireNonNull(mapper, "mapper is null");
return mapper.apply(_1, _2, _3, _4, _5, _6, _7, _8);
}
/**
* Maps the components of this tuple using a mapper function for each component.
*
* @param f1 the mapper function of the 1st component
* @param f2 the mapper function of the 2nd component
* @param f3 the mapper function of the 3rd component
* @param f4 the mapper function of the 4th component
* @param f5 the mapper function of the 5th component
* @param f6 the mapper function of the 6th component
* @param f7 the mapper function of the 7th component
* @param f8 the mapper function of the 8th component
* @param new type of the 1st component
* @param new type of the 2nd component
* @param new type of the 3rd component
* @param new type of the 4th component
* @param new type of the 5th component
* @param new type of the 6th component
* @param new type of the 7th component
* @param new type of the 8th component
* @return A new Tuple of same arity.
* @throws NullPointerException if one of the arguments is null
*/
public Tuple8 map(Function f1, Function f2, Function f3, Function f4, Function f5, Function f6, Function f7, Function f8) {
Objects.requireNonNull(f1, "f1 is null");
Objects.requireNonNull(f2, "f2 is null");
Objects.requireNonNull(f3, "f3 is null");
Objects.requireNonNull(f4, "f4 is null");
Objects.requireNonNull(f5, "f5 is null");
Objects.requireNonNull(f6, "f6 is null");
Objects.requireNonNull(f7, "f7 is null");
Objects.requireNonNull(f8, "f8 is null");
return Tuple.of(f1.apply(_1), f2.apply(_2), f3.apply(_3), f4.apply(_4), f5.apply(_5), f6.apply(_6), f7.apply(_7), f8.apply(_8));
}
/**
* Maps the 1st component of this tuple to a new value.
*
* @param new type of the 1st component
* @param mapper A mapping function
* @return a new tuple based on this tuple and substituted 1st component
*/
public Tuple8 map1(Function mapper) {
Objects.requireNonNull(mapper, "mapper is null");
final U u = mapper.apply(_1);
return Tuple.of(u, _2, _3, _4, _5, _6, _7, _8);
}
/**
* Maps the 2nd component of this tuple to a new value.
*
* @param new type of the 2nd component
* @param mapper A mapping function
* @return a new tuple based on this tuple and substituted 2nd component
*/
public Tuple8 map2(Function mapper) {
Objects.requireNonNull(mapper, "mapper is null");
final U u = mapper.apply(_2);
return Tuple.of(_1, u, _3, _4, _5, _6, _7, _8);
}
/**
* Maps the 3rd component of this tuple to a new value.
*
* @param new type of the 3rd component
* @param mapper A mapping function
* @return a new tuple based on this tuple and substituted 3rd component
*/
public Tuple8 map3(Function mapper) {
Objects.requireNonNull(mapper, "mapper is null");
final U u = mapper.apply(_3);
return Tuple.of(_1, _2, u, _4, _5, _6, _7, _8);
}
/**
* Maps the 4th component of this tuple to a new value.
*
* @param new type of the 4th component
* @param mapper A mapping function
* @return a new tuple based on this tuple and substituted 4th component
*/
public Tuple8 map4(Function mapper) {
Objects.requireNonNull(mapper, "mapper is null");
final U u = mapper.apply(_4);
return Tuple.of(_1, _2, _3, u, _5, _6, _7, _8);
}
/**
* Maps the 5th component of this tuple to a new value.
*
* @param new type of the 5th component
* @param mapper A mapping function
* @return a new tuple based on this tuple and substituted 5th component
*/
public Tuple8 map5(Function mapper) {
Objects.requireNonNull(mapper, "mapper is null");
final U u = mapper.apply(_5);
return Tuple.of(_1, _2, _3, _4, u, _6, _7, _8);
}
/**
* Maps the 6th component of this tuple to a new value.
*
* @param new type of the 6th component
* @param mapper A mapping function
* @return a new tuple based on this tuple and substituted 6th component
*/
public Tuple8 map6(Function mapper) {
Objects.requireNonNull(mapper, "mapper is null");
final U u = mapper.apply(_6);
return Tuple.of(_1, _2, _3, _4, _5, u, _7, _8);
}
/**
* Maps the 7th component of this tuple to a new value.
*
* @param new type of the 7th component
* @param mapper A mapping function
* @return a new tuple based on this tuple and substituted 7th component
*/
public Tuple8 map7(Function mapper) {
Objects.requireNonNull(mapper, "mapper is null");
final U u = mapper.apply(_7);
return Tuple.of(_1, _2, _3, _4, _5, _6, u, _8);
}
/**
* Maps the 8th component of this tuple to a new value.
*
* @param new type of the 8th component
* @param mapper A mapping function
* @return a new tuple based on this tuple and substituted 8th component
*/
public Tuple8 map8(Function mapper) {
Objects.requireNonNull(mapper, "mapper is null");
final U u = mapper.apply(_8);
return Tuple.of(_1, _2, _3, _4, _5, _6, _7, u);
}
/**
* Transforms this tuple to an object of type U.
*
* @param f Transformation which creates a new object of type U based on this tuple's contents.
* @param type of the transformation result
* @return An object of type U
* @throws NullPointerException if {@code f} is null
*/
public U apply(Function8 f) {
Objects.requireNonNull(f, "f is null");
return f.apply(_1, _2, _3, _4, _5, _6, _7, _8);
}
@Override
public Seq toSeq() {
return List.of(_1, _2, _3, _4, _5, _6, _7, _8);
}
// -- Object
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
} else if (!(o instanceof Tuple8)) {
return false;
} else {
final Tuple8 that = (Tuple8) o;
return Objects.equals(this._1, that._1)
&& Objects.equals(this._2, that._2)
&& Objects.equals(this._3, that._3)
&& Objects.equals(this._4, that._4)
&& Objects.equals(this._5, that._5)
&& Objects.equals(this._6, that._6)
&& Objects.equals(this._7, that._7)
&& Objects.equals(this._8, that._8);
}
}
@Override
public int hashCode() {
return Tuple.hash(_1, _2, _3, _4, _5, _6, _7, _8);
}
@Override
public String toString() {
return "(" + _1 + ", " + _2 + ", " + _3 + ", " + _4 + ", " + _5 + ", " + _6 + ", " + _7 + ", " + _8 + ")";
}
}