package Torello.Java.JSON;


// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// These are the User-Provided Lambda's / Functional-Interfaces
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import java.util.function.IntConsumer;
import Torello.Java.Function.TriIntCons;
import java.util.function.ToIntFunction;

import Torello.Java.Function.ShortConsumer;
import Torello.Java.Function.IntIntShortCons;
import Torello.Java.Function.ToShortFunction;

import Torello.Java.Function.ByteConsumer;
import Torello.Java.Function.IntIntByteCons;
import Torello.Java.Function.ToByteFunction;

import java.util.function.LongConsumer;
import Torello.Java.Function.IntIntLongCons;
import java.util.function.ToLongFunction;

import Torello.Java.Function.FloatConsumer;
import Torello.Java.Function.IntIntFloatCons;
import Torello.Java.Function.ToFloatFunction;

import java.util.function.DoubleConsumer;
import Torello.Java.Function.IntIntDoubleCons;
import java.util.function.ToDoubleFunction;

import Torello.Java.Function.BoolConsumer;
import Torello.Java.Function.IntIntBoolCons;
import java.util.function.Predicate;


// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// The Rest of the imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import Torello.JavaDoc.StaticFunctional;
import Torello.JavaDoc.LinkJavaSource;
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.JSON.JFlag;

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

import java.util.Objects;

import static javax.json.JsonValue.TRUE;
import static javax.json.JsonValue.FALSE;

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


/**
 * Generate a Pre-Configured {@link SettingsRec} instance which can handle Java-Primitives.
 * 
 * <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_PRIM_CONS_REC>
 * <EMBED CLASS='external-html' DATA-FILE-ID=LOOP_OPTIMIZED_NOTE>
 * <EMBED CLASS='external-html' DATA-FILE-ID=RJ_PT_PRIM_CONS_REC>
 * 
 * @see Json
 * @see JsonArray
 */
@StaticFunctional
@JDHeaderBackgroundImg(EmbedTagFileID="RJA_JDHBI_PRIM_CONS_REC")
public class RJArrPrimConsumerRec
{
    private RJArrPrimConsumerRec() { }

