org.qas.api.internal.util.json.JsonWriter Maven / Gradle / Ivy
Show all versions of qtest-sdk-java Show documentation
/*
* Copyright (c) 2002 JSON.org
*
* 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 shall be used for Good, not Evil.
*
* 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.
*/
package org.qas.api.internal.util.json;
import org.qas.api.internal.util.Encoders;
import java.io.IOException;
import java.io.Writer;
import java.nio.ByteBuffer;
import java.util.Date;
/**
* JsonWriter provides a quick and convenient way of producing JSON text.
* The texts produced strictly conform to JSON syntax rules. No whitespace is
* added, so the results are ready for transmission or storage. Each instance of
* JsonWriter can produce one JSON text.
*
* A JsonWriter instance provides a value method for appending
* values to the
* text, and a key
* method for adding keys before values in objects. There are array
* and endArray methods that make and bound array values, and
* object and endObject methods which make and bound
* object values. All of these methods return the JsonWriter instance,
* permitting a cascade style. For example,
* new JsonWriter(myWriter)
* .object()
* .key("JSON")
* .value("Hello, World!")
* .endObject(); which writes
* {"JSON":"Hello, World!"}
*
* The first method called must be array or object.
* There are no methods for adding commas or colons. JsonWriter adds them for
* you. Objects and arrays can be nested up to 20 levels deep.
*
* This can sometimes be easier than using a JsonObject to build a string.
*
* @version 2010-03-11
*
* @author Dzung Nguyen
* @version $Id JsonWriter 2014-03-27 09:54:30z dungvnguyen $
* @since 1.0
*/
public class JsonWriter {
//~ class properties ========================================================
private static final int MAX_DEPTH = 20;
/**
* The comma flag determines if a comma should be output before the next
* value.
*/
private boolean comma;
/**
* The current mode. Values:
* 'a' (array),
* 'd' (done),
* 'i' (initial),
* 'k' (key),
* 'o' (object).
*/
protected char mode;
/**
* The object/array stack.
*/
private JsonObject stack[];
/**
* The stack top index. A value of 0 indicates that the stack is empty.
*/
private int top;
/**
* The writer that will receive the output.
*/
protected Writer writer;
//~ class members ===========================================================
/**
* Make a fresh JsonWriter. It can be used to build one JSON text.
*/
public JsonWriter(Writer w) {
this.comma = false;
this.mode = 'i';
this.stack = new JsonObject[MAX_DEPTH];
this.top = 0;
this.writer = w;
}
/**
* Append a value.
* @param s A string value.
* @return this
* @throws JsonException If the value is out of sequence.
*/
private JsonWriter append(String s) throws JsonException {
if (s == null) {
throw new JsonException("Null pointer");
}
if (this.mode == 'o' || this.mode == 'a') {
try {
if (this.comma && this.mode == 'a') {
this.writer.write(',');
}
this.writer.write(s);
} catch (IOException e) {
throw new JsonException(e);
}
if (this.mode == 'o') {
this.mode = 'k';
}
this.comma = true;
return this;
}
throw new JsonException("Value out of sequence.");
}
/**
* Begin appending a new array. All values until the balancing
* endArray will be appended to this array. The
* endArray method must be called to mark the array's end.
* @return this
* @throws JsonException If the nesting is too deep, or if the object is
* started in the wrong place (for example as a key or after the end of the
* outermost array or object).
*/
public JsonWriter array() throws JsonException {
if (this.mode == 'i' || this.mode == 'o' || this.mode == 'a') {
this.push(null);
this.append("[");
this.comma = false;
return this;
}
throw new JsonException("Misplaced array.");
}
/**
* End something.
* @param m Mode
* @param c Closing character
* @return this
* @throws JsonException If unbalanced.
*/
private JsonWriter end(char m, char c) throws JsonException {
if (this.mode != m) {
throw new JsonException(m == 'a' ? "Misplaced endArray." :
"Misplaced endObject.");
}
this.pop(m);
try {
this.writer.write(c);
} catch (IOException e) {
throw new JsonException(e);
}
this.comma = true;
return this;
}
/**
* End an array. This method most be called to balance calls to
* array.
* @return this
* @throws JsonException If incorrectly nested.
*/
public JsonWriter endArray() throws JsonException {
return this.end('a', ']');
}
/**
* End an object. This method most be called to balance calls to
* object.
* @return this
* @throws JsonException If incorrectly nested.
*/
public JsonWriter endObject() throws JsonException {
return this.end('k', '}');
}
/**
* Append a key. The key will be associated with the next value. In an
* object, every value must be preceded by a key.
* @param s A key string.
* @return this
* @throws JsonException If the key is out of place. For example, keys
* do not belong in arrays or if the key is null.
*/
public JsonWriter key(String s) throws JsonException {
if (s == null) {
throw new JsonException("Null key.");
}
if (this.mode == 'k') {
try {
stack[top - 1].putOnce(s, Boolean.TRUE);
if (this.comma) {
this.writer.write(',');
}
this.writer.write(JsonObject.quote(s));
this.writer.write(':');
this.comma = false;
this.mode = 'o';
return this;
} catch (IOException e) {
throw new JsonException(e);
}
}
throw new JsonException("Misplaced key.");
}
/**
* Begin appending a new object. All keys and values until the balancing
* endObject will be appended to this object. The
* endObject method must be called to mark the object's end.
* @return this
* @throws JsonException If the nesting is too deep, or if the object is
* started in the wrong place (for example as a key or after the end of the
* outermost array or object).
*/
public JsonWriter object() throws JsonException {
if (this.mode == 'i') {
this.mode = 'o';
}
if (this.mode == 'o' || this.mode == 'a') {
this.append("{");
this.push(new JsonObject());
this.comma = false;
return this;
}
throw new JsonException("Misplaced object.");
}
/**
* Pop an array or object scope.
* @param c The scope to close.
* @throws JsonException If nesting is wrong.
*/
private void pop(char c) throws JsonException {
if (this.top <= 0) {
throw new JsonException("Nesting error.");
}
char m = this.stack[this.top - 1] == null ? 'a' : 'k';
if (m != c) {
throw new JsonException("Nesting error.");
}
this.top -= 1;
this.mode = this.top == 0 ? 'd' : this.stack[this.top - 1] == null ? 'a' : 'k';
}
/**
* Push an array or object scope.
* @param jo The scope to open.
* @throws JsonException If nesting is too deep.
*/
private void push(JsonObject jo) throws JsonException {
if (this.top >= MAX_DEPTH) {
throw new JsonException("Nesting too deep.");
}
this.stack[this.top] = jo;
this.mode = jo == null ? 'a' : 'k';
this.top += 1;
}
/**
* Append either the value true or the value
* false.
* @param b A boolean.
* @return this
* @throws JsonException
*/
public JsonWriter value(boolean b) throws JsonException {
return this.append(b ? "true" : "false");
}
/**
* Append a double value.
* @param d A double.
* @return this
* @throws JsonException If the number is not finite.
*/
public JsonWriter value(double d) throws JsonException {
return this.value(new Double(d));
}
/**
* Append a long value.
* @param l A long.
* @return this
* @throws JsonException
*/
public JsonWriter value(long l) throws JsonException {
return this.value(new Long(l));
}
/**
* Appends a date value, as epoch seconds.
*
* @param date The date to append.
* @return this
* @throws JsonException
*/
public JsonWriter value(Date date) throws JsonException {
return this.value(new Long(date.getTime() / 1000));
}
/**
* Appends a ByteBuffer value.
*
* @param b A ByteBuffer.
* @return this
* @throws JsonException
*/
public JsonWriter value(ByteBuffer b) throws JsonException {
b.mark();
byte[] bytes = new byte[b.remaining()];
b.get(bytes, 0, bytes.length);
b.reset();
return this.value(Encoders.base64EncodeText(bytes));
}
/**
* Append an object value.
* @param o The object to append. It can be null, or a Boolean, Number,
* String, JsonObject, or JsonArray, or an object with a toJSONString()
* method.
* @return this
* @throws JsonException If the value is out of sequence.
*/
public JsonWriter value(Object o) throws JsonException {
return this.append(JsonObject.valueToString(o));
}
}