blue.endless.jankson

Class JsonObject

java.lang.Object

blue.endless.jankson.JsonElement

blue.endless.jankson.JsonObject

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,JsonElement>

public class JsonObject
extends JsonElement
implements java.util.Map<java.lang.String,JsonElement>

Field Summary

Fields

Modifier and Type	Field and Description
protected Marshaller	marshaller

Constructor Summary

Constructors

Constructor and Description
JsonObject()

Method Summary

Modifier and Type	Method and Description
void	clear()
JsonObject	clone()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object val)
java.util.Set<java.util.Map.Entry<java.lang.String,JsonElement>>	entrySet() Creates a semi-live shallow copy instead of a live view
boolean	equals(java.lang.Object other)
<E> E	get(java.lang.Class<E> clazz, java.lang.String key)
JsonElement	get(java.lang.Object key)
java.lang.String	getComment(java.lang.String name) Returns the comment "attached to" a given key-value mapping, which is to say, the comment appearing immediately before it or the single-line comment to the right of it.
JsonObject	getDelta(JsonObject defaults) Gets a minimal set of key-value-comment settings which, if added to the supplied JsonObject, would produce this JsonObject.
Marshaller	getMarshaller()
JsonObject	getObject(java.lang.String name) If there is an entry at this key, and that entry is a json object, return it.
int	hashCode()
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet() Returns a defensive copy instead of a live view
JsonElement	put(java.lang.String key, JsonElement elem) Replaces a key-value mapping in this object if it exists, or adds the mapping to the end of the object if it doesn't.
JsonElement	put(java.lang.String key, JsonElement elem, java.lang.String comment) Replaces a key-value mapping in this object if it exists, or adds the mapping to the end of the object if it doesn't.
void	putAll(java.util.Map<? extends java.lang.String,? extends JsonElement> map)
JsonElement	putDefault(java.lang.String key, JsonElement elem, java.lang.String comment)
<T> T	putDefault(java.lang.String key, T elem, java.lang.Class<? extends T> clazz, java.lang.String comment) May return null if the existing object can't be marshalled to the target class
<T> T	putDefault(java.lang.String key, T elem, java.lang.String comment) May return null if the existing object can't be marshalled to elem's class
<E> E	recursiveGet(java.lang.Class<E> clazz, java.lang.String key) Gets a (potentially nested) element from this object if it exists.
<E extends JsonElement> E	recursiveGetOrCreate(java.lang.Class<E> clazz, java.lang.String key, E fallback, java.lang.String comment) Gets a (potentially nested) element from this object if it exists, or creates it and any intermediate objects needed to put it at the indicated location in the hierarchy.
JsonElement	remove(java.lang.Object key)
void	setComment(java.lang.String name, java.lang.String comment)
void	setMarshaller(Marshaller marshaller)
int	size()
java.lang.String	toJson(boolean comments, boolean newlines, int depth)
java.lang.String	toString()
java.util.Collection<JsonElement>	values()

Methods inherited from class blue.endless.jankson.JsonElement

toJson, toJson

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

marshaller

protected Marshaller marshaller

Constructor Detail

JsonObject

public JsonObject()

Method Detail

getObject

@Nullable
public JsonObject getObject(@Nonnull
                                      java.lang.String name)

If there is an entry at this key, and that entry is a json object, return it. Otherwise returns null.

put

public JsonElement put(@Nonnull
                       java.lang.String key,
                       @Nonnull
                       JsonElement elem,
                       @Nullable
                       java.lang.String comment)

Replaces a key-value mapping in this object if it exists, or adds the mapping to the end of the object if it doesn't. Returns the old value mapped to this key if there was one.

putDefault

@Nonnull
public JsonElement putDefault(@Nonnull
                                       java.lang.String key,
                                       @Nonnull
                                       JsonElement elem,
                                       @Nullable
                                       java.lang.String comment)

putDefault

@Nullable
public <T> T putDefault(@Nonnull
                                  java.lang.String key,
                                  @Nonnull
                                  T elem,
                                  @Nullable
                                  java.lang.String comment)

May return null if the existing object can't be marshalled to elem's class

putDefault

@Nullable
public <T> T putDefault(@Nonnull
                                  java.lang.String key,
                                  @Nonnull
                                  T elem,
                                  java.lang.Class<? extends T> clazz,
                                  @Nullable
                                  java.lang.String comment)