    /**
     * <EMBED CLASS=defs DATA-A_AN=An DATA-METH_NAME=numeric DATA-PRIM_TYPE=int DATA-DEFVAL="-1">
     * <EMBED CLASS='external-html' DATA-TYPE=Integer DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC1>
     */
    @IntoHTMLTable(
        background=GreenDither, 
        title="Create a SettingsRec Instance for a Primitive-Integer Consumer"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="INTEGER")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForConsumers", paramCount=4)
    public static SettingsRec<Integer, Void> intArr(
            final int                   defaultValue,
            final int                   FLAGS,
            final ToIntFunction<String> optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForConsumers(
            defaultValue,
            FLAGS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsInt,
            BASIC_TYPES.PRIMITIVE_INTEGER()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=numeric DATA-PRIM_TYPE=short DATA-DEFVAL="-1">
     * <EMBED CLASS='external-html' DATA-TYPE=Short DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC1>
     */
    @IntoHTMLTable(
        background=BlueDither,
        title="Create a SettingsRec Instance for a Primitive Short-Integer Consumer"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="SHORT")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForConsumers", paramCount=4)
    public static SettingsRec<Short, Void> shortArr(
            final short                     defaultValue,
            final int                       FLAGS,
            final ToShortFunction<String>   optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsShort,
            BASIC_TYPES.PRIMITIVE_SHORT()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=numeric DATA-PRIM_TYPE=byte DATA-DEFVAL="-1">
     * <EMBED CLASS='external-html' DATA-TYPE=Byte DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC1>
     */
    @IntoHTMLTable(
        background=GreenDither,
        title="Create a SettingsRec Instance for a Primitive-Byte Consumer"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="BYTE")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForConsumers", paramCount=4)
    public static SettingsRec<Byte, Void> byteArr(
            final byte                      defaultValue,
            final int                       FLAGS,
            final ToByteFunction<String>    optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsByte,
            BASIC_TYPES.PRIMITIVE_BYTE()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=numeric DATA-PRIM_TYPE=long DATA-DEFVAL="-1">
     * <EMBED CLASS='external-html' DATA-TYPE=Long DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC1>
     */
    @IntoHTMLTable(
        background=BlueDither,
        title="Create a SettingsRec Instance for a Primitive Long-Integer Consumer"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="LONG")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForConsumers", paramCount=4)
    public static SettingsRec<Long, Void> longArr(
            final long                      defaultValue,
            final int                       FLAGS,
            final ToLongFunction<String>    optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsLong,
            BASIC_TYPES.PRIMITIVE_LONG()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=numeric DATA-PRIM_TYPE=double DATA-DEFVAL="-1.0">
     * <EMBED CLASS='external-html' DATA-TYPE=Double DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC1>
     */
    @IntoHTMLTable(
        background=GreenDither,
        title="Create a SettingsRec Instance for a Primitive-Double Consumer"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="DOUBLE")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForConsumers", paramCount=4)
    public static SettingsRec<Double, Void> doubleArr(
            final double                    defaultValue,
            final int                       FLAGS,
            final ToDoubleFunction<String>  optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsDouble,
            BASIC_TYPES.PRIMITIVE_DOUBLE()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=numeric DATA-PRIM_TYPE=float DATA-DEFVAL="-1.0f">
     * <EMBED CLASS='external-html' DATA-TYPE=Float DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC1>
     */
    @IntoHTMLTable(
        background=BlueDither, 
        title="Create a SettingsRec Instance for a Primitive-Float Consumer"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="FLOAT")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForConsumers", paramCount=4)
    public static SettingsRec<Float, Void> floatArr(
            final float                     defaultValue,
            final int                       FLAGS,
            final ToFloatFunction<String>   optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsFloat,
            BASIC_TYPES.PRIMITIVE_FLOAT()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=boolean DATA-PRIM_TYPE=boolean DATA-DEFVAL=false>
     * <EMBED CLASS='external-html' DATA-TYPE=Boolean DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC1>
     */
    @IntoHTMLTable(
        background=GreenDither,
        title="Create a SettingsRec Instance for a Primitive-Boolean Consumer"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="BOOLEAN")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForConsumers", paramCount=4)
    public static SettingsRec<Boolean, Void> booleanArr(
            final boolean           defaultValue,
            final int               FLAGS,
            final Predicate<String> optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::test,
            BASIC_TYPES.PRIMITIVE_BOOLEAN()
        );
    }




    // ********************************************************************************************
    // ********************************************************************************************
    // IntInt (w/ Array-Indices) Primitive-Consumer Variant
    // ********************************************************************************************
    // ********************************************************************************************




    /**
     * <EMBED CLASS=defs DATA-A_AN=An DATA-METH_NAME=numeric DATA-PRIM_TYPE=int DATA-DEFVAL="-1">
     * <EMBED CLASS='external-html' DATA-TYPE=Integer DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC2>
     */
    @IntoHTMLTable(
        background=BlueDither,
        title="Create a SettingsRec Instance for a Consumer of Primitive-Integers, " +
            "w/ Array-Indices"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="INTEGER")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForIIConsumers", paramCount=4)
    public static SettingsRec<Integer, Void> intArr2(
            final int                   defaultValue,
            final int                   FLAGS,
            final ToIntFunction<String> optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForIIConsumers(
            defaultValue,
            FLAGS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsInt,
            BASIC_TYPES.PRIMITIVE_INTEGER()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=numeric DATA-PRIM_TYPE=short DATA-DEFVAL="-1">
     * <EMBED CLASS='external-html' DATA-TYPE=Short DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC2>
     */
    @IntoHTMLTable(
        background=GreenDither,
        title="Create a SettingsRec Instance for a Consumer of Primitive Short-Integers, " +
            "w/ Array-Indices"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="SHORT")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForIIConsumers", paramCount=4)
    public static SettingsRec<Short, Void> shortArr2(
            final short                     defaultValue,
            final int                       FLAGS,
            final ToShortFunction<String>   optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForIIConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsShort,
            BASIC_TYPES.PRIMITIVE_SHORT()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=numeric DATA-PRIM_TYPE=byte DATA-DEFVAL="-1">
     * <EMBED CLASS='external-html' DATA-TYPE=Byte DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC2>
     */
    @IntoHTMLTable(
        background=BlueDither,
        title="Create a SettingsRec Instance for a Consumer of Primitive-Bytes, " +
            "w/ Array-Indices"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="BYTE")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForIIConsumers", paramCount=4)
    public static SettingsRec<Byte, Void> byteArr2(
            final byte                      defaultValue,
            final int                       FLAGS,
            final ToByteFunction<String>    optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForIIConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsByte,
            BASIC_TYPES.PRIMITIVE_BYTE()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=numeric DATA-PRIM_TYPE=long DATA-DEFVAL="-1">
     * <EMBED CLASS='external-html' DATA-TYPE=Long DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC2>
     */
    @IntoHTMLTable(
        background=GreenDither,
        title="Create a SettingsRec Instance for a Consumer of Primitive Long-Integers, " +
            "w/ Array-Indices"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="LONG")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForIIConsumers", paramCount=4)
    public static SettingsRec<Long, Void> longArr2(
            final long                      defaultValue,
            final int                       FLAGS,
            final ToLongFunction<String>    optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForIIConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsLong,
            BASIC_TYPES.PRIMITIVE_LONG()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=numeric DATA-PRIM_TYPE=double DATA-DEFVAL="-1.0">
     * <EMBED CLASS='external-html' DATA-TYPE=Double DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC2>
     */
    @IntoHTMLTable(
        background=BlueDither,
        title="Create a SettingsRec Instance for a Consumer of Primitive-Doubles, " +
            "w/ Array-Indices"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="DOUBLE")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForIIConsumers", paramCount=4)
    public static SettingsRec<Double, Void> doubleArr2(
            final double                    defaultValue,
            final int                       FLAGS,
            final ToDoubleFunction<String>  optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForIIConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsDouble,
            BASIC_TYPES.PRIMITIVE_DOUBLE()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=numeric DATA-PRIM_TYPE=float DATA-DEFVAL="-1.0f">
     * <EMBED CLASS='external-html' DATA-TYPE=Float DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC2>
     */
    @IntoHTMLTable(
        background=GreenDither,
        title="Create a SettingsRec Instance for a Consumer of Primitive-Floats, " +
            "w/ Array-Indices"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="FLOAT")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForIIConsumers", paramCount=4)
    public static SettingsRec<Float, Void> floatArr2(
            final float                     defaultValue,
            final int                       FLAGS,
            final ToFloatFunction<String>   optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForIIConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::applyAsFloat,
            BASIC_TYPES.PRIMITIVE_FLOAT()
        );
    }

    /**
     * <EMBED CLASS=defs DATA-METH_NAME=boolean DATA-PRIM_TYPE=boolean DATA-DEFVAL=false>
     * <EMBED CLASS='external-html' DATA-TYPE=Boolean DATA-FILE-ID=RJ_ARR_PRIM_CONS_REC2>
     */
    @IntoHTMLTable(
        background=BlueDither,
        title="Create a SettingsRec Instance for a Consumer of Primitive-Booleans, " +
            "w/ Array-Indices"
    )
    @LinkJavaSource(handle="BASIC_TYPES", name="BOOLEAN")
    @LinkJavaSource(handle="SETTINGS_REC_BUILDER", name="createForIIConsumers", paramCount=4)
    public static SettingsRec<Boolean, Void> booleanArr2(
            final boolean               defaultValue,
            final int                   FLAGS,
            final Predicate<String>     optionalUserParser
        )
    {
        return SETTINGS_REC_BUILDER.createForIIConsumers(
            defaultValue,
            FLAGS & NOT_ALLOWED_RET_NULL_MASKS,
            (optionalUserParser == null) ? null : optionalUserParser::test,
            BASIC_TYPES.PRIMITIVE_BOOLEAN()
        );
    }


}