content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   * Lesser General Public License for more details.
   *
   * For further information about Alkacon Software GmbH & Co. KG, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://www.opencms.org
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   *
   * This file is based on:
   * org.json.JSONStringer
   * from the JSON in Java implementation.
   *
   * 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.opencms.json;
  
  import java.io.StringWriter;
  
  /**
   * JSONStringer 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
   * JSONStringer can produce one JSON text.
   * <p>
   * A JSONStringer instance provides a <code>value</code> method for appending
   * values to the
   * text, and a <code>key</code>
   * method for adding keys before values in objects. There are <code>array</code>
   * and <code>endArray</code> methods that make and bound array values, and
   * <code>object</code> and <code>endObject</code> methods which make and bound
   * object values. All of these methods return the JSONWriter instance,
   * permitting cascade style. For example, <pre>
   * myString = new JSONStringer()
   *     .object()
   *         .key("JSON")
   *         .value("Hello, World!")
   *     .endObject()
   *     .toString();</pre> which produces the string <pre>
   * {"JSON":"Hello, World!"}</pre>
   * <p>
   * The first method called must be <code>array</code> or <code>object</code>.
   * There are no methods for adding commas or colons. JSONStringer adds them for
   * you. Objects and arrays can be nested up to 20 levels deep.
   * <p>
   * This can sometimes be easier than using a JSONObject to build a string.
   */
  public class JSONStringer extends JSONWriter {
  
      /**
       * Make a fresh JSONStringer. It can be used to build one JSON text.
       */
      public JSONStringer() {
  
          super(new StringWriter());
      }
  
      /**
       * Return the JSON text. This method is used to obtain the product of the
       * JSONStringer instance. It will return <code>null</code> if there was a
       * problem in the construction of the JSON text (such as the calls to
       * <code>array</code> were not properly balanced with calls to
       * <code>endArray</code>).
       * @return The JSON text.
       */
      @Override
      public String toString() {
  
          return m_mode == 'd' ? m_writer.toString() : null;
      }
  }
  