Package de.dytanic.cloudnet.common.document.gson

Class JsonDocument

java.lang.Object

de.dytanic.cloudnet.common.document.gson.JsonDocument

All Implemented Interfaces:

IJsonDocPropertyable, IDocument<JsonDocument>, IPersistable, IReadable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.String>

public class JsonDocument
extends java.lang.Object
implements IDocument<JsonDocument>, java.lang.Cloneable

The Gson implementation of IDocument class. It includes simple append and remove operations, file reading and writing to create simple configuration files

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static com.google.gson.Gson	GSON
protected com.google.gson.JsonObject	jsonObject

Constructor Summary

Constructors

Constructor	Description
JsonDocument()
JsonDocument(com.google.gson.JsonElement jsonElement)	Deprecated. causes issues because of the relocated Gson, will be made private in a future release
JsonDocument(com.google.gson.JsonObject jsonObject)	Deprecated. causes issues because of the relocated Gson, will be made private in a future release
JsonDocument(java.lang.Object toObjectMirror)
JsonDocument(java.lang.String key, JsonDocument value)
JsonDocument(java.lang.String key, java.lang.Boolean value)
JsonDocument(java.lang.String key, java.lang.Character value)
JsonDocument(java.lang.String key, java.lang.Number value)
JsonDocument(java.lang.String key, java.lang.Object value)
JsonDocument(java.lang.String key, java.lang.String value)
JsonDocument(java.lang.String key, java.util.Properties value)
JsonDocument(java.util.Properties properties)

Method Summary

