no.digipost.tuple.Pentuple Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of digg Show documentation
Some stellar general purpose utils.
The newest version!
/*
 * Copyright (C) Posten Norge AS
 *
 * 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 no.digipost.tuple;

import no.digipost.function.PentaFunction;

import java.util.function.Function;

import static no.digipost.tuple.XTuple.TERMINATOR;

/**
 * A pentuple is a simple composition of five arbitrary values (objects). A pentuple
 * captures no semantics of the five values, and they are only referred to as
 * "the first", "the second", "the third", "the fourth", and "the fifth" value.
 *
 * @param  The type of the first value
 * @param  The type of the second value
 * @param  The type of the third value
 * @param  The type of the fourth value
 * @param  The type of the fifth value
 */
public interface Pentuple extends ViewableAsPentuple {

    static  Pentuple of(T1 first, T2 second, T3 third, T4 fourth, T5 fifth) {
        return new XTuple<>(first, second, third, fourth, fifth, TERMINATOR, null, null, null, null);
    }

    static  Pentuple flatten(Tuple, T3>, T4>, T5> nestedTuple) {
        return Pentuple.of(nestedTuple.first().first().first().first(),
                           nestedTuple.first().first().first().second(),
                           nestedTuple.first().first().second(),
                           nestedTuple.first().second(),
                           nestedTuple.second());
    }

    /**
     * @return the first value
     */
    T1 first();

    /**
     * @return the second value
     */
    T2 second();

    /**
     * @return the third value
     */
    T3 third();

    /**
     * @return the fourth value
     */
    T4 fourth();

    /**
     * @return the fifth value
     */
    T5 fifth();


    /**
     * Create a new pentuple by applying a function to the first element, and putting the
     * result as the first element of the new pentuple.
     *
     * @param mapper the function to apply to the first element
     * @return the new pentuple
     */
     Pentuple mapFirst(Function mapper);


    /**
     * Create a new pentuple by applying a function to the second element, and putting the
     * result as the second element of the new pentuple.
     *
     * @param mapper the function to apply to the second element
     * @return the new pentuple
     */
     Pentuple mapSecond(Function mapper);


    /**
     * Create a new pentuple by applying a function to the third element, and putting the
     * result as the third element of the new pentuple.
     *
     * @param mapper the function to apply to the third element
     * @return the new pentuple
     */
     Pentuple mapThird(Function mapper);


    /**
     * Create a new pentuple by applying a function to the fourth element, and putting the
     * result as the fourth element of the new pentuple.
     *
     * @param mapper the function to apply to the fourth element
     * @return the new pentuple
     */
     Pentuple mapFourth(Function mapper);


    /**
     * Create a new pentuple by applying a function to the fifth element, and putting the
     * result as the fifth element of the new pentuple.
     *
     * @param mapper the function to apply to the fifth element
     * @return the new pentuple
     */
     Pentuple mapFifth(Function mapper);


    /**
     * Create a new pentuple by applying a function to each element, and putting the
     * results into a new pentuple.
     *
     * @param firstMapper  the function to apply to the first element
     * @param secondMapper the function to apply to the second element
     * @param thirdMapper  the function to apply to the third element
     * @param fourthMapper the function to apply to the fourth element
     * @param fifthMapper  the function to apply to the fifth element
     * @return the new pentuple
     */
     Pentuple map(Function firstMapper,
                                                          Function secondMapper,
                                                          Function thirdMapper,
                                                          Function fourthMapper,
                                                          Function fifthMapper);


    /**
     * @return this pentuple instance
     */
    @Override
    Pentuple asPentuple();


    /**
     * Convert this pentuple to an instance of an arbitrary type.
     *
     * @param  The type of the resulting instance
     * @param convertor the function used to convert the contained
     *                  values to a resulting compound instance.
     * @return the result from the given function
     */
     R to(PentaFunction convertor);

}