com.hfg.javascript.JsCollection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation

com.hfg xml, html, svg, and bioinformatics utility library

There is a newer version: 20240423

package com.hfg.javascript;


import java.io.Writer;

//------------------------------------------------------------------------------
/**
 JSON interface for Collections.

 @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg Library
//
// 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.
//
// 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
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public interface JsCollection
{
   //--------------------------------------------------------------------------
   /**
    Produces a JSON serialization of the Collection. Ex: [ "foo", { "key1": 1.0, "key2": "Hello" } ]
    */
   public String toJSON();

   //--------------------------------------------------------------------------
   /**
    Produces a JSON serialization of the Collection. Ex: [ "foo", { "key1": 1.0, "key2": "Hello" } ]
    @param inWriter where to send the JSON to
    */
   public void toJSON(Writer inWriter);

   //--------------------------------------------------------------------------
   /**
    Produces a javascript serialization that will generally be the same as produced
    by toJSON() except when values have been added via the putUnquoted() method.
    */
   public String toJavascript();

   //--------------------------------------------------------------------------
   /**
    Produces a javascript serialization that will generally be the same as produced
    by toJSON() except when values have been added via the putUnquoted() method.
    @param inWriter where to send the javascript to
    */
   public void toJavascript(Writer inWriter);

}