Package org.glassfish.jersey.jettison

Interface JettisonUnmarshaller

public interface JettisonUnmarshaller
A JSON unmarshaller responsible for deserializing JSON data to a Java content tree, defined by JAXB.
Author:
Paul Sandoz, Jakub Podlesak

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> T
    unmarshalFromJSON(InputStream is, Class<T> expectedType)
    Unmarshal JSON data from the specified InputStream and return the resulting Java content tree.
    <T> T
    unmarshalFromJSON(Reader reader, Class<T> expectedType)
    Unmarshal JSON data from the specified Reader and return the resulting Java content tree.
    <T> jakarta.xml.bind.JAXBElement<T>
    unmarshalJAXBElementFromJSON(InputStream is, Class<T> declaredType)
    Unmarshal JSON data from the InputStream by declaredType and return the resulting content tree.
    <T> jakarta.xml.bind.JAXBElement<T>
    unmarshalJAXBElementFromJSON(Reader reader, Class<T> declaredType)
    Unmarshal JSON data from the Reader by declaredType and return the resulting content tree.

  • Method Details

    • unmarshalFromJSON

      <T> T unmarshalFromJSON(InputStream is, Class<T> expectedType) throws jakarta.xml.bind.JAXBException
      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.

      Type Parameters:
      T - the type of the Java content tree.
      Parameters:
      is - the InputStream to unmarshal JSON data from.
      expectedType - the expected type of the Java content tree.
      Returns:
      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 XmlRootElement) or mapped to an XML type (for example, annotated with XmlType).
      Throws:
      jakarta.xml.bind.JAXBException - if any unexpected errors occur while unmarshalling.
      jakarta.xml.bind.UnmarshalException - if the JsonUnmarshaller is unable to perform the JSON to Java binding.

    • unmarshalFromJSON

      <T> T unmarshalFromJSON(Reader reader, Class<T> expectedType) throws jakarta.xml.bind.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.

      Type Parameters:
      T - the type of the Java content tree.
      Parameters:
      reader - the Reader to unmarshal JSON data from.
      expectedType - the expected type of the Java content tree.
      Returns:
      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 XmlRootElement) or mapped to an XML type (for example, annotated with XmlType).
      Throws:
      jakarta.xml.bind.JAXBException - if any unexpected errors occur while unmarshalling.
      jakarta.xml.bind.UnmarshalException - if the JsonUnmarshaller is unable to perform the JSON to Java binding.

    • unmarshalJAXBElementFromJSON

      <T> jakarta.xml.bind.JAXBElement<T> unmarshalJAXBElementFromJSON(InputStream is, Class<T> declaredType) throws jakarta.xml.bind.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.

      Type Parameters:
      T - the type of the Java content tree.
      Parameters:
      is - the InputStream to unmarshal JSON data from.
      declaredType - a class that is mapped to a XML root element (for example, annotated with XmlRootElement) or mapped to an XML type (for example, annotated with XmlType).
      Returns:
      the newly created root object of the Java content tree, root by a JAXBElement instance.
      Throws:
      jakarta.xml.bind.JAXBException - if any unexpected errors occur while unmarshalling.
      jakarta.xml.bind.UnmarshalException - if the JsonUnmarshaller is unable to perform the JSON to Java binding.

    • unmarshalJAXBElementFromJSON

      <T> jakarta.xml.bind.JAXBElement<T> unmarshalJAXBElementFromJSON(Reader reader, Class<T> declaredType) throws jakarta.xml.bind.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.

      Type Parameters:
      T - the type of the Java content tree.
      Parameters:
      reader - the Reader to unmarshal JSON data from.
      declaredType - a class that is mapped to a XML root element (for example, annotated with XmlRootElement) or mapped to an XML type (for example, annotated with XmlType).
      Returns:
      the newly created root object of the Java content tree, root by a JAXBElement instance.
      Throws:
      jakarta.xml.bind.JAXBException - if any unexpected errors occur while unmarshalling.
      jakarta.xml.bind.UnmarshalException - if the JsonUnmarshaller is unable to perform the JSON to Java binding.