Package jsonvalues

Class JsArray

    • Constructor Detail

      • JsArray

        public JsArray()
    • Method Detail

      • empty

        public static JsArray empty()
      • of

        public static JsArray of​(JsPair pair,
                                 JsPair... others)
        Returns an immutable array from one or more pairs.
        Parameters:
        pair - a pair
        others - more optional pairs
        Returns:
        an immutable JsArray
        Throws:
        UserError - if an elem of a pair is mutable
      • of

        public static JsArray of​(JsValue e,
                                 JsValue e1,
                                 JsValue e2,
                                 JsValue e3,
                                 JsValue e4,
                                 JsValue... rest)
        Returns an immutable array.
        Parameters:
        e - a JsElem
        e1 - a JsElem
        e2 - a JsElem
        e3 - a JsElem
        e4 - a JsElem
        rest - more optional JsElem
        Returns:
        an immutable JsArray
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsArray of​(JsValue e,
                                 JsValue e1,
                                 JsValue e2,
                                 JsValue e3,
                                 JsValue e4)
        Returns an immutable five-element array.
        Parameters:
        e - a JsElem
        e1 - a JsElem
        e2 - a JsElem
        e3 - a JsElem
        e4 - a JsElem
        Returns:
        an immutable five-element JsArray
        Throws:
        UserError - if an elem is a mutable Json
      • append

        public final JsArray append​(JsValue e,
                                    JsValue... others)
        Adds one or more elements, starting from the first, to the back of this array.
        Parameters:
        e - the JsElem to be added to the back.
        others - more optional JsElem to be added to the back
        Returns:
        a new JsArray
      • of

        public static JsArray of​(JsValue e,
                                 JsValue e1,
                                 JsValue e2,
                                 JsValue e3)
        Returns an immutable four-element array.
        Parameters:
        e - a JsElem
        e1 - a JsElem
        e2 - a JsElem
        e3 - a JsElem
        Returns:
        an immutable four-element JsArray
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsArray of​(JsValue e,
                                 JsValue e1,
                                 JsValue e2)
        Returns an immutable three-element array.
        Parameters:
        e - a JsElem
        e1 - a JsElem
        e2 - a JsElem
        Returns:
        an immutable three-element JsArray
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsArray of​(JsValue e,
                                 JsValue e1)
        Returns an immutable two-element array.
        Parameters:
        e - a JsElem
        e1 - a JsElem
        Returns:
        an immutable two-element JsArray
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsArray of​(String str,
                                 String... others)
        Returns an immutable array from one or more strings.
        Parameters:
        str - a string
        others - more optional strings
        Returns:
        an immutable JsArray
      • of

        public static JsArray of​(int number,
                                 int... others)
        Returns an immutable array from one or more integers.
        Parameters:
        number - an integer
        others - more optional integers
        Returns:
        an immutable JsArray
      • of

        public static JsArray of​(boolean bool,
                                 boolean... others)
        Returns an immutable array from one or more booleans.
        Parameters:
        bool - an boolean
        others - more optional booleans
        Returns:
        an immutable JsArray
      • of

        public static JsArray of​(long number,
                                 long... others)
        Returns an immutable array from one or more longs.
        Parameters:
        number - a long
        others - more optional longs
        Returns:
        an immutable JsArray
      • of

        public static JsArray of​(BigInteger number,
                                 BigInteger... others)
        Returns an immutable array from one or more big integers.
        Parameters:
        number - a big integer
        others - more optional big integers
        Returns:
        an immutable JsArray
      • of

        public static JsArray of​(double number,
                                 double... others)
        Returns an immutable array from one or more doubles.
        Parameters:
        number - a double
        others - more optional doubles
        Returns:
        an immutable JsArray
      • ofIterable

        public static JsArray ofIterable​(Iterable<? extends JsValue> iterable)
        returns an immutable json array from an iterable of json elements
        Parameters:
        iterable - the iterable of json elements
        Returns:
        an immutable json array
      • parse

        public static JsArray parse​(String str)
                             throws MalformedJson
        Tries to parse the string into an immutable json array.
        Parameters:
        str - the string to be parsed
        Returns:
        a JsArray
        Throws:
        MalformedJson - if the string doesnt represent a json array
      • appendAll

        public final JsArray appendAll​(JsArray array)
        Adds all the elements of the given array, starting from the head, to the back of this array.
        Parameters:
        array - the JsArray of elements to be added to the back
        Returns:
        a new JsArray
      • equals

        public boolean equals​(JsArray array,
                              JsArray.TYPE ARRAY_AS)
        Returns true if this array is equal to the given as a parameter. In the case of ARRAY_AS=LIST, this method is equivalent to JsArray.equals(Object).
        Parameters:
        array - the given array
        ARRAY_AS - option to define if arrays are considered SETS, LISTS OR MULTISET
        Returns:
        true if both arrays are equals according to ARRAY_AS parameter
      • containsValue

        public final boolean containsValue​(JsValue el)
        Description copied from interface: Json
        Returns true if this json contains the given element in the first level.
        Specified by:
        containsValue in interface Json<JsArray>
        Parameters:
        el - the give element JsElem whose presence in this JsArray is to be tested
        Returns:
        true if this JsArray contains the JsElem
      • get

        public JsValue get​(JsPath path)
        Description copied from interface: Json
        Returns the element located at the given path or JsNothing if it doesn't exist.
        Specified by:
        get in interface Json<JsArray>
        Parameters:
        path - the JsPath object of the element that will be returned
        Returns:
        the JsElem located at the given JsPath or JsNothing if it doesn't exist
      • filterAllValues

        public final JsArray filterAllValues​(Predicate<? super JsPair> filter)
        Description copied from interface: Json
        Filters all the pairs of elements of this json, removing those that don't ifPredicateElse the predicate.
        Specified by:
        filterAllValues in interface Json<JsArray>
        Parameters:
        filter - the predicate which takes as the input every JsPair of this json
        Returns:
        same this instance if all the pairs satisfy the predicate or a new filtered json of the same type T
        See Also:
        how to filter the pairs of values of only the first level
      • filterAllKeys

        public final JsArray filterAllKeys​(Predicate<? super JsPair> filter)
        Description copied from interface: Json
        Filters all the keys of this json, removing those that don't ifPredicateElse the predicate.
        Specified by:
        filterAllKeys in interface Json<JsArray>
        Parameters:
        filter - the predicate which takes as the input every JsPair of this json
        Returns:
        same this instance if all the keys satisfy the predicate or a new filtered json of the same type T
        See Also:
        how to filter the keys of only the first level
      • filterAllObjs

        public final JsArray filterAllObjs​(BiPredicate<? super JsPath,​? super JsObj> filter)
        Description copied from interface: Json
        Filters all the pair of jsons of this json, removing those that don't ifPredicateElse the predicate.
        Specified by:
        filterAllObjs in interface Json<JsArray>
        Parameters:
        filter - the predicate which takes as the input every JsPair of this json
        Returns:
        same this instance if all the pairs satisfy the predicate or a new filtered json of the same type T
        See Also:
        how to filter the pair of jsons of only the first level
      • isEmpty

        public final boolean isEmpty()
        Description copied from interface: Json
        return true if there's no element in this json
        Specified by:
        isEmpty in interface Json<JsArray>
        Returns:
        true if empty, false otherwise
      • set

        public final JsArray set​(JsPath path,
                                 JsValue value)
        Description copied from interface: Json
        Inserts the element at the path in this json, replacing any existing element and filling with JsNull empty indexes in arrays when necessary.

        The same instance is returned when the head of the path is a key and this is an array or the head of the path is an index and this is an object or the element is JsNothing

        Specified by:
        set in interface Json<JsArray>
        Parameters:
        path - the JsPath object where the element will be inserted at
        value - the JsElem that will be inserted
        Returns:
        the same instance or a new json of the same type T
      • reduce

        public final <R> Optional<R> reduce​(BinaryOperator<R> op,
                                            Function<? super JsPair,​R> map,
                                            Predicate<? super JsPair> predicate)
        Description copied from interface: Json
        Performs a reduction on the values that satisfy the predicate in the first level of this json. The reduction is performed mapping each value with the mapping function and then applying the operator
        Specified by:
        reduce in interface Json<JsArray>
        Type Parameters:
        R - the type of the operands of the operator
        Parameters:
        op - the operator upon two objects of type R
        map - the mapping function which produces an object of type R from a JsValue
        predicate - the predicate that determines what JsValue will be mapped and reduced
        Returns:
        an Optional describing the of of the reduction
        See Also:
        to apply the reduction in all the Json and not only in the first level
      • reduceAll

        public final <R> Optional<R> reduceAll​(BinaryOperator<R> op,
                                               Function<? super JsPair,​R> map,
                                               Predicate<? super JsPair> predicate)
        Description copied from interface: Json
        Performs a reduction on the values of this json that satisfy the predicate. The reduction is performed mapping each value with the mapping function and then applying the operator
        Specified by:
        reduceAll in interface Json<JsArray>
        Type Parameters:
        R - the type of the operands of the operator
        Parameters:
        op - the operator upon two objects of type R
        map - the mapping function which produces an object of type R from a JsValue
        predicate - the predicate that determines what JsValue will be mapped and reduced
        Returns:
        an Optional describing the result of the reduction
        See Also:
        to apply the reduction only in the first level
      • delete

        public final JsArray delete​(JsPath path)
        Description copied from interface: Json
        Removes the element in this json located at the given path, if it exists, returning the same this instance otherwise
        Specified by:
        delete in interface Json<JsArray>
        Parameters:
        path - the given JsPath object
        Returns:
        a json of the same type T
      • size

        public final int size()
        Description copied from interface: Json
        Returns the number of elements in the first level of this json
        Specified by:
        size in interface Json<JsArray>
        Returns:
        the number of elements in the first level of this json
      • streamAll

        public Stream<JsPair> streamAll()
        Description copied from interface: Json
        Returns a stream over all the pairs of elements in this json object.
        Specified by:
        streamAll in interface Json<JsArray>
        Returns:
        a Stream over all the JsPairs in this json
      • stream

        public Stream<JsPair> stream()
        Description copied from interface: Json
        Returns a stream over the pairs of elements in the first level of this json object.
        Specified by:
        stream in interface Json<JsArray>
        Returns:
        a Stream over all the JsPairs in the first level of this json
      • get

        public JsValue get​(int i)
        returns the element located at the specified index or JsNothing if it doesn't exist. It never throws an exception, it's a total function.
        Parameters:
        i - the index
        Returns:
        a JsValue
      • hashCode

        public final int hashCode()
        equals method is inherited, so it's implemented. The purpose of this method is to cache the hashcode once calculated. the object is immutable and it won't change Single-check idiom Item 83 from Effective Java
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object that)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        // Single-check idiom Item 83 from effective java
        Overrides:
        toString in class Object
      • head

        public final JsValue head()
        Returns the first element of this array.
        Returns:
        the first JsElem of this JsArray
        Throws:
        UserError - if this JsArray is empty
      • tail

        public final JsArray tail()
        Returns a json array consisting of all elements of this array except the first one.
        Returns:
        a JsArray consisting of all the elements of this JsArray except the head
        Throws:
        UserError - if this JsArray is empty.
      • init

        public final JsArray init()
        Returns all the elements of this array except the last one.
        Returns:
        JsArray with all the JsElem except the last one
        Throws:
        UserError - if this JsArray is empty
      • intersection

        public final JsArray intersection​(JsArray that,
                                          JsArray.TYPE ARRAY_AS)
        this.intersection(that, SET) returns an array with the elements that exist in both this and that. this.intersection(that, MULTISET) returns an array with the elements that exist in both this and that, being duplicates allowed. this.intersection(that, LIST) returns an array with the elements that exist in both this and that and are located at the same position.
        Parameters:
        that - the other array
        ARRAY_AS - option to define if arrays are considered SETS, LISTS OR MULTISET
        Returns:
        a new JsArray of the same type as the inputs (mutable or immutable)
      • intersectionAll

        public JsArray intersectionAll​(JsArray that)
        this.intersectionAll(that) behaves as this.intersection(that, LIST), but for those elements that are containers of the same type and are located at the same position, the result is their intersection. So this operation is kind of a recursive intersection
        Parameters:
        that - the other array
        Returns:
        a JsArray of the same type as the inputs (mutable or immutable)
      • id

        public int id()
        Specified by:
        id in interface JsValue
      • isArray

        public boolean isArray()
        Specified by:
        isArray in interface JsValue
        Returns:
        true if this JsElem is a JsArray
      • last

        public final JsValue last()
        Returns the last element of this array.
        Returns:
        the last JsElem of this JsArray
        Throws:
        UserError - if this JsArray is empty
      • prepend

        public final JsArray prepend​(JsValue e,
                                     JsValue... others)
        Adds one or more elements, starting from the last, to the front of this array.
        Parameters:
        e - the JsElem to be added to the front.
        others - more optional JsElem to be added to the front
        Returns:
        a new JsArray
      • prependAll

        public final JsArray prependAll​(JsArray array)
        Adds all the elements of the array, starting from the last, to the front of this array.
        Parameters:
        array - the JsArray of elements to be added to the front
        Returns:
        a new JsArray
      • delete

        public final JsArray delete​(int index)
      • union

        public final JsArray union​(JsArray that,
                                   JsArray.TYPE ARRAY_AS)
        this.union(that, SET) returns this plus those elements from that that don't exist in this. this.union(that, MULTISET) returns this plus those elements from that appended to the back. this.union(that, LIST) returns this plus those elements from that which position is >= this.size().
        Parameters:
        that - the other array
        ARRAY_AS - option to define if arrays are considered SETS, LISTS OR MULTISET
        Returns:
        a new json array of the same type as the inputs (mutable or immutable)
      • unionAll

        public final JsArray unionAll​(JsArray that)
        returns this plus those elements from that which position is >= this.size(), and, at the positions where a container of the same type exists in both this and that, the result is their union. This operations doesn't make any sense if arrays are not considered lists, because there is no notion of order.
        Parameters:
        that - the other array
        Returns:
        a new JsArray of the same type as the inputs (mutable or immutable)