package Torello.Java.JSON;

import Torello.JavaDoc.StaticFunctional;
import Torello.JavaDoc.JDHeaderBackgroundImg;

import Torello.JavaDoc.IntoHTMLTable;
import static Torello.JavaDoc.IntoHTMLTable.Background.GreenDither;
import static Torello.JavaDoc.IntoHTMLTable.Background.BlueDither;

import static Torello.Java.JSON.JFlag.NOT_ALLOWED_RET_NULL_MASKS;

import Torello.JavaDoc.JDHeaderBackgroundImg;
import Torello.JavaDoc.LinkJavaSource;
import Torello.JavaDoc.StaticFunctional;

import java.util.stream.IntStream;
import java.util.stream.LongStream;
import java.util.stream.DoubleStream;

import java.util.function.ToIntFunction;
import java.util.function.ToLongFunction;
import java.util.function.ToDoubleFunction;

import javax.json.Json;
import javax.json.JsonArray;

/**
 * Utilities for parsing Json Array's and sending the parsed values into a Java Primitive
 * Stream.
 * 
 * <EMBED CLASS='globalDefs' DATA-A_AN=A>
 * <EMBED CLASS='external-html' DATA-FILE-ID=GLASS_FISH_NOTE>
 * <EMBED CLASS='external-html' DATA-FILE-ID=RJA_INTO_PRIM_STRM>
 * <EMBED CLASS='external-html' DATA-FILE-ID=JSON_BINDING_NOTE>
 * <EMBED CLASS='external-html' DATA-FILE-ID=LOOP_OPTIMIZED_NOTE>
 *
 * @see Json
 * @see JsonArray
 */
@StaticFunctional
@JDHeaderBackgroundImg(EmbedTagFileID="RJA_JDHBI_PRIM_STRM")
public class RJArrIntoPrimStream
{
    private RJArrIntoPrimStream() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Stream Generators
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * <EMBED CLASS=defs DATA-TYPE=Integer DATA-TYPE_LC=int DATA-STRM_TYPE=IntStream DATA-A_AN=An>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_PRIM_STREAM_STRM>
     */
    @IntoHTMLTable(background=GreenDither, title="Generate a Java (Primitive) IntStream")
    @LinkJavaSource(handle="BASIC_TYPES", name="INTEGER")
    @LinkJavaSource(handle="STREAM_BUILDER", name="intStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static IntStream intArr(
            final JsonArray             ja,
            final int                   defaultValue,
            final int                   FLAGS,
            final ToIntFunction<String> optionalUserParser
        )
    {
        return ProcessJsonArray.numericToJava(
            ja,
            SETTINGS_REC_BUILDER.createForStreams(
                defaultValue,
                FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
                (optionalUserParser == null) ? null : optionalUserParser::applyAsInt,
                BASIC_TYPES.PRIMITIVE_INTEGER(),
                STREAM_BUILDER.intStream()
            ));
    }

    /**
     * <EMBED CLASS=defs DATA-TYPE=Long DATA-TYPE_LC=long DATA-STRM_TYPE=LongStream>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_PRIM_STREAM_STRM>
     */
    @IntoHTMLTable(background=BlueDither, title="Generate a Java (Primitive) LongStream")
    @LinkJavaSource(handle="BASIC_TYPES", name="LONG")
    @LinkJavaSource(handle="STREAM_BUILDER", name="longStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static LongStream longArr(
            final JsonArray                 ja,
            final long                      defaultValue,
            final int                       FLAGS,
            final ToLongFunction<String>    optionalUserParser
        )
    {
        return ProcessJsonArray.numericToJava(
            ja,
            SETTINGS_REC_BUILDER.createForStreams(
                defaultValue,
                FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
                (optionalUserParser == null) ? null : optionalUserParser::applyAsLong,
                BASIC_TYPES.PRIMITIVE_LONG(),
                STREAM_BUILDER.longStream()
            ));
    }

    /**
     * <EMBED CLASS=defs DATA-TYPE=Double DATA-TYPE_LC=double DATA-STRM_TYPE=DoubleStream>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_PRIM_STREAM_STRM>
     */
    @IntoHTMLTable(background=GreenDither, title="Generate a Java (Primitive) DoubleStream")
    @LinkJavaSource(handle="BASIC_TYPES", name="DOUBLE")
    @LinkJavaSource(handle="STREAM_BUILDER", name="doubleStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static DoubleStream doubleArr(
            final JsonArray                 ja,
            final double                    defaultValue,
            final int                       FLAGS,
            final ToDoubleFunction<String>  optionalUserParser
        )
    {
        return ProcessJsonArray.numericToJava(
            ja,
            SETTINGS_REC_BUILDER.createForStreams(
                defaultValue,
                FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
                (optionalUserParser == null) ? null : optionalUserParser::applyAsDouble,
                BASIC_TYPES.PRIMITIVE_DOUBLE(),
                STREAM_BUILDER.doubleStream()
            ));
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // SettingsRec Generators
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * <EMBED CLASS=defs DATA-TYPE=Integer DATA-TYPE_LC=int DATA-STRM_TYPE=IntStream DATA-A_AN=An>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_PRIM_STREAM_REC>
     */
    @IntoHTMLTable(background=BlueDither,
        title="Generate a Java (Primitive) IntStream Configuration-Record")
    @LinkJavaSource(handle="BASIC_TYPES", name="INTEGER")
    @LinkJavaSource(handle="STREAM_BUILDER", name="intStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static SettingsRec<Integer, IntStream> intRec(
            final int                   defaultValue,
            final int                   FLAGS,
            final ToIntFunction<String> optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForStreams(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsInt,
            BASIC_TYPES.PRIMITIVE_INTEGER(),
            STREAM_BUILDER.intStream()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-TYPE=Long DATA-TYPE_LC=long DATA-STRM_TYPE=LongStream>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_PRIM_STREAM_REC>
     */
    @IntoHTMLTable(background=GreenDither,
        title="Generate a Java (Primitive) LongStream Configuration-Recod")
    @LinkJavaSource(handle="BASIC_TYPES", name="LONG")
    @LinkJavaSource(handle="STREAM_BUILDER", name="longStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static SettingsRec<Long, LongStream> longRec(
            final long                      defaultValue,
            final int                       FLAGS,
            final ToLongFunction<String>    optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForStreams(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsLong,
            BASIC_TYPES.PRIMITIVE_LONG(),
            STREAM_BUILDER.longStream()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-TYPE=Double DATA-TYPE_LC=double DATA-STRM_TYPE=DoubleStream>
     * <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_PRIM_STREAM_REC>
     */
    @IntoHTMLTable(background=BlueDither,
        title="Generate a Java (Primitive) DoubleStream Configuration-Record")
    @LinkJavaSource(handle="BASIC_TYPES", name="DOUBLE")
    @LinkJavaSource(handle="STREAM_BUILDER", name="doubleStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static SettingsRec<Double, DoubleStream> doubleRec(
            final double                    defaultValue,
            final int                       FLAGS,
            final ToDoubleFunction<String>  optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForStreams(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsDouble,
            BASIC_TYPES.PRIMITIVE_DOUBLE(),
            STREAM_BUILDER.doubleStream()
        );
    }    

}