Package javax.json

Interface JsonReaderFactory


  • public interface JsonReaderFactory
    Factory to create JsonReader instances. If a factory instance is configured with some configuration, that would be used to configure the created reader instances.

    This is a near-exact copy of the same-titled Java EE 8 Class: javax.json.JsonReaderFactory
    Commenting has been slightly modified to accompany HiLiting the Code Examples.
    Java Source Code remains identical to the Sun-Oracle & 'GlassFish' Released Distributions.

    Read included License: HERE, and the CDDL+GPL-1.1
    All javax.json.* Code Obtained From: GitHub JavaEE jsonp  Public Archive.


    JsonReader can also be created using Json's createReader methods. If multiple reader instances are created, then creating them using a reader factory is preferred.

    Example:
     JsonReaderFactory    factory = Json.createReaderFactory(...);
     JsonReader           reader1 = factory.createReader(...);
     JsonReader           reader2 = factory.createReader(...);
    

    All the methods in this class are safe for use by multiple concurrent threads.


    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      JsonReader createReader​(InputStream in)
      Creates a JSON reader from a byte stream.
      JsonReader createReader​(InputStream in, java.nio.charset.Charset charset)
      Creates a JSON reader from a byte stream.
      JsonReader createReader​(Reader reader)
      Creates a JSON reader from a character stream.
      Map<String,​?> getConfigInUse()
      Returns read-only map of supported provider specific configuration properties that are used to configure the created JSON readers.
    • Method Detail

      • createReader

        🡇     🗕  🗗  🗖
        JsonReader createReader​(java.io.Reader reader)
        Creates a JSON reader from a character stream. The reader is configured with the factory configuration.
        Parameters:
        reader - a reader from which JSON is to be read
        Returns:
        a JSON reader
      • createReader

        🡅  🡇     🗕  🗗  🗖
        JsonReader createReader​(java.io.InputStream in)
        Creates a JSON reader from a byte stream. The character encoding of the stream is determined as described in RFC 7159. The reader is configured with the factory configuration.
        Parameters:
        in - a byte stream from which JSON is to be read
        Returns:
        a JSON reader
      • createReader

        🡅  🡇     🗕  🗗  🗖
        JsonReader createReader​(java.io.InputStream in,
                                java.nio.charset.Charset charset)
        Creates a JSON reader from a byte stream. The bytes of the stream are decoded to characters using the specified charset. The reader is configured with the factory configuration.
        Parameters:
        in - a byte stream from which JSON is to be read
        charset - a charset
        Returns:
        a JSON reader
      • getConfigInUse

        🡅     🗕  🗗  🗖
        java.util.Map<java.lang.String,​?> getConfigInUse()
        Returns read-only map of supported provider specific configuration properties that are used to configure the created JSON readers. If there are any specified configuration properties that are not supported by the provider, they won't be part of the returned map.
        Returns:
        a map of supported provider specific properties that are used to configure the readers. The map be empty but not null.