com.sun.jersey.api.json.JSONUnmarshaller Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.jersey.api.json;
import java.io.InputStream;
import java.io.Reader;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBException;
import javax.xml.bind.UnmarshalException;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
/**
* A JSON unmarshaller responsible for deserializing JSON data to a Java
* content tree, defined by JAXB.
*
* @author [email protected], [email protected]
*/
public interface JSONUnmarshaller {
/**
* Unmarshal JSON data from the specified InputStream and
* return the resulting Java content tree.
*
* The UTF-8 character encoding scheme will be used to decode the encoded
* characters of the JSON data.
*
* @param the type of the Java content tree.
* @param is the InputStream to unmarshal JSON data from.
* @param expectedType the expected type of the Java content tree.
* @return the newly created root object of the Java content tree. The
* content tree may be an instance of a class that is
* mapped to a XML root element (for example, annotated with
* {@link XmlRootElement}) or mapped to an XML type (for example,
* annotated with {@link XmlType}).
* @throws JAXBException if any unexpected errors occur while unmarshalling.
* @throws UnmarshalException if the JSONUnmarshaller is unable
* to perform the JSON to Java binding.
*/
T unmarshalFromJSON(InputStream is,
Class expectedType) throws JAXBException;
/**
* Unmarshal JSON data from the specified Reader and
* return the resulting Java content tree.
*
* The character encoding scheme of the reader will be used to
* encode the characters of the JSON data.
*
* @param the type of the Java content tree.
* @param reader the Reader to unmarshal JSON data from.
* @param expectedType the expected type of the Java content tree.
* @return the newly created root object of the Java content tree. The
* content tree may be an instance of a class that is
* mapped to a XML root element (for example, annotated with
* {@link XmlRootElement}) or mapped to an XML type (for example,
* annotated with {@link XmlType}).
* @throws JAXBException if any unexpected errors occur while unmarshalling.
* @throws UnmarshalException if the JSONUnmarshaller is unable
* to perform the JSON to Java binding.
*/
T unmarshalFromJSON(Reader reader,
Class expectedType) throws JAXBException;
/**
* Unmarshal JSON data from the InputStream by
* declaredType and return the resulting content tree.
*
* The UTF-8 character encoding scheme will be used to decode the encoded
* characters of the JSON data.
*
* @param the type of the Java content tree.
* @param is the InputStream to unmarshal JSON data from.
* @param declaredType a class that is mapped to a XML root element
* (for example, annotated with {@link XmlRootElement}) or mapped to
* an XML type (for example, annotated with {@link XmlType}).
* @return the newly created root object of the Java content tree, root
* by a {@link JAXBElement} instance.
* @throws JAXBException if any unexpected errors occur while unmarshalling.
* @throws UnmarshalException if the JSONUnmarshaller is unable
* to perform the JSON to Java binding.
*/
JAXBElement unmarshalJAXBElementFromJSON(InputStream is,
Class declaredType) throws JAXBException;
/**
* Unmarshal JSON data from the Reader by
* declaredType and return the resulting content tree.
*
* The character encoding scheme of the reader will be used to
* encode the characters of the JSON data.
*
* @param the type of the Java content tree.
* @param reader the Reader to unmarshal JSON data from.
* @param declaredType a class that is mapped to a XML root element
* (for example, annotated with {@link XmlRootElement}) or mapped to
* an XML type (for example, annotated with {@link XmlType}).
* @return the newly created root object of the Java content tree, root
* by a {@link JAXBElement} instance.
* @throws JAXBException if any unexpected errors occur while unmarshalling.
* @throws UnmarshalException if the JSONUnmarshaller is unable
* to perform the JSON to Java binding.
*/
JAXBElement unmarshalJAXBElementFromJSON(Reader reader,
Class declaredType) throws JAXBException;
}