package Torello.Java.JSON;

import Torello.JavaDoc.LinkJavaSource;
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 Torello.Java.Function.IntIntTFunc;

import java.util.stream.Stream;
import java.util.function.Function;

import javax.json.Json;
import javax.json.JsonArray;
import javax.json.JsonString;
import javax.json.JsonObject;

/**
 * Utilities for parsing Json Array's and sending the parsed values into a Java Stream.
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=GLASS_FISH_NOTE>
 * <EMBED CLASS='external-html' DATA-FILE-ID=RJA_INTO_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_STRM")
public class RJArrIntoStream
{
    private RJArrIntoStream() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Read Objects Into a Stream
    // ********************************************************************************************
    // ********************************************************************************************


    /** <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_STREAM_OBJ1_STRM> */
    @IntoHTMLTable(background=GreenDither, title="Generate a Java Stream of Object &lt;T&gt;")
    @LinkJavaSource(handle="BASIC_TYPES", name="OBJECT", paramCount=1)
    @LinkJavaSource(handle="STREAM_BUILDER", name="normalStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static <T> Stream<T> objArr(
            final JsonArray ja,
            final T         defaultValue,
            final int       FLAGS,
            final Class<T>  returnClass
        )
    {
        return ProcessJsonArray.objToJava(
            ja,
            SETTINGS_REC_BUILDER.createForStreams(
                defaultValue,
                FLAGS,
                null,
                BASIC_TYPES.OBJECT(returnClass),
                STREAM_BUILDER.normalStream()
            ));
    }

    /** <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_STREAM_OBJ2_STRM> */
    @IntoHTMLTable(background=BlueDither,
        title="Generate a Java Stream of Object &lt;T&gt;, Use User-Provided Static-Builder")
    @LinkJavaSource(handle="BASIC_TYPES", name="OBJECT", paramCount=2)
    @LinkJavaSource(handle="STREAM_BUILDER", name="normalStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static <T> Stream<T> objArr(
            final JsonArray                 ja,
            final T                         defaultValue,
            final int                       FLAGS,
            final Function<JsonObject, T>   objBuilder,
            final Class<T>                  returnClass
        )
    {
        return ProcessJsonArray.objToJava(
            ja,
            SETTINGS_REC_BUILDER.createForStreams(
                defaultValue,
                FLAGS,
                null,
                BASIC_TYPES.OBJECT(objBuilder, returnClass),
                STREAM_BUILDER.normalStream()
            ));
    }

    /** <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_STREAM_OBJ3_STRM> */
    @IntoHTMLTable(background=GreenDither,
        title="Generate a Java Stream of Object &lt;T&gt;, Use User-Provided Static-Builder")
    @LinkJavaSource(handle="BASIC_TYPES", name="OBJECT2", paramCount=2)
    @LinkJavaSource(handle="STREAM_BUILDER", name="normalStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static <T> Stream<T> objArr(
            final JsonArray                     ja,
            final T                             defaultValue,
            final int                           FLAGS,
            final IntIntTFunc<JsonObject, T>    objBuilder,
            final Class<T>                      returnClass
        )
    {
        return ProcessJsonArray.objToJava(
            ja,
            SETTINGS_REC_BUILDER.createForStreams(
                defaultValue,
                FLAGS,
                null,
                BASIC_TYPES.OBJECT2(objBuilder, returnClass),
                STREAM_BUILDER.normalStream()
            ));
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Read Strings Into a Stream
    // ********************************************************************************************
    // ********************************************************************************************


    /** <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_STREAM_STR_STRM> */
    @IntoHTMLTable(background=BlueDither, title="Generate a Java Stream of String's")
    @LinkJavaSource(handle="BASIC_TYPES", name="STRING_REC")
    @LinkJavaSource(handle="STREAM_BUILDER", name="normalStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static Stream<String> strArr(
            final JsonArray ja,
            final String    defaultValue,
            final int       FLAGS
        )
    {
        return ProcessJsonArray.strToJava(
            ja,
            SETTINGS_REC_BUILDER.createForStreams(
                defaultValue,
                FLAGS,
                null, // optionalUserParser
                BASIC_TYPES.STRING_REC(),
                STREAM_BUILDER.normalStream()
            ));
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Generate a SettingsRec instance for reading JsonObjects
    // ********************************************************************************************
    // ********************************************************************************************


    /** <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_STREAM_OBJ1_REC> */
    @IntoHTMLTable(background=GreenDither,
        title="Generate a Java Settings-Record for producing Stream&lt;T&gt;")
    @LinkJavaSource(handle="BASIC_TYPES", name="OBJECT", paramCount=1)
    @LinkJavaSource(handle="STREAM_BUILDER", name="normalStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static <T> SettingsRec<T, Stream<T>> objRec(
            final T         defaultValue,
            final int       FLAGS,
            final Class<T>  returnClass
        )
    {
        return SETTINGS_REC_BUILDER.createForStreams(
            defaultValue,
            FLAGS,
            null,
            BASIC_TYPES.OBJECT(returnClass),
            STREAM_BUILDER.normalStream()
        );
    }

    /** <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_STREAM_OBJ2_REC> */
    @IntoHTMLTable(background=BlueDither,
        title="Generate a Java Settings-Record for producing Stream&lt;T&gt;")
    @LinkJavaSource(handle="BASIC_TYPES", name="OBJECT", paramCount=2)
    @LinkJavaSource(handle="STREAM_BUILDER", name="normalStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static <T> SettingsRec<T, Stream<T>> objRec(
            final T                         defaultValue,
            final int                       FLAGS,
            final Function<JsonObject, T>   objBuilder,
            final Class<T>                  returnClass
        )
    {
        return SETTINGS_REC_BUILDER.createForStreams(
            defaultValue,
            FLAGS,
            null,
            BASIC_TYPES.OBJECT(objBuilder, returnClass),
            STREAM_BUILDER.normalStream()
        );
    }

    /** <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_STREAM_OBJ3_REC> */
    @IntoHTMLTable(background=GreenDither,
        title="Generate a Java Settings-Record for producing Stream&lt;T&gt;")
    @LinkJavaSource(handle="BASIC_TYPES", name="OBJECT2", paramCount=2)
    @LinkJavaSource(handle="STREAM_BUILDER", name="normalStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static <T> SettingsRec<T, Stream<T>> objRec(
            final T                             defaultValue,
            final int                           FLAGS,
            final IntIntTFunc<JsonObject, T>    objBuilder,
            final Class<T>                      returnClass
        )
    {
        return SETTINGS_REC_BUILDER.createForStreams(
            defaultValue,
            FLAGS,
            null,
            BASIC_TYPES.OBJECT2(objBuilder, returnClass),
            STREAM_BUILDER.normalStream()
        );
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Generate a SettingsRec instance for reading Strings
    // ********************************************************************************************
    // ********************************************************************************************


    /**  <EMBED CLASS='external-html' DATA-FILE-ID=RJ_ARR_STREAM_STR_REC> */
    @IntoHTMLTable(background=BlueDither,
        title="Generate a Java Settings-Record for producing Stream&lt;String&gt;")
    @LinkJavaSource(handle="BASIC_TYPES", name="STRING_REC")
    @LinkJavaSource(handle="STREAM_BUILDER", name="normalStream")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForStreams")
    public static SettingsRec<String, Stream<String>> strRec(
            final String    defaultValue,
            final int       FLAGS
        )
    {
        return SETTINGS_REC_BUILDER.createForStreams(
            defaultValue,
            FLAGS,
            null, // optionalUserParser
            BASIC_TYPES.STRING_REC(),
            STREAM_BUILDER.normalStream()
        );
    }
}