com.speedment.common.tuple.TupleOfNullables Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tuple Show documentation

A collection of Immutable Tuple classes that represent sets of a fixed length where every element has a specific type.

There is a newer version: 3.2.10

/*
 *
 * 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.TupleGetter;
import java.util.Optional;
import java.util.stream.IntStream;
import java.util.stream.Stream;

/**
 * This interface defines a generic Tuple of any order that can hold null
 * values. A Tuple is type safe, immutable and thread safe. For pure non-null
 * value elements see {@link Tuple}
 *
 * @author pemi
 * @see Tuple
 *
 */
public interface TupleOfNullables extends BasicTuple> {

    /**
     * Returns a {@link Stream} of all values for this Tuple. If sequential, the
     * Stream will start with the 0:th tuple and progress upwards.
     *
     * @return a {@link Stream} of all values for this Tuple
     */
    default Stream> stream() {
        return IntStream.range(0, degree())
            .mapToObj(this::get);
    }

    @Override
    default  Stream streamOf(Class clazz) {
        return stream()
            .filter(Optional::isPresent)
            .map(Optional::get)
            .filter(clazz::isInstance)
            .map(clazz::cast);
    }

     /**
     * Returns a getter method for the specified ordinal element.
     *
     * @param index    the position of the element to return
     * @param   the type of the tuple
     * @param       the type of the returned element
     * @return         the created getter
     */
    static  TupleGetter getter(int index) {
        return new TupleGetter() {
            @Override
            public int index() {
                return index;
            }

            @Override
            @SuppressWarnings("unchecked")
            public R apply(TUPLE tuple) {
                return (R) tuple.get(index);
            }
        };
    }
    
    
}