src/main/java/de/uniks/networkparser/json/JsonObject.java
package de.uniks.networkparser.json;
/*
NetworkParser
The MIT License
Copyright (c) 2010-2016 Stefan Lindel https://www.github.com/fujaba/NetworkParser/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
import de.uniks.networkparser.EntityUtil;
import de.uniks.networkparser.Tokener;
import de.uniks.networkparser.buffer.Buffer;
import de.uniks.networkparser.buffer.CharacterBuffer;
import de.uniks.networkparser.converter.EntityStringConverter;
import de.uniks.networkparser.interfaces.BaseItem;
import de.uniks.networkparser.interfaces.Entity;
import de.uniks.networkparser.list.AbstractList;
import de.uniks.networkparser.list.SimpleKeyValueList;
/**
* A JsonObject is an unordered collection of name/value pairs. Its external
* form is a string wrapped in curly braces with colons between the names and
* values, and commas between the values and names. The internal form is an
* object having <code>get</code> and <code>opt</code> methods for accessing the
* values by name, and <code>put</code> methods for adding or replacing values
* by name. The values can be any of these types: <code>Boolean</code>,
* <code>JsonArray</code>, <code>JsonObject</code>, <code>Number</code>,
* <code>String</code>, or the <code>JsonObject.NULL</code> object. A JsonObject
* constructor can be used to convert an external form JSON text into an
* internal form whose values can be retrieved with the <code>get</code> and
* <code>opt</code> methods, or to convert values into a JSON text using the
* <code>put</code> and <code>toString</code> methods. A <code>get</code> method
* returns a value if one can be found, and throws an exception if one cannot be
* found. An <code>opt</code> method returns a default value instead of throwing
* an exception, and so is useful for obtaining optional values.
* <p>
* The generic <code>get()</code> and <code>opt()</code> methods return an
* object, which you can cast or query for type. There are also typed
* <code>get</code> and <code>opt</code> methods that do type checking and type
* coercion for you. The opt methods differ from the get methods in that they do
* not throw. Instead, they return a specified value, such as null.
* <p>
* The <code>put</code> methods add or replace values in an object. For example,
*
* <pre>
* myString = new JsonObject().put("JSON", "Hello, World!").toString();
* </pre>
*
*
*
* produces the string <code>{"JSON": "Hello, World"}</code>.
* <p>
* The texts produced by the <code>toString</code> methods strictly conform to
* the JSON syntax rules. The constructors are more forgiving in the texts they
* will accept:
* <ul>
* <li>An extra <code>,</code> <small>(comma)</small> may appear just
* before the closing brace.</li>
* <li>Strings may be quoted with <code>'</code> <small>(single
* quote)</small>.</li>
* <li>Strings do not need to be quoted at all if they do not begin with a quote
* or single quote, and if they do not contain leading or trailing spaces, and
* if they do not contain any of these characters:
* <code>{} [ ] / \ : , = ; #</code> and if they do not look like numbers and if
* they are not the reserved words <code>true</code>, <code>false</code>, or
* <code>null</code>.</li>
* <li>Keys can be followed by <code>=</code> or <code>=></code> as well as
* by <code>:</code>.</li>
* <li>Values can be followed by <code>;</code> <small>(semicolon)</small> as
* well as by <code>,</code> <small>(comma)</small>.</li>
* </ul>
*
* @author JSON.org
* @version 2011-11-24
*/
public class JsonObject extends SimpleKeyValueList<String, Object> implements Entity {
public static final char START = '{';
public static final char END = '}';
public JsonObject() {
this.withAllowDuplicate(false);
}
/**
* Get the JsonArray value associated with a key.
*
* @param key A key string.
* @return A JsonArray which is the value. if the key is not found or if the
* value is not a JsonArray.
*/
public JsonArray getJsonArray(String key) {
Object object = this.get(key);
if (object instanceof JsonArray) {
return (JsonArray) object;
}
JsonArray returnValue = new JsonArray();
if (object != null) {
if (object instanceof String) {
try {
returnValue.withValue((String) object);
return returnValue;
} catch (Exception e) {
}
}
returnValue.add(object);
}
return returnValue;
}
/**
* Get the JsonObject value associated with a key.
*
* @param key A key string.
* @return A JsonObject which is the value.
*/
public JsonObject getJsonObject(String key) {
Object object = this.get(key);
if (object instanceof JsonObject) {
return (JsonObject) object;
} else if (object instanceof String) {
return new JsonObject().withValue("" + object);
}
return null;
}
/**
* Make a JSON text of this JsonObject. For compactness, no whitespace is added.
* If this would not result in a syntactically correct JSON text, then null will
* be returned instead.
* <p>
* Warning: This method assumes that the data structure is acyclical.
*
* @return a printable, displayable, portable, transmittable representation of
* the object, beginning with <code>{</code> <small>(left
* brace)</small> and ending with <code>}</code> <small>(right
* brace)</small>.
*/
@Override
public String toString() {
return parseItem(new EntityStringConverter());
}
/**
* Make a prettyprinted JSON text of this JsonObject.
* <p>
* Warning: This method assumes that the data structure is acyclical.
*
* @param indentFactor The number of spaces to add to each level of indentation.
* @return a printable, displayable, portable, transmittable representation of
* the object, beginning with <code>{</code> <small>(left
* brace)</small> and ending with <code>}</code> <small>(right
* brace)</small>.
*/
@Override
public String toString(int indentFactor) {
return parseItem(new EntityStringConverter(indentFactor));
}
protected String parseItem(EntityStringConverter converter) {
int length = this.size();
if (length == 0 || converter == null) {
return "{}";
}
if (isVisible() == false) {
return "{" + size() + " values}";
}
converter.add();
StringBuilder sb = new StringBuilder();
sb.append(START);
if (length > 1) {
sb.append(converter.getPrefix());
}
sb.append(EntityUtil.quote(get(0)));
sb.append(":");
sb.append(EntityUtil.valueToString(getValueByIndex(0), false, this, converter));
for (int i = 1; i < length; i++) {
sb.append(",");
sb.append(converter.getPrefix());
sb.append(EntityUtil.quote(get(i)));
sb.append(":");
sb.append(EntityUtil.valueToString(getValueByIndex(i), false, this, converter));
}
converter.minus();
if (length > 1) {
sb.append(converter.getPrefix());
}
sb.append(END);
return sb.toString();
}
/**
* Set the value to Tokener or pairs of values
*
* @param values a simple String of Value or pairs of key-values
* @return Itself
*/
public JsonObject withValue(String... values) {
if (values == null || values.length == 1 && values[0] == null) {
return this;
}
if (values.length % 2 == 0) {
for (int z = 0; z < values.length; z += 2) {
if (values[z + 1] != null) {
/* Only add value != null */
put(values[z], values[z + 1]);
}
}
return this;
}
if (values.length > 0) {
CharacterBuffer buffer = new CharacterBuffer().with(values[0]);
Tokener tokener = new JsonTokener();
tokener.parseToEntity(this, buffer);
return this;
}
return this;
}
/**
* Set the value to Tokener or pairs of values
*
* @param values a simple String of Value or pairs of key-values
* @return Itself
*/
public JsonObject withValue(Buffer values) {
new JsonTokener().parseToEntity(this, values);
return this;
}
/**
* Tokener to init the JsonObject
*
* @param entity entity to add values with the tokener
* @return Itself
*/
public JsonObject withEntity(SimpleKeyValueList<?, ?> entity) {
new JsonTokener().parseToEntity(this, entity);
return this;
}
/**
* Get a new Instance of JsonArray, JsonObject
*/
@Override
public BaseItem getNewList(boolean keyValue) {
if (keyValue) {
return new JsonObject();
}
return new JsonArray();
}
public boolean has(String key) {
return containsKey(key);
}
@Override
public JsonObject withKeyValue(Object key, Object value) {
super.withKeyValue(key, value);
return this;
}
/**
* Accumulate values under a key. It is similar to the put method except that if
* there is already an object stored under the key then a EntityList is stored
* under the key to hold all of the accumulated values. If there is already a
* EntityList, then the new value is appended to it. In contrast, the put method
* replaces the previous value.
*
* If only one value is accumulated that is not a EntityList, then the result
* will be the same as using put. But if multiple values are accumulated, then
* the result will be like append.
*
* @param key A key string.
* @param value An object to be accumulated under the key.
* @return this.
*/
public JsonObject addToList(String key, Object value) {
Object object = this.get(key);
if (object == null) {
if (value instanceof AbstractList) {
BaseItem newList = getNewList(true);
newList.add(value);
this.put(key, newList);
} else {
this.put(key, value);
}
} else if (object instanceof AbstractList) {
((AbstractList<?>) object).with(value);
} else {
BaseItem newList = getNewList(false);
newList.add(object, value);
this.put(key, newList);
}
return this;
}
public JsonObject withKeyValue(String key, Object value) {
if (value != null) {
/* Only add value != null */
int index = indexOf(key);
if (index >= 0) {
setValueItem(key, value);
return this;
}
super.withKeyValue(key, value);
}
return this;
}
public Entity without(String key) {
remove(key);
return this;
}
public static JsonObject create(String value) {
return new JsonObject().withValue(value);
}
@Override
public Entity getElementBy(String key, String value) {
if (value == null || this.size() < 1) {
return null;
}
Object item = this.get(value);
JsonObject child;
if (item instanceof JsonObject) {
child = (JsonObject) item;
} else {
child = new JsonObject();
this.put(value, child);
}
return child;
}
@Override
public JsonObject withType(String type) {
this.add(Entity.CLASS, type);
return this;
}
public JsonObject addComment(String comment) {
if (comment == null) {
return this;
}
this.withAllowDuplicate(true);
this.withAllowEmptyValue(true);
this.add(null, comment);
return this;
}
@Override
public boolean equals(Object obj) {
if (obj instanceof JsonObject) {
JsonObject other = (JsonObject) obj;
if (this.size() != other.size()) {
return false;
}
for (int i = 0; i < this.size(); i++) {
if (this.getKeyByIndex(i).equals(other.getKeyByIndex(i)) == false) {
return false;
}
Object value = this.getValueByIndex(i);
Object otherValue = other.getValueByIndex(i);
if (value == null && otherValue != null) {
return false;
} else if (value != null && value.equals(otherValue) == false) {
return false;
}
}
return true;
}
return super.equals(obj);
}
}