May return null if the existing object can't be marshalled to the target class

getDelta

@Nonnull
public JsonObject getDelta(@Nonnull
                                    JsonObject defaults)

Gets a minimal set of key-value-comment settings which, if added to the supplied JsonObject, would produce this JsonObject. See blue.endless.jankson.BasicTests#testDiffAgainstDefaults() for more details on this comparison.

• If a key is present in the default and not in the object, it's skipped
• If a key is an object, a deep (recursive) comparison occurs. Comments are ignored in this comparison.
• All other types, including lists, receive a shallow comparison of its value. The comment is ignored in this comparison.
• Whether deep or shallow, if the key is found to be identical in value to its default, it is skipped.
• If the key is found to be different than its default, the key, value, and comment are represented in the output.

getComment

@Nullable
public java.lang.String getComment(@Nonnull
                                             java.lang.String name)

Returns the comment "attached to" a given key-value mapping, which is to say, the comment appearing immediately before it or the single-line comment to the right of it.

setComment

public void setComment(@Nonnull
                       java.lang.String name,
                       @Nullable
                       java.lang.String comment)

toJson

public java.lang.String toJson(boolean comments,
                               boolean newlines,
                               int depth)

Specified by:

toJson in class JsonElement

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Specified by:

equals in interface java.util.Map<java.lang.String,JsonElement>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<java.lang.String,JsonElement>

Overrides:

hashCode in class java.lang.Object

setMarshaller

public void setMarshaller(Marshaller marshaller)

getMarshaller

public Marshaller getMarshaller()

get

@Nullable
public <E> E get(@Nonnull
                           java.lang.Class<E> clazz,
                           @Nonnull
                           java.lang.String key)

recursiveGet

@Nullable
public <E> E recursiveGet(@Nonnull
                                    java.lang.Class<E> clazz,
                                    @Nonnull
                                    java.lang.String key)

Gets a (potentially nested) element from this object if it exists.

Parameters:

clazz - The expected class of the element

key - The keys of the nested elements, separated by periods, such as "foo.bar.baz"

Returns:

The element at that location, if it exists and is of the proper type, otherwise null.

recursiveGetOrCreate

public <E extends JsonElement> E recursiveGetOrCreate(@Nonnull
                                                      java.lang.Class<E> clazz,
                                                      @Nonnull
                                                      java.lang.String key,
                                                      @Nonnull
                                                      E fallback,
                                                      @Nullable
                                                      java.lang.String comment)

Gets a (potentially nested) element from this object if it exists, or creates it and any intermediate objects needed to put it at the indicated location in the hierarchy.

Parameters:

clazz - The expected class of the element

key - The keys of the nested elements, separated by periods, such as "foo.bar.baz"

Returns:

The element at that location if it exists, or the newly-created element if it did not previously exist.

clone

public JsonObject clone()

Specified by:

clone in class JsonElement

put

@Nullable
public JsonElement put(@Nonnull
                                 java.lang.String key,
                                 @Nonnull
                                 JsonElement elem)

Replaces a key-value mapping in this object if it exists, or adds the mapping to the end of the object if it doesn't. Returns the old value mapped to this key if there was one.

Specified by:

put in interface java.util.Map<java.lang.String,JsonElement>

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,JsonElement>

containsKey

public boolean containsKey(@Nullable
                           java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,JsonElement>

containsValue

public boolean containsValue(@Nullable
                             java.lang.Object val)

Specified by:

containsValue in interface java.util.Map<java.lang.String,JsonElement>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,JsonElement>> entrySet()

Creates a semi-live shallow copy instead of a live view

Specified by:

entrySet in interface java.util.Map<java.lang.String,JsonElement>

get

@Nullable
public JsonElement get(@Nullable
                                 java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,JsonElement>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,JsonElement>

keySet

@Nonnull
public java.util.Set<java.lang.String> keySet()

Returns a defensive copy instead of a live view

Specified by:

keySet in interface java.util.Map<java.lang.String,JsonElement>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends JsonElement> map)

Specified by:

putAll in interface java.util.Map<java.lang.String,JsonElement>

remove

@Nullable
public JsonElement remove(@Nullable
                                    java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,JsonElement>

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,JsonElement>

values

public java.util.Collection<JsonElement> values()

Specified by:

values in interface java.util.Map<java.lang.String,JsonElement>