During the API review process (bug 246133) the reviewers decided that in order to include html4j to NetBeans Platform, we need to stop using org.apidesign namespace and switch to NetBeans one. Repackaging all SPI packages into org.netbeans.html.smthng.spi.
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
6 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7 * Other names may be trademarks of their respective owners.
9 * The contents of this file are subject to the terms of either the GNU
10 * General Public License Version 2 only ("GPL") or the Common
11 * Development and Distribution License("CDDL") (collectively, the
12 * "License"). You may not use this file except in compliance with the
13 * License. You can obtain a copy of the License at
14 * http://www.netbeans.org/cddl-gplv2.html
15 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16 * specific language governing permissions and limitations under the
17 * License. When distributing the software, include this License Header
18 * Notice in each file and include the License file at
19 * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20 * particular file as subject to the "Classpath" exception as provided
21 * by Oracle in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the
23 * License Header, with the fields enclosed by brackets [] replaced by
24 * your own identifying information:
25 * "Portions Copyrighted [year] [name of copyright owner]"
29 * The Original Software is NetBeans. The Initial Developer of the Original
30 * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
32 * If you wish your version of this file to be governed by only the CDDL
33 * or only the GPL Version 2, indicate your decision by adding
34 * "[Contributor] elects to include this software in this distribution
35 * under the [CDDL or GPL Version 2] license." If you do not indicate a
36 * single choice of license, a recipient has the option to distribute
37 * your version of this file under either the CDDL, the GPL Version 2 or
38 * to extend the choice of license to its licensees as provided above.
39 * However, if you add GPL Version 2 code and therefore, elected the GPL
40 * Version 2 license, then the option applies only if the new code is
41 * made subject to such option by the copyright holder.
43 package org.netbeans.html.json.spi;
45 import java.io.IOException;
46 import java.io.InputStream;
47 import org.netbeans.html.context.spi.Contexts.Builder;
49 /** A {@link Builder service provider interface} responsible for
50 * conversion of JSON objects to Java ones and vice-versa.
52 * @author Jaroslav Tulach
54 public interface Transfer {
56 * Called to inspect properties of an object (usually a JSON or JavaScript
59 * @param obj the object to inspect
60 * @param props the names of properties to check on the object
62 * @param values array of the same length as <code>props</code> should be
63 * filled by values of properties on the <code>obj</code>. If a property is
64 * not defined, a <code>null</code> value should be stored in the array
66 public void extract(Object obj, String[] props, Object[] values);
68 /** Reads content of a stream and creates its JSON representation.
69 * The returned object is implementation dependant. It however needs
70 * to be acceptable as first argument of {@link #extract(java.lang.Object, java.lang.String[], java.lang.Object[]) extract}
71 * method. If the stream contains representation or a JSON array,
72 * an Object[] should be returned - each of its members should, by itself
73 * be acceptable argument to
74 * the {@link #extract(java.lang.Object, java.lang.String[], java.lang.Object[]) extract} method.
76 * @param is input stream to read data from
77 * @return an object representing the JSON data
78 * @throws IOException if something goes wrong
80 public Object toJSON(InputStream is) throws IOException;
82 /** Starts the JSON or JSONP query.
84 * @param call description of the call to make
86 public void loadJSON(JSONCall call);