All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.xerial.json.JSONWriter Maven / Gradle / Ivy

There is a newer version: 3.4.0
Show newest version
/*--------------------------------------------------------------------------
 *  Copyright 2008 Taro L. Saito
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *--------------------------------------------------------------------------*/
//--------------------------------------
// XerialJ
//
// JSONWriter.java
// Since: Feb 1, 2008 10:22:07 AM
//
// $URL$
// $Author$
//--------------------------------------
package org.xerial.json;

import java.io.IOException;
import java.io.PrintWriter;
import java.io.Reader;
import java.io.Writer;
import java.util.LinkedList;
import java.util.ListIterator;

import org.xerial.core.XerialError;
import org.xerial.lens.ObjectLens;

/**
 * A support class for generating JSON data
 * 
 * @author leo
 * 
 */
public class JSONWriter {
    private final PrintWriter writer;

    enum JSONState {
        InObject, InArray, InString, Root, Unknown
    }

    private final LinkedList stateStack = new LinkedList();
    private final LinkedList elementCountStack = new LinkedList();

    public JSONWriter(Writer writer) {
        this.writer = new PrintWriter(writer);
        stateStack.add(JSONState.Root);
        elementCountStack.add(0);
    }

    private void pushState(JSONState state) {
        stateStack.add(state);
        elementCountStack.add(0);
    }

    private void popState() {
        stateStack.removeLast();
        elementCountStack.removeLast();
    }

    private JSONState getCurrentState() {
        if (stateStack.isEmpty())
            return JSONState.Unknown;
        else
            return stateStack.getLast();
    }

    private int getPreviousElementCount() {
        return elementCountStack.isEmpty() ? 0 : elementCountStack.getLast();
    }

    private void incrementElementCount() {
        int count = elementCountStack.removeLast();
        elementCountStack.add(++count);
    }

    public void startObject() {
        if (getCurrentState() == JSONState.InArray)
            putComma();
        writer.print("{");
        pushState(JSONState.InObject);
    }

    public void endObject() {
        if (getCurrentState() != JSONState.InObject)
            throw new XerialError(JSONErrorCode.NotInAJSONObject,
                    "cannot end the object outside of the JSON object");
        writer.print("}");
        popState();

        if (getCurrentState() == JSONState.InArray)
            incrementElementCount();
    }

    public void startArray() {
        writer.print("[");
        pushState(JSONState.InArray);
    }

    public void endArray() {
        if (getCurrentState() != JSONState.InArray)
            throw new XerialError(JSONErrorCode.NotInAJSONArray,
                    "cannot end the arry outside of the JSON array");

        writer.print("]");
        popState();
    }

    public void startString() {
        if (getCurrentState() == JSONState.InArray)
            throw new XerialError(JSONErrorCode.NotInAJSONArray,
                    "cannot start a new string value outside of the JSON array in this method");
        putComma();
        writer.append("\"");
        pushState(JSONState.InString);
    }

    public void startString(String key) {
        putKeyPart(key);
        writer.append("\"");
        pushState(JSONState.InString);
    }

    public void append(String stringFragment) {
        if (getCurrentState() != JSONState.InString)
            throw new XerialError(JSONErrorCode.NotInAJSONString,
                    "cannot append any string before invoking startString() method");

        writer.append(stringFragment);
    }

    public void endString() {
        if (getCurrentState() != JSONState.InString)
            throw new XerialError(JSONErrorCode.NotInAJSONString,
                    "cannot end the string not beginning from startString() method.");
        writer.append("\"");
        popState();
    }

    public void startArray(String key) {
        if (getCurrentState() != JSONState.InObject)
            throw new XerialError(JSONErrorCode.NotInAJSONObject,
                    "cannot start a keyed array outside of the JSON object");

        if (getPreviousElementCount() > 0)
            writer.print(",");
        writer.print(doubleQuote(key));
        writer.print(":[");
        incrementElementCount();
        pushState(JSONState.InArray);
    }

    public void add(String value) {
        addInternal(doubleQuote(value));
    }

    public void add(int value) {
        addInternal(value);
    }

    public void add(long value) {
        addInternal(value);
    }

    public void add(double value) {
        addInternal(value);
    }

    public void add(float value) {
        addInternal(value);
    }

    public void add(boolean bool) {
        if (bool)
            addInternal("true");
        else
            addInternal("false");
    }

    public void addNull() {
        addInternal("null");
    }

    public void addObject(Object bean) {
        String jsonObject = ObjectLens.toJSON(bean);
        addInternal(jsonObject);
    }

    private void addInternal(Object value) {
        putComma();
        if (value != null)
            writer.append(value.toString());
        else
            writer.append("null");
        incrementElementCount();
    }

    private void putComma() {
        if (getPreviousElementCount() > 0)
            writer.print(",");
    }

    public void put(String key, String value) {
        putInternal(key, doubleQuote(value));
    }

    public void put(String key, int value) {
        putInternal(key, value);
    }

    public void put(String key, float value) {
        putInternal(key, value);
    }

    public void put(String key, double value) {
        putInternal(key, value);
    }

    public void put(String key, long value) {
        putInternal(key, value);
    }

    public void put(String key, boolean value) {
        if (value)
            putInternal(key, "true");
        else
            putInternal(key, "false");
    }

    public void putObject(String key, Object obj) {
        if (obj == null)
            return; // output nothing
        else {
            putInternal(key, ObjectLens.toJSON(obj));
        }

    }

    public void putNull(String key) {
        putInternal(key, "null");
    }

    /**
     * Generate the key/value pair from the {@link Reader}
     * 
     * @param key
     * @param input
     * @throws IOException
     * @throws IOException
     */
    public void putString(String key, Reader input) throws IOException {
        putKeyPart(key);
        writer.append("\"");
        for (int ch; (ch = input.read()) != -1;) {
            writer.append((char) ch);
        }
        writer.append("\"");
    }

    private void putInternal(String key, Object value) {
        putKeyPart(key);
        writer.append(value.toString());
        incrementElementCount();
    }

    private void putKeyPart(String key) {
        if (getCurrentState() != JSONState.InObject)
            throw new XerialError(JSONErrorCode.NotInAJSONObject,
                    "cannot add key and value pair outside of the JSON object");
        if (getPreviousElementCount() > 0)
            writer.append(",");
        writer.append(doubleQuote(key));
        writer.append(":");
        incrementElementCount();
    }

    public void startObject(String key) {
        putKeyPart(key);
        startObject();
    }

    public void flush() {
        writer.flush();
    }

    public void endJSON() {
        for (ListIterator it = stateStack.listIterator(stateStack.size()); it
                .hasPrevious();) {
            JSONState state = it.previous();
            switch (state) {
            case InObject:
                writer.append("}");
                break;
            case InArray:
                writer.append("]");
                break;
            case InString:
                writer.append("\"");
            default:
                // do nothing
                break;
            }
        }
        flush();
    }

    private String doubleQuote(String value) {
        return "\"" + value + "\"";
    }

    public Writer getWriter() {
        return writer;
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy