Package jsonvalues

Class JsObj

  • All Implemented Interfaces:
    Iterable<io.vavr.Tuple2<String,​JsValue>>, Json<JsObj>, JsValue

    public class JsObj
    extends Object
    implements Json<JsObj>, Iterable<io.vavr.Tuple2<String,​JsValue>>
    Represents a json object, which is an unordered set of name/element pairs. Two implementations are provided, an immutable which uses the persistent Scala HashMap, and a mutable which uses the conventional Java HashMap.
    • Constructor Detail

      • JsObj

        public JsObj()
    • Method Detail

      • empty

        public static JsObj empty()
      • of

        public static JsObj of​(String key,
                               JsValue el)
        Returns a one-element immutable object.
        Parameters:
        key - name of a key
        el - JsValue to be associated to the key
        Returns:
        an immutable one-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2)
        Returns a two-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        Returns:
        an immutable two-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3)
        Returns a three-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        Returns:
        an immutable three-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4)
        Returns a four-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        Returns:
        an immutable four-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5)
        Returns a five-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        Returns:
        an immutable five-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5,
                               String key6,
                               JsValue el6)
        Returns a six-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        key6 - name of a key
        el6 - JsValue to be associated to the key6
        Returns:
        an immutable six-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5,
                               String key6,
                               JsValue el6,
                               String key7,
                               JsValue el7)
        Returns a six-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        key6 - name of a key
        el6 - JsValue to be associated to the key6
        key7 - name of a key
        el7 - JsValue to be associated to the key7
        Returns:
        an immutable seven-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5,
                               String key6,
                               JsValue el6,
                               String key7,
                               JsValue el7,
                               String key8,
                               JsValue el8)
        Returns a six-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        key6 - name of a key
        el6 - JsValue to be associated to the key6
        key7 - name of a key
        el7 - JsValue to be associated to the key7
        key8 - name of a key
        el8 - JsValue to be associated to the key8
        Returns:
        an immutable eight-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5,
                               String key6,
                               JsValue el6,
                               String key7,
                               JsValue el7,
                               String key8,
                               JsValue el8,
                               String key9,
                               JsValue el9)
        Returns a six-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        key6 - name of a key
        el6 - JsValue to be associated to the key6
        key7 - name of a key
        el7 - JsValue to be associated to the key7
        key8 - name of a key
        el8 - JsValue to be associated to the key8
        key9 - name of a key
        el9 - JsValue to be associated to the key9
        Returns:
        an immutable nine-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5,
                               String key6,
                               JsValue el6,
                               String key7,
                               JsValue el7,
                               String key8,
                               JsValue el8,
                               String key9,
                               JsValue el9,
                               String key10,
                               JsValue el10)
        Returns a six-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        key6 - name of a key
        el6 - JsValue to be associated to the key6
        key7 - name of a key
        el7 - JsValue to be associated to the key7
        key8 - name of a key
        el8 - JsValue to be associated to the key8
        key9 - name of a key
        el9 - JsValue to be associated to the key9
        key10 - name of a key
        el10 - JsValue to be associated to the key10
        Returns:
        an immutable ten-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5,
                               String key6,
                               JsValue el6,
                               String key7,
                               JsValue el7,
                               String key8,
                               JsValue el8,
                               String key9,
                               JsValue el9,
                               String key10,
                               JsValue el10,
                               String key11,
                               JsValue el11)
        Returns a six-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        key6 - name of a key
        el6 - JsValue to be associated to the key6
        key7 - name of a key
        el7 - JsValue to be associated to the key7
        key8 - name of a key
        el8 - JsValue to be associated to the key8
        key9 - name of a key
        el9 - JsValue to be associated to the key9
        key10 - name of a key
        el10 - JsValue to be associated to the key10
        key11 - name of a key
        el11 - JsValue to be associated to the key11
        Returns:
        an immutable eleven-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5,
                               String key6,
                               JsValue el6,
                               String key7,
                               JsValue el7,
                               String key8,
                               JsValue el8,
                               String key9,
                               JsValue el9,
                               String key10,
                               JsValue el10,
                               String key11,
                               JsValue el11,
                               String key12,
                               JsValue el12)
        Returns a six-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        key6 - name of a key
        el6 - JsValue to be associated to the key6
        key7 - name of a key
        el7 - JsValue to be associated to the key7
        key8 - name of a key
        el8 - JsValue to be associated to the key8
        key9 - name of a key
        el9 - JsValue to be associated to the key9
        key10 - name of a key
        el10 - JsValue to be associated to the key10
        key11 - name of a key
        el11 - JsValue to be associated to the key11
        key12 - name of a key
        el12 - JsValue to be associated to the key12
        Returns:
        an immutable twelve-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5,
                               String key6,
                               JsValue el6,
                               String key7,
                               JsValue el7,
                               String key8,
                               JsValue el8,
                               String key9,
                               JsValue el9,
                               String key10,
                               JsValue el10,
                               String key11,
                               JsValue el11,
                               String key12,
                               JsValue el12,
                               String key13,
                               JsValue el13)
        Returns a six-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        key6 - name of a key
        el6 - JsValue to be associated to the key6
        key7 - name of a key
        el7 - JsValue to be associated to the key7
        key8 - name of a key
        el8 - JsValue to be associated to the key8
        key9 - name of a key
        el9 - JsValue to be associated to the key9
        key10 - name of a key
        el10 - JsValue to be associated to the key10
        key11 - name of a key
        el11 - JsValue to be associated to the key11
        key12 - name of a key
        el12 - JsValue to be associated to the key12
        key13 - name of a key
        el13 - JsValue to be associated to the key13
        Returns:
        an immutable twelve-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5,
                               String key6,
                               JsValue el6,
                               String key7,
                               JsValue el7,
                               String key8,
                               JsValue el8,
                               String key9,
                               JsValue el9,
                               String key10,
                               JsValue el10,
                               String key11,
                               JsValue el11,
                               String key12,
                               JsValue el12,
                               String key13,
                               JsValue el13,
                               String key14,
                               JsValue el14)
        Returns a six-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        key6 - name of a key
        el6 - JsValue to be associated to the key6
        key7 - name of a key
        el7 - JsValue to be associated to the key7
        key8 - name of a key
        el8 - JsValue to be associated to the key8
        key9 - name of a key
        el9 - JsValue to be associated to the key9
        key10 - name of a key
        el10 - JsValue to be associated to the key10
        key11 - name of a key
        el11 - JsValue to be associated to the key11
        key12 - name of a key
        el12 - JsValue to be associated to the key12
        key13 - name of a key
        el13 - JsValue to be associated to the key13
        key14 - name of a key
        el14 - JsValue to be associated to the key14
        Returns:
        an immutable twelve-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

        public static JsObj of​(String key1,
                               JsValue el1,
                               String key2,
                               JsValue el2,
                               String key3,
                               JsValue el3,
                               String key4,
                               JsValue el4,
                               String key5,
                               JsValue el5,
                               String key6,
                               JsValue el6,
                               String key7,
                               JsValue el7,
                               String key8,
                               JsValue el8,
                               String key9,
                               JsValue el9,
                               String key10,
                               JsValue el10,
                               String key11,
                               JsValue el11,
                               String key12,
                               JsValue el12,
                               String key13,
                               JsValue el13,
                               String key14,
                               JsValue el14,
                               String key15,
                               JsValue el15)
        Returns a six-element immutable object.
        Parameters:
        key1 - name of a key
        el1 - JsValue to be associated to the key1
        key2 - name of a key
        el2 - JsValue to be associated to the key2
        key3 - name of a key
        el3 - JsValue to be associated to the key3
        key4 - name of a key
        el4 - JsValue to be associated to the key4
        key5 - name of a key
        el5 - JsValue to be associated to the key5
        key6 - name of a key
        el6 - JsValue to be associated to the key6
        key7 - name of a key
        el7 - JsValue to be associated to the key7
        key8 - name of a key
        el8 - JsValue to be associated to the key8
        key9 - name of a key
        el9 - JsValue to be associated to the key9
        key10 - name of a key
        el10 - JsValue to be associated to the key10
        key11 - name of a key
        el11 - JsValue to be associated to the key11
        key12 - name of a key
        el12 - JsValue to be associated to the key12
        key13 - name of a key
        el13 - JsValue to be associated to the key13
        key14 - name of a key
        el14 - JsValue to be associated to the key14
        key15 - name of a key
        el15 - JsValue to be associated to the key15
        Returns:
        an immutable twelve-element JsObj
        Throws:
        UserError - if an elem is a mutable Json
      • of

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

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

        public boolean containsKey​(String key)
        return true if the key is present
        Parameters:
        key - the key
        Returns:
        true if the specified key exists
      • 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<JsObj>
        Parameters:
        el - the give element JsValue whose presence in this JsArray is to be tested
        Returns:
        true if this JsArray contains the JsValue
      • keySet

        public final Set<String> keySet()
        Returns a set containing each key fo this object.
        Returns:
        a Set containing each key of this JsObj
      • 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<JsObj>
        Parameters:
        path - the JsPath object of the element that will be returned
        Returns:
        the JsValue located at the given JsPath or JsNothing if it doesn't exist
      • filterAllValues

        public final JsObj 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<JsObj>
        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
      • filterKeys

        public final JsObj filterKeys​(Predicate<? super JsPair> filter)
        Description copied from interface: Json
        Filters the keys in the first level of this json, removing those that don't ifPredicateElse the predicate.
        Specified by:
        filterKeys in interface Json<JsObj>
        Parameters:
        filter - the predicate which takes as the input every JsPair in the first level 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 the whole json and not only the first level
      • filterAllKeys

        public JsObj 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<JsObj>
        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 JsObj 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<JsObj>
        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<JsObj>
        Returns:
        true if empty, false otherwise
      • set

        public JsObj set​(JsPath path,
                         JsValue element)
        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<JsObj>
        Parameters:
        path - the JsPath object where the element will be inserted at
        element - the JsValue that will be inserted
        Returns:
        the same instance or a new json of the same type T
      • set

        public final JsObj set​(JsPath path,
                               JsValue value,
                               JsValue padElement)
        Description copied from interface: Json
        Inserts the element at the path in this json, replacing any existing element and filling with padElement 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<JsObj>
        Parameters:
        path - the JsPath object where the element will be inserted at
        value - the JsValue that will be inserted
        padElement - the JsValue that will be inserted in arrays when padding is necessary
        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<JsObj>
        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<JsObj>
        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 JsObj 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<JsObj>
        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<JsObj>
        Returns:
        the number of elements in the first level of this json
      • streamAll

        public final 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<JsObj>
        Returns:
        a Stream over all the JsPairs in this json
      • stream

        public final 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<JsObj>
        Returns:
        a Stream over all the JsPairs in the first level of this json
      • equals

        public boolean equals​(JsObj that,
                              JsArray.TYPE ARRAY_AS)
        return true if this obj is equal to the given as a parameter. In the case of ARRAY_AS=LIST, this method is equivalent to JsObj.equals(Object).
        Parameters:
        that - the given array
        ARRAY_AS - enum to specify if arrays are considered as lists or sets or multisets
        Returns:
        true if both objs are equals
      • getArray

        public JsArray getArray​(String key)
        Returns the array located at the given key or null if it doesn't exist or it's not an array.
        Parameters:
        key - the key
        Returns:
        the JsArray located at the given key or null
      • getBigDec

        public BigDecimal getBigDec​(String key)
        Returns the number located at the given key as a big decimal or null if it doesn't exist or it's not a decimal number.
        Parameters:
        key - the key
        Returns:
        the BigDecimal located at the given key or null
      • getBigInt

        public BigInteger getBigInt​(String key)
        Returns the big integer located at the given key as a big integer or null if it doesn't exist or it's not an integral number.
        Parameters:
        key - the key
        Returns:
        the BigInteger located at the given key or null
      • getBool

        public Boolean getBool​(String key)
        Returns the boolean located at the given key or null if it doesn't exist.
        Parameters:
        key - the key
        Returns:
        the Boolean located at the given key or null
      • getDouble

        public Double getDouble​(String key)
        Returns the number located at the given key as a double or null if it doesn't exist or it's not a decimal number. If the number is a BigDecimal, the conversion is identical to the specified in BigDecimal.doubleValue() and in some cases it can lose information about the precision of the BigDecimal
        Parameters:
        key - the key
        Returns:
        the decimal number located at the given key or null
      • getInt

        public Integer getInt​(String key)
        Returns the integral number located at the given key as an integer or null if it doesn't exist or it's not an integral number or it's an integral number but doesn't fit in an integer.
        Parameters:
        key - the key
        Returns:
        the integral number located at the given key or null
      • getLong

        public Long getLong​(String key)
        Returns the integral number located at the given key as a long or null if it doesn't exist or it's not an integral number or it's an integral number but doesn't fit in a long.
        Parameters:
        key - the key
        Returns:
        the integral number located at the given key or null
      • getObj

        public JsObj getObj​(String key)
        Returns the json object located at the given key or null if it doesn't exist or it's not an object.
        Parameters:
        key - the key
        Returns:
        the json object located at the given key or null
      • getStr

        public String getStr​(String key)
        Returns the string located at the given key or null if it doesn't exist or it's not an string.
        Parameters:
        key - the key
        Returns:
        the string located at the given key or null
      • 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
      • id

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

        public boolean isObj()
        Specified by:
        isObj in interface JsValue
        Returns:
        true if this JsValue is a JsObj
      • head

        public final io.vavr.Tuple2<String,​JsValue> head()
        Returns a pair with an arbitrary key of this object and its associated element. When using head and tail to process a JsObj, the key of the pair returned must be passed in to get the tail using the method tail().
        Returns:
        an arbitrary Map.Entry<String,JsValue> of this JsObj
        Throws:
        UserError - if this json object is empty
      • tail

        public final JsObj tail()
        Returns a new object with all the entries of this json object except the one with the given key.
        Returns:
        a new JsObj
        Throws:
        UserError - if this json object is empty
      • intersection

        public JsObj intersection​(JsObj 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 obj
        ARRAY_AS - option to define if arrays are considered SETS, LISTS OR MULTISET
        Returns:
        a new JsObj of the same type as the inputs (mutable or immutable)
      • intersectionAll

        public JsObj intersectionAll​(JsObj that,
                                     JsArray.TYPE ARRAY_AS)
        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 object
        ARRAY_AS - option to define if arrays are considered SETS, LISTS OR MULTISET
        Returns:
        a new JsObj of the same type as the inputs (mutable or immutable)
      • set

        public JsObj set​(String key,
                         JsValue value)
        Inserts the element at the key in this json, replacing any existing element.
        Parameters:
        key - the key
        value - the element
        Returns:
        a new json object
      • union

        public final JsObj union​(JsObj that)
        returns this json object plus those pairs from the given json object that which keys don't exist in this. Taking that into account, it's not a commutative operation unless the elements associated with the keys that exist in both json objects are equals.
        Parameters:
        that - the given json object
        Returns:
        a new JsObj of the same type as the inputs (mutable or immutable)
      • unionAll

        public final JsObj unionAll​(JsObj that,
                                    JsArray.TYPE ARRAY_AS)
        behaves like the union(JsObj) but, for those keys that exit in both this and that json objects, which associated elements are **containers of the same type**, the result is their union. In this case, we can specify if arrays are considered Sets, Lists, or MultiSets. So this operation is kind of a 'recursive' union.
        Parameters:
        that - the given json object
        ARRAY_AS - option to define if arrays are considered SETS, LISTS OR MULTISET
        Returns:
        a new JsObj of the same type as the inputs (mutable or immutable)