Modifier and Type	Method	Description
JsonDocument	append(com.google.gson.JsonObject jsonObject)	Deprecated. causes issues because of the relocated Gson, will be made private in a future release
JsonDocument	append(JsonDocument document)
JsonDocument	append(java.io.InputStream inputStream)
JsonDocument	append(java.io.Reader reader)
JsonDocument	append(java.lang.String key, byte[] bytes)
JsonDocument	append(java.lang.String key, JsonDocument value)
JsonDocument	append(java.lang.String key, java.lang.Boolean value)
JsonDocument	append(java.lang.String key, java.lang.Character value)
JsonDocument	append(java.lang.String key, java.lang.Number value)
JsonDocument	append(java.lang.String key, java.lang.Object value)
JsonDocument	append(java.lang.String key, java.lang.String value)
JsonDocument	append(java.lang.String key, java.util.Properties properties)
JsonDocument	append(java.util.Map<java.lang.String,java.lang.Object> map)
JsonDocument	append(java.util.Properties properties)
JsonDocument	clear()
JsonDocument	clone()
boolean	contains(java.lang.String key)
com.google.gson.JsonElement	get(java.lang.String key)	Deprecated. causes issues because of the relocated Gson, will be removed in a future release
<T> T	get(java.lang.String key, com.google.gson.Gson gson, java.lang.Class<T> clazz)
<T> T	get(java.lang.String key, com.google.gson.Gson gson, java.lang.reflect.Type type)
<T> T	get(java.lang.String key, java.lang.Class<T> clazz)
<T> T	get(java.lang.String key, java.lang.Class<T> clazz, T def)
<T> T	get(java.lang.String key, java.lang.reflect.Type type)
<T> T	get(java.lang.String key, java.lang.reflect.Type type, T def)
java.math.BigDecimal	getBigDecimal(java.lang.String key)
java.math.BigDecimal	getBigDecimal(java.lang.String key, java.math.BigDecimal def)
java.math.BigInteger	getBigInteger(java.lang.String key)
java.math.BigInteger	getBigInteger(java.lang.String key, java.math.BigInteger def)
byte[]	getBinary(java.lang.String key)
byte[]	getBinary(java.lang.String key, byte[] def)
boolean	getBoolean(java.lang.String key)
java.lang.Boolean	getBoolean(java.lang.String key, java.lang.Boolean def)
byte	getByte(java.lang.String key)
char	getChar(java.lang.String key)
java.lang.Character	getChar(java.lang.String key, java.lang.Character def)
JsonDocument	getDocument(java.lang.String key)
JsonDocument	getDocument(java.lang.String key, JsonDocument def)
double	getDouble(java.lang.String key)
java.lang.Double	getDouble(java.lang.String key, java.lang.Double def)
float	getFloat(java.lang.String key)
java.lang.Float	getFloat(java.lang.String key, java.lang.Float def)
int	getInt(java.lang.String key)
java.lang.Integer	getInt(java.lang.String key, java.lang.Integer def)
com.google.gson.JsonArray	getJsonArray(java.lang.String key)	Deprecated. causes issues because of the relocated Gson, will be removed in a future release
com.google.gson.JsonArray	getJsonArray(java.lang.String key, com.google.gson.JsonArray def)	Deprecated. causes issues because of the relocated Gson, will be removed in a future release
com.google.gson.JsonObject	getJsonObject(java.lang.String key)	Deprecated. causes issues because of the relocated Gson, will be removed in a future release
com.google.gson.JsonObject	getJsonObject(java.lang.String key, com.google.gson.JsonObject def)	Deprecated. causes issues because of the relocated Gson, will be removed in a future release
long	getLong(java.lang.String key)
java.lang.Long	getLong(java.lang.String key, java.lang.Long def)
JsonDocument	getProperties()
java.util.Properties	getProperties(java.lang.String key)
java.util.Properties	getProperties(java.lang.String key, java.util.Properties def)
<E> E	getProperty(JsonDocProperty<E> docProperty)
short	getShort(java.lang.String key)
java.lang.Short	getShort(java.lang.String key, java.lang.Short def)
java.lang.String	getString(java.lang.String key)
java.lang.String	getString(java.lang.String key, java.lang.String def)
<E> boolean	hasProperty(JsonDocProperty<E> docProperty)
@NotNull java.util.Iterator<java.lang.String>	iterator()
java.util.Collection<java.lang.String>	keys()
static JsonDocument	newDocument()
static JsonDocument	newDocument(byte[] bytes)
static JsonDocument	newDocument(com.google.gson.JsonObject jsonObject)	Deprecated. causes issues because of the relocated Gson, will be removed in a future release
static JsonDocument	newDocument(java.io.File file)
static JsonDocument	newDocument(java.lang.Object object)
static JsonDocument	newDocument(java.lang.String input)
static JsonDocument	newDocument(java.lang.String key, java.lang.Boolean value)
static JsonDocument	newDocument(java.lang.String key, java.lang.Character value)
static JsonDocument	newDocument(java.lang.String key, java.lang.Number value)
static JsonDocument	newDocument(java.lang.String key, java.lang.Object value)
static JsonDocument	newDocument(java.lang.String key, java.lang.String value)
static JsonDocument	newDocument(java.nio.file.Path path)
IReadable	read(byte[] bytes)
JsonDocument	read(java.io.InputStream inputStream)
JsonDocument	read(java.io.Reader reader)
JsonDocument	read(java.lang.String input)
JsonDocument	remove(java.lang.String key)
<E> JsonDocument	removeProperty(JsonDocProperty<E> docProperty)
<E> JsonDocument	setProperty(JsonDocProperty<E> docProperty, E val)
int	size()
byte[]	toByteArray()
<T> T	toInstanceOf(java.lang.Class<T> clazz)
<T> T	toInstanceOf(java.lang.reflect.Type type)
java.lang.String	toJson()
com.google.gson.JsonObject	toJsonObject()	Deprecated. causes issues because of the relocated Gson, will be removed in a future release
java.lang.String	toPrettyJson()
java.lang.String	toString()
JsonDocument	write(java.io.OutputStream outputStream)
JsonDocument	write(java.io.Writer writer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.dytanic.cloudnet.common.document.IDocument

isEmpty

Methods inherited from interface de.dytanic.cloudnet.common.document.IPersistable

write, write, write, write, write, write

Methods inherited from interface de.dytanic.cloudnet.common.document.IReadable

append, append, append, append, append, append, read, read, read, read, read

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

GSON

public static com.google.gson.Gson GSON

jsonObject

protected final com.google.gson.JsonObject jsonObject

Constructor Detail

JsonDocument

@Deprecated
public JsonDocument(com.google.gson.JsonObject jsonObject)

Deprecated.

causes issues because of the relocated Gson, will be made private in a future release

JsonDocument

public JsonDocument()

JsonDocument

public JsonDocument(java.lang.Object toObjectMirror)

JsonDocument

@Deprecated
public JsonDocument(com.google.gson.JsonElement jsonElement)

Deprecated.

causes issues because of the relocated Gson, will be made private in a future release

JsonDocument

public JsonDocument(java.util.Properties properties)

JsonDocument

public JsonDocument(java.lang.String key,
                    java.lang.String value)

JsonDocument

public JsonDocument(java.lang.String key,
                    java.lang.Object value)

JsonDocument

public JsonDocument(java.lang.String key,
                    java.lang.Boolean value)

JsonDocument

public JsonDocument(java.lang.String key,
                    java.lang.Number value)

JsonDocument

public JsonDocument(java.lang.String key,
                    java.lang.Character value)

JsonDocument

public JsonDocument(java.lang.String key,
                    JsonDocument value)

JsonDocument

public JsonDocument(java.lang.String key,
                    java.util.Properties value)

Method Detail

newDocument

public static JsonDocument newDocument()

newDocument

@Deprecated
public static JsonDocument newDocument(com.google.gson.JsonObject jsonObject)

Deprecated.

causes issues because of the relocated Gson, will be removed in a future release

newDocument

public static JsonDocument newDocument(java.lang.String key,
                                       java.lang.String value)

newDocument

public static JsonDocument newDocument(java.lang.String key,
                                       java.lang.Number value)

newDocument

public static JsonDocument newDocument(java.lang.String key,
                                       java.lang.Character value)

newDocument

public static JsonDocument newDocument(java.lang.String key,
                                       java.lang.Boolean value)

newDocument

public static JsonDocument newDocument(java.lang.String key,
                                       java.lang.Object value)

newDocument

public static JsonDocument newDocument(byte[] bytes)

newDocument

public static JsonDocument newDocument(java.lang.Object object)

newDocument

public static JsonDocument newDocument(java.io.File file)

newDocument

public static JsonDocument newDocument(java.nio.file.Path path)

newDocument

public static JsonDocument newDocument(java.lang.String input)

keys

public java.util.Collection<java.lang.String> keys()

Specified by:

keys in interface IDocument<JsonDocument>

size

public int size()

Specified by:

size in interface IDocument<JsonDocument>

clear

public JsonDocument clear()

Specified by:

clear in interface IDocument<JsonDocument>

remove

public JsonDocument remove(java.lang.String key)

Specified by:

remove in interface IDocument<JsonDocument>

contains

public boolean contains(java.lang.String key)

Specified by:

contains in interface IDocument<JsonDocument>

toInstanceOf

public <T> T toInstanceOf(java.lang.Class<T> clazz)

Specified by:

toInstanceOf in interface IDocument<JsonDocument>

toInstanceOf

public <T> T toInstanceOf(java.lang.reflect.Type type)

Specified by:

toInstanceOf in interface IDocument<JsonDocument>

append

public JsonDocument append(java.lang.String key,
                           java.lang.Object value)

Specified by:

append in interface IDocument<JsonDocument>

append

public JsonDocument append(java.lang.String key,
                           java.lang.Number value)

Specified by:

append in interface IDocument<JsonDocument>

append

public JsonDocument append(java.lang.String key,
                           java.lang.Boolean value)

Specified by:

append in interface IDocument<JsonDocument>

append

public JsonDocument append(java.lang.String key,
                           java.lang.String value)

Specified by:

append in interface IDocument<JsonDocument>

append

public JsonDocument append(java.lang.String key,
                           java.lang.Character value)

Specified by:

append in interface IDocument<JsonDocument>

append

public JsonDocument append(java.lang.String key,
                           JsonDocument value)

Specified by:

append in interface IDocument<JsonDocument>

append

public JsonDocument append(JsonDocument document)

Specified by:

append in interface IDocument<JsonDocument>

append

@Deprecated
public JsonDocument append(com.google.gson.JsonObject jsonObject)

Deprecated.

causes issues because of the relocated Gson, will be made private in a future release

append

public JsonDocument append(java.util.Properties properties)

Specified by:

append in interface IDocument<JsonDocument>

append

public JsonDocument append(java.lang.String key,
                           java.util.Properties properties)

Specified by:

append in interface IDocument<JsonDocument>

append

public JsonDocument append(java.lang.String key,
                           byte[] bytes)

Specified by:

append in interface IDocument<JsonDocument>

append

public JsonDocument append(java.util.Map<java.lang.String,java.lang.Object> map)

Specified by:

append in interface IDocument<JsonDocument>

append

public JsonDocument append(java.io.InputStream inputStream)

Specified by:

append in interface IReadable

append

public JsonDocument append(java.io.Reader reader)

Specified by:

append in interface IReadable

getDocument

public JsonDocument getDocument(java.lang.String key)

Specified by:

getDocument in interface IDocument<JsonDocument>

getInt

public int getInt(java.lang.String key)

Specified by:

getInt in interface IDocument<JsonDocument>

getDouble

public double getDouble(java.lang.String key)

Specified by:

getDouble in interface IDocument<JsonDocument>

getFloat

public float getFloat(java.lang.String key)

Specified by:

getFloat in interface IDocument<JsonDocument>

getByte

public byte getByte(java.lang.String key)

Specified by:

getByte in interface IDocument<JsonDocument>

getShort

public short getShort(java.lang.String key)

Specified by:

getShort in interface IDocument<JsonDocument>

getLong

public long getLong(java.lang.String key)

Specified by:

getLong in interface IDocument<JsonDocument>

getBoolean

public boolean getBoolean(java.lang.String key)

Specified by:

getBoolean in interface IDocument<JsonDocument>

getString

public java.lang.String getString(java.lang.String key)

Specified by:

getString in interface IDocument<JsonDocument>

getChar

public char getChar(java.lang.String key)

Specified by:

getChar in interface IDocument<JsonDocument>

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String key)

