com.speedment.common.tuple.Tuple4 Maven / Gradle / Ivy
Show all versions of runtime-deploy Show documentation
/**
*
* Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
*
* 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 com.speedment.common.tuple;
import com.speedment.common.tuple.getter.TupleGetter0;
import com.speedment.common.tuple.getter.TupleGetter1;
import com.speedment.common.tuple.getter.TupleGetter2;
import com.speedment.common.tuple.getter.TupleGetter3;
import com.speedment.common.tuple.getter.TupleGetter;
/**
* This interface defines a generic {@link Tuple} of degree 4 that can hold
* non-null values. A Tuple is type safe, immutable and thread safe. For tuples
* that can hold null elements see {@link TupleOfNullables}. For mutable tuples
* see {@link MutableTuple}
*
* This {@link Tuple} has a degree of 4
*
* Generated by com.speedment.sources.pattern.tuple.TuplePattern
*
* @param type of element 0
* @param type of element 1
* @param type of element 2
* @param type of element 3
*
* @author Per Minborg
*
* @see Tuple
* @see TupleOfNullables
* @see MutableTuple
*/
public interface Tuple4 extends Tuple {
/**
* Returns the 0th element from this tuple.
*
* @return the 0th element from this tuple.
*/
T0 get0();
/**
* Returns the 1st element from this tuple.
*
* @return the 1st element from this tuple.
*/
T1 get1();
/**
* Returns the 2nd element from this tuple.
*
* @return the 2nd element from this tuple.
*/
T2 get2();
/**
* Returns the 3rd element from this tuple.
*
* @return the 3rd element from this tuple.
*/
T3 get3();
@Override
default int degree() {
return 4;
}
default Object get(int index) {
switch (index) {
case 0 : return get0();
case 1 : return get1();
case 2 : return get2();
case 3 : return get3();
default : throw new IllegalArgumentException(String.format("Index %d is outside bounds of tuple of degree %s", index, degree()
));
}
}
/**
* Returns a {@link TupleGetter getter} for the 0th element in the {@code
* Tuple}.
*
* @return the element at the 0th position
* @param the 0th element type
* @param the 1st element type
* @param the 2nd element type
* @param the 3rd element type
*/
static TupleGetter0, T0> getter0() {
return Tuple4::get0;
}
/**
* Returns a {@link TupleGetter getter} for the 1st element in the {@code
* Tuple}.
*
* @return the element at the 1st position
* @param the 0th element type
* @param the 1st element type
* @param the 2nd element type
* @param the 3rd element type
*/
static TupleGetter1, T1> getter1() {
return Tuple4::get1;
}
/**
* Returns a {@link TupleGetter getter} for the 2nd element in the {@code
* Tuple}.
*
* @return the element at the 2nd position
* @param the 0th element type
* @param the 1st element type
* @param the 2nd element type
* @param the 3rd element type
*/
static TupleGetter2, T2> getter2() {
return Tuple4::get2;
}
/**
* Returns a {@link TupleGetter getter} for the 3rd element in the {@code
* Tuple}.
*
* @return the element at the 3rd position
* @param the 0th element type
* @param the 1st element type
* @param the 2nd element type
* @param the 3rd element type
*/
static TupleGetter3, T3> getter3() {
return Tuple4::get3;
}
}