functionalj.stream.AsStreamPlus 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.function.Consumer;
import java.util.stream.Stream;

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

class AsStreamPlusHelper {
    
    /** @return  the stream plus instance of this object. */
    public static  StreamPlus streamFrom(AsStreamPlus streamPlus) {
        return streamPlus.streamPlus();
    }
    
}

/**
 * Classes implementing this interface can provider a StreamPlus instance of itself.
 *
 * @param  the data type of the stream plus.
 *
 * @author NawaMan -- [email protected]
 */
@FunctionalInterface
public interface AsStreamPlus
                    extends
                        AsStreamPlusWithCalculate,
                        AsStreamPlusWithCollect,
                        AsStreamPlusWithConversion,
                        AsStreamPlusWithForEach,
                        AsStreamPlusWithGroupingBy,
                        AsStreamPlusWithMatch,
                        AsStreamPlusWithReduce,
                        AsStreamPlusWithStatistic {
    
    /** @return  the stream plus instance of this object. */
    public StreamPlus streamPlus();
    
    /** @return  return the stream underneath the stream plus. */
    public default Stream stream() {
        return streamPlus();
    }
    
    /** Iterate all element through the action */
    @Eager
    @Terminal
    public default void forEach(Consumer action) {
        val streamPlus = streamPlus();
        streamPlus
        .forEach(action);
    }
    
}