functionalj.stream.AsStreamPlusWithForEach Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of functionalj-core Show documentation
The module for FunctionalJ Core.
There is a newer version: 1.0.17
// ============================================================================
// Copyright (c) 2017-2021 Nawapunth Manusitthipol (NawaMan - http://nawaman.net).
// ----------------------------------------------------------------------------
// MIT License
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// ============================================================================
package functionalj.stream;

import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Consumer;

import functionalj.function.IntObjBiConsumer;
import functionalj.stream.markers.Eager;
import functionalj.stream.markers.Terminal;
import lombok.val;


public interface AsStreamPlusWithForEach {
    
    public StreamPlus streamPlus();
    
    
    /** Iterate in order all element through the action */
    public default void forEachOrdered(Consumer action) {
        val streamPlus = streamPlus();
        streamPlus
        .forEachOrdered(action);
    }
    
    /** For each with the index. */
    @Eager
    @Terminal
    public default void forEachWithIndex(IntObjBiConsumer action) {
        val streamPlus = streamPlus();
        val index      = new AtomicInteger();
        streamPlus
        .forEach(each -> {
            val currentIndex = index.getAndIncrement();
            action.accept(currentIndex, each);
        });
    }
    
    /** Populate the array with the population in the stream from 0 to length or until run out of elements. */
    @Terminal
    public default void populateArray(DATA[] array) {
        val streamPlus = streamPlus();
        streamPlus
        .limit           (array.length)
        .forEachWithIndex((index, element) -> {
            array[index] = element;
        });
    }
    
    /** Populate the array with the population in the stream from offset to length or until run out of elements. */
    @Terminal
    public default void populateArray(DATA[] array, int offset) {
        val streamPlus = streamPlus();
        streamPlus
        .limit           (array.length - offset)
        .forEachWithIndex((index, element) -> {
            array[offset + index] = element;
        });
    }
    
    /** Populate the array with the population in the stream from offset to length or until run out of elements. */
    @Terminal
    public default void populateArray(DATA[] array, int offset, int length) {
        val streamPlus = streamPlus();
        streamPlus
        .limit           (Math.min(length, array.length - offset))
        .forEachWithIndex((index, element) -> {
            array[offset + index] = element;
        });
    }
    
    // TODO - addAllTo(List|Set)
    // TODO - insertAllTo(index, List|Set)
    // TODO - putAllTo(Map)
    
    
}