Reinstate JSON license notices in datarouter
[dmaap/datarouter.git] / datarouter-prov / src / main / java / org / json / JSONArray.java
index 14f9ed2..c9e7c42 100644 (file)
  ******************************************************************************/\r
 package org.json;\r
 \r
+/*\r
+ Copyright (c) 2002 JSON.org\r
+\r
+ Permission is hereby granted, free of charge, to any person obtaining a copy\r
+ of this software and associated documentation files (the "Software"), to deal\r
+ in the Software without restriction, including without limitation the rights\r
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
+ copies of the Software, and to permit persons to whom the Software is\r
+ furnished to do so, subject to the following conditions:\r
+\r
+ The above copyright notice and this permission notice shall be included in all\r
+ copies or substantial portions of the Software.\r
+\r
+ The Software shall be used for Good, not Evil.\r
+\r
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r
+ SOFTWARE.\r
+ */\r
 \r
 import java.io.IOException;\r
 import java.io.StringWriter;\r
@@ -33,7 +56,52 @@ import java.util.Iterator;
 import java.util.List;\r
 import java.util.Map;\r
 \r
-\r
+/**\r
+ * A JSONArray is an ordered sequence of values. Its external text form is a\r
+ * string wrapped in square brackets with commas separating the values. The\r
+ * internal form is an object having <code>get</code> and <code>opt</code>\r
+ * methods for accessing the values by index, and <code>put</code> methods for\r
+ * adding or replacing values. The values can be any of these types:\r
+ * <code>Boolean</code>, <code>JSONArray</code>, <code>JSONObject</code>,\r
+ * <code>Number</code>, <code>String</code>, or the\r
+ * <code>JSONObject.NULL object</code>.\r
+ * <p>\r
+ * The constructor can convert a JSON text into a Java object. The\r
+ * <code>toString</code> method converts to JSON text.\r
+ * <p>\r
+ * A <code>get</code> method returns a value if one can be found, and throws an\r
+ * exception if one cannot be found. An <code>opt</code> method returns a\r
+ * default value instead of throwing an exception, and so is useful for\r
+ * obtaining optional values.\r
+ * <p>\r
+ * The generic <code>get()</code> and <code>opt()</code> methods return an\r
+ * object which you can cast or query for type. There are also typed\r
+ * <code>get</code> and <code>opt</code> methods that do type checking and type\r
+ * coercion for you.\r
+ * <p>\r
+ * The texts produced by the <code>toString</code> methods strictly conform to\r
+ * JSON syntax rules. The constructors are more forgiving in the texts they will\r
+ * accept:\r
+ * <ul>\r
+ * <li>An extra <code>,</code>&nbsp;<small>(comma)</small> may appear just\r
+ * before the closing bracket.</li>\r
+ * <li>The <code>null</code> value will be inserted when there is <code>,</code>\r
+ * &nbsp;<small>(comma)</small> elision.</li>\r
+ * <li>Strings may be quoted with <code>'</code>&nbsp;<small>(single\r
+ * quote)</small>.</li>\r
+ * <li>Strings do not need to be quoted at all if they do not begin with a quote\r
+ * or single quote, and if they do not contain leading or trailing spaces, and\r
+ * if they do not contain any of these characters:\r
+ * <code>{ } [ ] / \ : , = ; #</code> and if they do not look like numbers and\r
+ * if they are not the reserved words <code>true</code>, <code>false</code>, or\r
+ * <code>null</code>.</li>\r
+ * <li>Values can be separated by <code>;</code> <small>(semicolon)</small> as\r
+ * well as by <code>,</code> <small>(comma)</small>.</li>\r
+ * </ul>\r
+ *\r
+ * @author JSON.org\r
+ * @version 2012-11-13\r
+ */\r
 public class JSONArray {\r
 \r
     /**\r