Specified by:

getBigDecimal in interface IDocument<JsonDocument>

getBigInteger

public java.math.BigInteger getBigInteger(java.lang.String key)

Specified by:

getBigInteger in interface IDocument<JsonDocument>

getJsonArray

@Deprecated
public com.google.gson.JsonArray getJsonArray(java.lang.String key)

Deprecated.

causes issues because of the relocated Gson, will be removed in a future release

getJsonObject

@Deprecated
public com.google.gson.JsonObject getJsonObject(java.lang.String key)

Deprecated.

causes issues because of the relocated Gson, will be removed in a future release

getProperties

public java.util.Properties getProperties(java.lang.String key)

Specified by:

getProperties in interface IDocument<JsonDocument>

get

@Deprecated
public com.google.gson.JsonElement get(java.lang.String key)

Deprecated.

causes issues because of the relocated Gson, will be removed in a future release

getBinary

public byte[] getBinary(java.lang.String key)

Specified by:

getBinary in interface IDocument<JsonDocument>

get

public <T> T get(java.lang.String key,
                 java.lang.Class<T> clazz)

Specified by:

get in interface IDocument<JsonDocument>

get

public <T> T get(java.lang.String key,
                 java.lang.reflect.Type type)

Specified by:

get in interface IDocument<JsonDocument>

