1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/json/src/main/java/org/netbeans/html/json/spi/Transfer.java	Tue Aug 26 18:13:30 2014 +0200
     1.3 @@ -0,0 +1,88 @@
     1.4 +/**
     1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     1.6 + *
     1.7 + * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
     1.8 + *
     1.9 + * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
    1.10 + * Other names may be trademarks of their respective owners.
    1.11 + *
    1.12 + * The contents of this file are subject to the terms of either the GNU
    1.13 + * General Public License Version 2 only ("GPL") or the Common
    1.14 + * Development and Distribution License("CDDL") (collectively, the
    1.15 + * "License"). You may not use this file except in compliance with the
    1.16 + * License. You can obtain a copy of the License at
    1.17 + * http://www.netbeans.org/cddl-gplv2.html
    1.18 + * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
    1.19 + * specific language governing permissions and limitations under the
    1.20 + * License.  When distributing the software, include this License Header
    1.21 + * Notice in each file and include the License file at
    1.22 + * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
    1.23 + * particular file as subject to the "Classpath" exception as provided
    1.24 + * by Oracle in the GPL Version 2 section of the License file that
    1.25 + * accompanied this code. If applicable, add the following below the
    1.26 + * License Header, with the fields enclosed by brackets [] replaced by
    1.27 + * your own identifying information:
    1.28 + * "Portions Copyrighted [year] [name of copyright owner]"
    1.29 + *
    1.30 + * Contributor(s):
    1.31 + *
    1.32 + * The Original Software is NetBeans. The Initial Developer of the Original
    1.33 + * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
    1.34 + *
    1.35 + * If you wish your version of this file to be governed by only the CDDL
    1.36 + * or only the GPL Version 2, indicate your decision by adding
    1.37 + * "[Contributor] elects to include this software in this distribution
    1.38 + * under the [CDDL or GPL Version 2] license." If you do not indicate a
    1.39 + * single choice of license, a recipient has the option to distribute
    1.40 + * your version of this file under either the CDDL, the GPL Version 2 or
    1.41 + * to extend the choice of license to its licensees as provided above.
    1.42 + * However, if you add GPL Version 2 code and therefore, elected the GPL
    1.43 + * Version 2 license, then the option applies only if the new code is
    1.44 + * made subject to such option by the copyright holder.
    1.45 + */
    1.46 +package org.netbeans.html.json.spi;
    1.47 +
    1.48 +import java.io.IOException;
    1.49 +import java.io.InputStream;
    1.50 +import org.netbeans.html.context.spi.Contexts.Builder;
    1.51 +
    1.52 +/** A {@link Builder service provider interface} responsible for 
    1.53 + * conversion of JSON objects to Java ones and vice-versa.
    1.54 + *
    1.55 + * @author Jaroslav Tulach
    1.56 + */
    1.57 +public interface Transfer {
    1.58 +    /**
    1.59 +     * Called to inspect properties of an object (usually a JSON or JavaScript
    1.60 +     * wrapper).
    1.61 +     *
    1.62 +     * @param obj the object to inspect
    1.63 +     * @param props the names of properties to check on the object
    1.64 +     * <code>obj</code>
    1.65 +     * @param values array of the same length as <code>props</code> should be
    1.66 +     * filled by values of properties on the <code>obj</code>. If a property is
    1.67 +     * not defined, a <code>null</code> value should be stored in the array
    1.68 +     */
    1.69 +    public void extract(Object obj, String[] props, Object[] values);
    1.70 +    
    1.71 +    /** Reads content of a stream and creates its JSON representation.
    1.72 +     * The returned object is implementation dependant. It however needs
    1.73 +     * to be acceptable as first argument of {@link #extract(java.lang.Object, java.lang.String[], java.lang.Object[]) extract}
    1.74 +     * method. If the stream contains representation or a JSON array,
    1.75 +     * an Object[] should be returned - each of its members should, by itself
    1.76 +     * be acceptable argument to 
    1.77 +     * the {@link #extract(java.lang.Object, java.lang.String[], java.lang.Object[]) extract} method.
    1.78 +     * 
    1.79 +     * @param is input stream to read data from
    1.80 +     * @return an object representing the JSON data
    1.81 +     * @throws IOException if something goes wrong
    1.82 +     */
    1.83 +    public Object toJSON(InputStream is) throws IOException;
    1.84 +    
    1.85 +    /** Starts the JSON or JSONP query. 
    1.86 +     * 
    1.87 +     * @param call description of the call to make
    1.88 +     */
    1.89 +    public void loadJSON(JSONCall call);
    1.90 +    
    1.91 +}