delight.json.JSON Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of delight-json Show documentation

Rendering of simple, human-readable JSON documents.

The newest version!

package delight.json;

import delight.json.internal.JSONArrayImpl;
import delight.json.internal.JSONObjectImpl;

/**
 * 
 * A JSON document for which fields can be added and which can be rendered into
 * a {@link String}.
 * 
 * @author Max Rohde
 *
 */
public abstract class JSON {

    /**
     * Creates a new instance. Note instances are not thread-safe.
     * 
     * @return A new instance for rendering JSON.
     */
    public static JSONObject create() {
        return new JSONObjectImpl();
    }

    public static JSONArray createArray() {
        return new JSONArrayImpl();
    }

    public static JSONObject forToString(final Object obj) {
        final JSONObject json = JSON.create();

        json.add("class", obj.getClass().getName());
        json.add("identity", System.identityHashCode(obj));

        return json;
    }

    /**
     * 
     * @return The rendered string representation of this JSON document.
     */
    public abstract String render();

    /**
     * 
     * @param indentSize
     *            Defines how many spaces are to be inserted at the beginning of
     *            ever line.
     * @return The rendered string representation of this JSON document.
     */
    public abstract String render(int indentSize);

    /**
     * 
     * Prints this document to standard out.
     */
    public abstract void print();

}