get

public <T> T get(java.lang.String key,
                 com.google.gson.Gson gson,
                 java.lang.Class<T> clazz)

get

public <T> T get(java.lang.String key,
                 com.google.gson.Gson gson,
                 java.lang.reflect.Type type)

getInt

public java.lang.Integer getInt(java.lang.String key,
                                java.lang.Integer def)

getShort

public java.lang.Short getShort(java.lang.String key,
                                java.lang.Short def)

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key,
                                    java.lang.Boolean def)

getLong

public java.lang.Long getLong(java.lang.String key,
                              java.lang.Long def)

getDouble

public java.lang.Double getDouble(java.lang.String key,
                                  java.lang.Double def)

getFloat

public java.lang.Float getFloat(java.lang.String key,
                                java.lang.Float def)

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String def)

getDocument

public JsonDocument getDocument(java.lang.String key,
                                JsonDocument def)

getJsonArray

@Deprecated
public com.google.gson.JsonArray getJsonArray(java.lang.String key,
                                              com.google.gson.JsonArray def)

Deprecated.

causes issues because of the relocated Gson, will be removed in a future release

getJsonObject

@Deprecated
public com.google.gson.JsonObject getJsonObject(java.lang.String key,
                                                com.google.gson.JsonObject def)

Deprecated.

causes issues because of the relocated Gson, will be removed in a future release

getBinary

public byte[] getBinary(java.lang.String key,
                        byte[] def)

get

public <T> T get(java.lang.String key,
                 java.lang.reflect.Type type,
                 T def)

get

public <T> T get(java.lang.String key,
                 java.lang.Class<T> clazz,
                 T def)

getProperties

public java.util.Properties getProperties(java.lang.String key,
                                          java.util.Properties def)

getBigInteger

public java.math.BigInteger getBigInteger(java.lang.String key,
                                          java.math.BigInteger def)

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String key,
                                          java.math.BigDecimal def)

getChar

public java.lang.Character getChar(java.lang.String key,
                                   java.lang.Character def)

write

public JsonDocument write(java.io.OutputStream outputStream)

Specified by:

write in interface IPersistable

write

public JsonDocument write(java.io.Writer writer)

Specified by:

write in interface IPersistable

read

public JsonDocument read(java.io.InputStream inputStream)

Specified by:

read in interface IReadable

read

public JsonDocument read(java.io.Reader reader)

Specified by:

read in interface IReadable

read

public IReadable read(byte[] bytes)

Specified by:

read in interface IReadable

read

public JsonDocument read(java.lang.String input)

Specified by:

read in interface IReadable

setProperty

public <E> JsonDocument setProperty(JsonDocProperty<E> docProperty,
                                    E val)

Specified by:

setProperty in interface IJsonDocPropertyable

getProperty

public <E> E getProperty(JsonDocProperty<E> docProperty)

Specified by:

getProperty in interface IJsonDocPropertyable

removeProperty

public <E> JsonDocument removeProperty(JsonDocProperty<E> docProperty)

Specified by:

removeProperty in interface IJsonDocPropertyable

hasProperty

public <E> boolean hasProperty(JsonDocProperty<E> docProperty)

Specified by:

hasProperty in interface IJsonDocPropertyable

getProperties

public JsonDocument getProperties()

Specified by:

getProperties in interface IJsonDocPropertyable

toJsonObject

@Deprecated
public com.google.gson.JsonObject toJsonObject()

Deprecated.

causes issues because of the relocated Gson, will be removed in a future release

toPrettyJson

public java.lang.String toPrettyJson()

toJson

public java.lang.String toJson()

toByteArray

public byte[] toByteArray()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

iterator

@NotNull
public @NotNull java.util.Iterator<java.lang.String> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

clone

public JsonDocument clone()

Overrides:

clone in class java.lang.Object