Package Torello.JSON

Class RJArrConsumerRec

  • public class RJArrConsumerRec
extends java.lang.Object
    RJArrBoxedConsumerRec 🠞
    • RJArr - Read JsonArray
      This class is a helper class, used for reading data directly from an already parsed JsonArray instance.

    • Consumer - Data is sent to a Java Consumer, (or a Java-HTML IntIntTConsumer )

    • Rec - The methods in this class produce a pre-configured SettingsRec instance. Re-using a Configuration-Record can speed up processing when more than one JsonArray needs to be handled. This record should be used in conjunction with the class ProcessJsonArray to process multiple JsonArray's, efficiently.
    Utilities for parsing Json Array's and sending the parsed values into a Java Consumer Functional-Interface.

    This class builds on the J2EE Standard 'Glass-Fish' JSON Processor


    There are several JSON Parsers available, and even more implementations for serializing and de-serializing data to/from JSON. The Glass Fish Tool is included in the J2EE, and is available on GitHub. That is the one used by the Java HTML JAR Library (See: javax.json.* )

    Primary Classes Used: JsonArray and JsonObject

    This comment-note is intentionally repeated, verbatim, at the top of all Json Reader Classes in this package.


    JSON to Java Binding:
    JSON-Binding is the art of converting data that has been stored, saved or transmitted using Java-Script Object Notation into a Java Primitive or Object-Type. JSON can arrive into Java-Program Memory from almost any source. If you are wondering why such a massive amount of "work" is necessary just to convert a Json Integer into Java Integer, the value added is the extraordinary amount of attention paid to user configuration, error checking, & exception messaging. Methods here don't require more than 1 or 2 lines of code, and guarantee that a thorough type checking is performed.

    Unlike Java-Types which are checked by the Java-Compiler each-and-every time a programmer compiles his project, any guarantee that JSON-Type Data is pristine, uncorrupted, and in any kind of pre-agreed format may or may not be assured. The methods here are able to handle changes that might be made to an API (possibly from great distances away, and without the Software-Manager's consent). If an error could occur, configuration flags can be used to determine default error-recovery behaviors. If an exception does throw, the exception messages printed will contain multiple lines of detailed information.

    • Utilizes the Java-Standard javax.json.* Package-Library, & its Glass-Fish Implementation
    • Handles the Transfer & Conversion of All Json-Type's into Java-Type's with just One Line of Code
    • Provides all manner of User-Configurable Exception-Handling & Error-Decision Management via Class JFlag
    • Provides a Fine-Grained Suite of Exception-Classes, all with Consistent & Meaningful Error-Messages. Json Files can occasionally grow extremely large, and error messaging details make debugging easier
    • Primary Helper-Classes for the (Experimental) Google-Chrome Browser Automation Package

    The goal of Torello.JSON is to provide small, static helper methods in the same spirit as java.util.Objects and java.util.Arrays: simple calls that keep JSON handling out of your application logic. Instead of repeating loops, type checks, null checks, and exception wiring at every call site, these methods centralize that work behind a consistent set of straight-forward “read value” operations.


    Build a SettingsRec Instance for String, Object & Json-Types

    This class generates the Pre-Packaged, Pre-Configured SettingsRec instances that may be used to optimize loops. Use the records that are produced by the methods in this class in conjunction with the class ProcessJsonArray to (more efficiently) process Multiple JsonArray's with similar characteristics.
    Each of the methods in this class, all declared 'static', accept a standard JsonArray as input, and will attempt to convert each of the elements of that array into the following output types. The provided table below explains which types are expected to be provided to the methods in this class, and what types will be sent to the User-Provided Consumer's after parsing and extracting the array elements.
    Array Element Type Returned / Emitted Type
    JsonObject Instance of User-Specified, Parameterized-Type <T>
    JsonString Instance of java.lang.String
    JsonObject -- same / no change --
    JsonArray -- same / no change --

    Each of the emitted types for these methods may be sent to one of two "kinds" of Java Consumer's. The JDK Standard Consumer, whose full package name is java.util.function.Consumer accepts the post-processed output from the arrays that are passed to these methodss. This consumer impements a Function-Interface with one method that accepts the type in the method signature.

    The second "kind" of Consumer which is available is provided by the Java-HTML '.jar' Library. It is known, simply, as an: IntIntTConsumer. Both of these User-Provided Consumers will accept post-processed array-entries, one by one, until the end of the array has been reached.
    Consumer Kind / Type Explanation of Use
    java.util.function.Consumer As elements are retrieved, extracted and processed from the User-Provided JsonArray, the are sent to the single-input parameter Lambda-Method that user has provided.
    IntIntTConsumer As elements are retrieved, they are passed to this Java-HTML Consumer, along with two primitive integers.

    The first 'int' is the array index of the JsonArray in which the item was located.

    The second 'int' is the "success count" for how many elements have been extracted from the array. Often these integers are identical, but in cases where the user has requested to skip on failure, the integers may differ.



    POJO De-Serialization:
    The methods that appear to de-serialize a JSON-Object into a standard Java-Object do not automatically generate a Java-Type based solely on the properties present within a JsonObject. Automatic type-creation (as exists in libraries such as 'Lombok') is not a feature offered by this package. These methods can reduce quite a bit of the work needed to convert Json into Java by offering methods which extact JsonValue's using just a single line of code.

    The methods in this class which return or emit a user-provided Parameterized-Type <T> require the user specify a means for constructing instances of 'T'. This class expects one of the two cases:

    • User-Provided Type <T> has a single argument constructor which accepts a JsonObject as a parameter. In this case, standard Java Reflection is used to retrieve and extract this constructor.

    • A Java Functional-Interface / Lambda be provided that accepts a JsonObject and returns an instance of User-Provided Type <T>. Building or generating an instance of <T> is acheived, simply, by invoking this function with the JsonObject which was extracted from the array.


    Optimize Loops:
    Methods in this class whose name ends with the letters 'Rec' are methods that produce what is known as a 'Settings Record', (see class SettingsRec<T, U>). Every one of the Json-Processing classes (in this Json Java-Package) that begin with the letters 'RJArr' are classes which iterate JsonArray's.

    In order to guarantee that there is a homogenous algorithm for processing these array indices, only a few Java 'for-loops' have actually been written. (These loops may be easily inspected by clicking on the 'Hi-Lited Source-Code' button inside of class ProcessJsonArray). In this class, in order to differentiate between a JsonArray which is to be converted into a Java int[]-Array, and one which is to be placed into a Java long[]-Array, a particular "Settings Record" is constructed (which "configures" the loop's body).

    If only one invocation of a method is needed, then using the method that ends with 'Arr' should be perfectly sufficient! If the methods in this class are going to be invoked from inside of a loop (or invoked many times), then it would be much wiser to, first, obtain an instance of the SettingsRec, and then invoke the Array-Processing code yourself. In this way, generating multiple short-lived, ephemeral, object instances (which are immediately discarded and collected by the Garbage-Collector) can be avoided.

    To do this is quite simple. Please review the documentation for any and all methods in this JSON Package whose name ends with 'Rec' - and look at the example code provided for how to use them. Most of those methods do include an example. Using a Loop Optimized method is a very simple, two step procedure as explained here:

    1. First, generate an instance of the SettingsRec class. Make sure to heed to Generic-Type Parameters returned by the Settings-Record Generator-Method you have called.
    2. Second, simply call the specified Json-Array Processing method from class ProcessJsonArray


    Method Parameters

    Parameter Explanation
    <T> defaultValue The only requirement is this value must be either an instance of 'T', or an instance of a child / inheriting type of 'T'.

    'null' may also be provided as a default value.
    String defaultValue Any Java String, or null, will suffice
    JsonObject defautValue
    JsonArray defautValue     		For either of these, any instance may be provided. Null is also allowed. Frequently it might be convenient to use the singleton, empty, instances provided by the Glass-Fish Implementation:

    JsonValue.EMPTY_JSON_OBJECT
    JsonValue.EMPTY_JSON_ARRAY
    int FLAGS A Bit-Wise Flag-Mask that provides a means for configuring the Array-Processing Logic to properly handle several types of Error-Cases & potentatial, unexpected, array contents.

    A Flag-Mask of '0' requests that any Error-Situations which occur, should they crop up while processing the array, be handled by standard means - meaning by throwing one of the germaine Exception-Classes.
    Class<T> consumerClass This may be any Java Class. It is required due to the limitations presented by Generic Erasure; this information is simply not available without providing a reference to this Class Object.
    java.util.function.Function
    <JsonObject, T> objBuilder         		When this parameter is present, it will be used to generate an instance of User-Specified Type 'T' by passing the JsonObject's encountered within the input array, to this user provided function.

    Lambda Signature:
    public <T> T apply(JsonObject jo)
    IntIntTFunc​ <JsonObject, T> objBuilder Similar to the above parameter, this object builder produces instances of User-Specified, Parameterized-Type 'T', but uses a @FunctionalInterface which accepts three parameters, intead of just the single JsonObject

    Lambda Signature:
    public <T> T apply(int jaIndex, int acceptorCount, JsonObject jo)

    The two "extra parameters" show above, are both primitive integers. The first one simply provides the JsonArray index where the object was found. The second 'int' contains the current iteration's "success count." These two numbers are usually identical; only cases where the user has specified a JFlag that requests the processor "Skip Entries on Failure" can These two integers take different values.
    See Also:
    Json, JsonArray



    Stateless Class:
    This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.

    • 1 Constructor(s), 1 declared private, zero-argument constructor
    • 12 Method(s), 12 declared static
    • 0 Field(s)


    • Method Summary

       
      Generate a SettingsRec<T, Void> Instance; Record asks Array Contents go to a User-Provided Consumer<T>
      Modifier and Type Method
      static <T> SettingsRec<T,​Void> objRec​(T defaultValue, int FLAGS, Class<T> consumerClass)
      static <T> SettingsRec<T,​Void> objRec​(T defaultValue, int FLAGS, Function<JsonObject,​T> objBuilder, Class<T> consumerClass)
      static <T> SettingsRec<T,​Void> objRec​(T defaultValue, int FLAGS, IntIntTFunc<JsonObject,​T> objBuilder, Class<T> consumerClass)
       
      Generate a SettingsRec<T, Void> Instance; Record asks Array Contents go to a User-Provided IntIntTConsumer<T> (with Indices & Count)
      Modifier and Type Method
      static <T> SettingsRec<T,​Void> objRec2​(T defaultValue, int FLAGS, Class<T> consumerClass)
      static <T> SettingsRec<T,​Void> objRec2​(T defaultValue, int FLAGS, Function<JsonObject,​T> objBuilder, Class<T> consumerClass)
      static <T> SettingsRec<T,​Void> objRec2​(T defaultValue, int FLAGS, IntIntTFunc<JsonObject,​T> objBuilder, Class<T> consumerClass)
       
      Generate a SettingsRec<String, Void> Instance; Record asks Array Contents go to a User-Provided, String-Based Consumer
      Modifier and Type Method
      static SettingsRec<String,​Void> strRec​(String defaultValue, int FLAGS)
      static SettingsRec<String,​Void> strRec2​(String defaultValue, int FLAGS)
       
      Generate a SettingsRec<JsonObject, Void> Instance; Record asks Array Contents go to a User-Provided JsonObject -Based Consumer
      Modifier and Type Method
      static SettingsRec<JsonObject,
           ​Void>      		 joRec​(JsonObject defaultValue, int FLAGS)
      static SettingsRec<JsonObject,
           ​Void>      		 joRec2​(JsonObject defaultValue, int FLAGS)
       
      Generate a SettingsRec<JsonArray, Void> Instance; Record asks Array Contents go to a User-Provided JsonArray -Based Consumer
      Modifier and Type Method
      static SettingsRec<JsonArray,​Void> jaRec​(JsonArray defaultValue, int FLAGS)
      static SettingsRec<JsonArray,​Void> jaRec2​(JsonArray defaultValue, int FLAGS)

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • objRec

        🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static <T> SettingsRec<T,​java.lang.Void> objRec​
            (T defaultValue,
             int FLAGS,
             java.lang.Class<T> consumerClass)
        Build a SettingsRec<T, Void> instance; Record asks instances of Parameterized-Type <T> be sent to a Consumer<T>
        Generates: A pre-configured instance of SettingsRec<T, Void> to the ProcessJsonArray invocation.
        Expects: Parameterized Type <T> to be a Java Class / Type that has a single-argument constructor which accepts a JsonObject as a parameter.
        Configuration For: Sending generated Object's to a Java Consumer<T>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<T, Void>
     (defaultValue, FLAGS, null, EXTENDED_TYPES.FROM_CTOR(consumerClass))
     .updateableConsumer(true);

      • objRec

        🡅  🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static <T> SettingsRec<T,​java.lang.Void> objRec​
            (T defaultValue,
             int FLAGS,
             java.util.function.Function<JsonObject,​T> objBuilder,
             java.lang.Class<T> consumerClass)
        Build a SettingsRec<T, Void> instance; Record asks instances of Parameterized-Type <T> be sent to a Consumer<T>
        Generates: A pre-configured instance of SettingsRec<T, Void> to the ProcessJsonArray invocation.
        Expects: A Java Function<JsonObject, T> that will generate an instance of the expected output / emitted type <T>
        Type Note: Parameterized Type <T> may be any Java Object Class, not just a type which has a JsonObject Constructor.
        Configuration For: Sending generated Object's to a Java Consumer<T>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<T, Void>
     (defaultValue, FLAGS, null, EXTENDED_TYPES.ONE_ARG_FUNC(objBuilder, consumerClass))
     .updateableConsumer(true);

      • objRec

        🡅  🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static <T> SettingsRec<T,​java.lang.Void> objRec​
            (T defaultValue,
             int FLAGS,
             IntIntTFunc<JsonObject,​T> objBuilder,
             java.lang.Class<T> consumerClass)
        Build a SettingsRec<T, Void> instance; Record asks instances of Parameterized-Type <T> be sent to a Consumer<T>
        Generates: A pre-configured instance of SettingsRec<T, Void> to the ProcessJsonArray invocation.
        Expects: An IntIntTFunc<JsonObject, T> that will generate an instance of the expected output / emitted type <T>
        Type Note: Parameterized Type <T> may be any Java Object Class, not just a type which has a JsonObject Constructor.
        Configuration For: Sending generated Object's to a Java Consumer<T>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<T, Void>
     (defaultValue, FLAGS, null, EXTENDED_TYPES.THREE_ARG_FUNC(objBuilder, consumerClass))
     .updateableConsumer(true);

      • objRec2

        🡅  🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static <T> SettingsRec<T,​java.lang.Void> objRec2​
            (T defaultValue,
             int FLAGS,
             java.lang.Class<T> consumerClass)
        Build a SettingsRec<T, Void> instance; Record asks instances of Parameterized-Type <T> be sent to an IntIntTConsumer<T>
        Generates: A pre-configured instance of SettingsRec<T, Void> to the ProcessJsonArray invocation.
        Expects: Parameterized Type <T> to be a Java Class / Type that has a single-argument constructor which accepts a JsonObject as a parameter.
        Configuration For: Sending generated Object's to a Java-HTML IntIntTConsumer<T>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<T, Void>
     (defaultValue, FLAGS, null, EXTENDED_TYPES.FROM_CTOR(consumerClass))
     .updateableConsumer(false);

      • objRec2

        🡅  🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static <T> SettingsRec<T,​java.lang.Void> objRec2​
            (T defaultValue,
             int FLAGS,
             java.util.function.Function<JsonObject,​T> objBuilder,
             java.lang.Class<T> consumerClass)
        Build a SettingsRec<T, Void> instance; Record asks instances of Parameterized-Type <T> be sent to an IntIntTConsumer<T>
        Generates: A pre-configured instance of SettingsRec<T, Void> to the ProcessJsonArray invocation.
        Expects: A Java Function<JsonObject, T> that will generate an instance of the expected output / emitted type <T>
        Type Note: Parameterized Type <T> may be any Java Object Class, not just a type which has a JsonObject Constructor.
        Configuration For: Sending Generated Object's to a Java-HTML IntIntTConsumer<T>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<T, Void>
     (defaultValue, FLAGS, null, EXTENDED_TYPES.ONE_ARG_FUNC(objBuilder, consumerClass))
     .updateableConsumer(false);

      • objRec2

        🡅  🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static <T> SettingsRec<T,​java.lang.Void> objRec2​
            (T defaultValue,
             int FLAGS,
             IntIntTFunc<JsonObject,​T> objBuilder,
             java.lang.Class<T> consumerClass)
        Build a SettingsRec<T, Void> instance; Record asks instances of Parameterized-Type <T> be sent to an IntIntTConsumer<T>
        Generates: A pre-configured instance of SettingsRec<T, Void> to the ProcessJsonArray invocation.
        Expects: An IntIntTFunc<JsonObject, T> that will generate an instance of the expected output / emitted type <T>
        Type Note: Parameterized Type <T> may be any Java Object Class, not just a type which has a JsonObject Constructor.
        Configuration For: Sending generated Object's to a Java-HTML IntIntTConsumer<T>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<T, Void>
     (defaultValue, FLAGS, null, EXTENDED_TYPES.THREE_ARG_FUNC(objBuilder, consumerClass))
     .updateableConsumer(false);

      • strRec

        🡅  🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static SettingsRec<java.lang.String,​java.lang.Void> strRec​
            (java.lang.String defaultValue,
             int FLAGS)
        Build a SettingsRec<String, Void> instance; Record asks String's be sent to a Consumer<String>
        Generates: A pre-configured instance of SettingsRec<String, Void> to the ProcessJsonArray invocation.
        Configuration For: Sending retrieved / extracted String's to a Java Consumer<String>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<String, Void>
     (defaultValue, FLAGS, null, BASIC_TYPES.STRING_REC())
     .updateableConsumer(true);

      • strRec2

        🡅  🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static SettingsRec<java.lang.String,​java.lang.Void> strRec2​
            (java.lang.String defaultValue,
             int FLAGS)
        Build a SettingsRec<String, Void> instance; Record asks String's be sent to an IntIntTConsumer<String>
        Generates: A pre-configured instance of SettingsRec<String, Void> to the ProcessJsonArray invocation.
        Configuration For: Sending retrieved / extracted String's to a Java-HTML IntIntTConsumer<String>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<String, Void>
     (defaultValue, FLAGS, null, BASIC_TYPES.STRING_REC())
     .updateableConsumer(false);

      • joRec

        🡅  🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static SettingsRec<JsonObject,​java.lang.Void> joRec​
            (JsonObject defaultValue,
             int FLAGS)
        Build a SettingsRec<JsonObject, Void> instance; Record asks JsonObject's be sent to a Consumer<JsonObject>
        Generates: A pre-configured instance of SettingsRec<JsonObject, Void> to the ProcessJsonArray invocation.
        Configuration For: Sending retrieved / extracted JsonObject's to a Java Consumer<JsonObject>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<JsonObject, Void>
     (defaultValue, FLAGS, null, BASIC_TYPES.JSON_OBJECT_REC())
     .updateableConsumer(true);

      • joRec2

        🡅  🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static SettingsRec<JsonObject,​java.lang.Void> joRec2​
            (JsonObject defaultValue,
             int FLAGS)
        Build a SettingsRec<JsonObject, Void> instance; Record asks JsonObject's be sent to an IntIntTConsumer<JsonObject>
        Generates: A pre-configured instance of SettingsRec<JsonObject, Void> to the ProcessJsonObject invocation.
        Configuration For: Sending retrieved / extracted JsonObject's to a Java-HTML IntIntTConsumer<JsonObject>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<JsonObject, Void>
     (defaultValue, FLAGS, null, BASIC_TYPES.JSON_OBJECT_REC())
     .updateableConsumer(false);

      • jaRec

        🡅  🡇  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static SettingsRec<JsonArray,​java.lang.Void> jaRec​
            (JsonArray defaultValue,
             int FLAGS)
        Build a SettingsRec<JsonArray, Void> instance; Record asks JsonArray's be sent to a Consumer<JsonArray>
        Generates: A pre-configured instance of SettingsRec<JsonArray, Void> to the ProcessJsonArray invocation.
        Configuration For: Sending retrieved / extracted JsonArray's to a Java Consumer<JsonArray>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<JsonArray, Void>
     (defaultValue, FLAGS, null, BASIC_TYPES.JSON_ARRAY_REC())
     .updateableConsumer(true);

      • jaRec2

        🡅  ⇈  ⮫     External-Java:   ⮫  ⮫ 🗕  🗗  🗖 
        public static SettingsRec<JsonArray,​java.lang.Void> jaRec2​
            (JsonArray defaultValue,
             int FLAGS)
        Build a SettingsRec<JsonArray, Void> instance; Record asks JsonArray's be sent to an IntIntTConsumer<JsonArray>
        Generates: A pre-configured instance of SettingsRec<JsonArray, Void> to the ProcessJsonArray invocation.
        Configuration For: Sending retrieved / extracted JsonArray's to a Java-HTML IntIntTConsumer<JsonArray>
        Code:
        Exact Method Body:
         return new SETTINGS_REC_BUILDER<JsonArray, Void>
     (defaultValue, FLAGS, null, BASIC_TYPES.JSON_ARRAY_REC())
     .updateableConsumer(false);