Package edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core

Class TokenStreamFactory

java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.TokenStreamFactory
All Implemented Interfaces:
Versioned, Serializable
Direct Known Subclasses:
JsonFactory
public abstract class TokenStreamFactory extends Object implements Versioned, Serializable
Intermediate base class for actual format-specific factories for constructing parsers (reading) and generators (writing). Although full power will only be available with Jackson 3, skeletal implementation added in 2.10 to help conversion of code for 2.x to 3.x migration of projects depending on Jackson
Since:
2.10
See Also:

  • Constructor Details

    • TokenStreamFactory

      public TokenStreamFactory()

  • Method Details

    • requiresPropertyOrdering

      public abstract boolean requiresPropertyOrdering()
      Introspection method that higher-level functionality may call to see whether underlying data format requires a stable ordering of object properties or not. This is usually used for determining whether to force a stable ordering (like alphabetic ordering by name) if no ordering if explicitly specified.

      Default implementation returns false as JSON does NOT require stable ordering. Formats that require ordering include positional textual formats like CSV, and schema-based binary formats like Avro.

      Returns:
      Whether format supported by this factory requires Object properties to be ordered.

    • canHandleBinaryNatively

      public abstract boolean canHandleBinaryNatively()
      Introspection method that higher-level functionality may call to see whether underlying data format can read and write binary data natively; that is, embeded it as-is without using encodings such as Base64.

      Default implementation returns false as JSON does not support native access: all binary content must use Base64 encoding. Most binary formats (like Smile and Avro) support native binary content.

      Returns:
      Whether format supported by this factory supports native binary content

    • canParseAsync

      public abstract boolean canParseAsync()
      Introspection method that can be used to check whether this factory can create non-blocking parsers: parsers that do not use blocking I/O abstractions but instead use a NonBlockingInputFeeder.
      Returns:
      Whether this factory supports non-blocking ("async") parsing or not (and consequently whether createNonBlockingXxx() method(s) work)

    • getFormatReadFeatureType

      public abstract Class<? extends FormatFeature> getFormatReadFeatureType()
      Method for accessing kind of FormatFeature that a parser JsonParser produced by this factory would accept, if any; null returned if none.
      Returns:
      Type of format-specific stream read features, if any; null if none
      Since:
      2.6

    • getFormatWriteFeatureType

      public abstract Class<? extends FormatFeature> getFormatWriteFeatureType()
      Method for accessing kind of FormatFeature that a parser JsonGenerator produced by this factory would accept, if any; null returned if none.
      Returns:
      Type of format-specific stream read features, if any; null if none
      Since:
      2.6

    • canUseSchema

      public abstract boolean canUseSchema(FormatSchema schema)
      Method that can be used to quickly check whether given schema is something that parsers and/or generators constructed by this factory could use. Note that this means possible use, at the level of data format (i.e. schema is for same data format as parsers and generators this factory constructs); individual schema instances may have further usage restrictions.
      Parameters:
      schema - Schema instance to check
      Returns:
      Whether parsers and generators constructed by this factory can use specified format schema instance
      Since:
      2.1

    • getFormatName

      public abstract String getFormatName()
      Method that returns short textual id identifying format this factory supports.
      Returns:
      Name of the format handled by parsers, generators this factory creates

    • isEnabled

      public abstract boolean isEnabled(JsonParser.Feature f)

    • isEnabled

      public abstract boolean isEnabled(JsonGenerator.Feature f)

    • getParserFeatures

      public abstract int getParserFeatures()

    • getGeneratorFeatures

      public abstract int getGeneratorFeatures()

    • getFormatParserFeatures

      public abstract int getFormatParserFeatures()

    • getFormatGeneratorFeatures

      public abstract int getFormatGeneratorFeatures()

    • createParser

      public abstract JsonParser createParser(byte[] data) throws IOException
      Throws:
      IOException

    • createParser

      public abstract JsonParser createParser(byte[] data, int offset, int len) throws IOException
      Throws:
      IOException

    • createParser

      public abstract JsonParser createParser(char[] content) throws IOException
      Throws:
      IOException

    • createParser

      public abstract JsonParser createParser(char[] content, int offset, int len) throws IOException
      Throws:
      IOException

    • createParser

      public abstract JsonParser createParser(DataInput in) throws IOException
      Throws:
      IOException

    • createParser

      public abstract JsonParser createParser(File f) throws IOException
      Throws:
      IOException

    • createParser

      public abstract JsonParser createParser(InputStream in) throws IOException
      Throws:
      IOException

    • createParser

      public abstract JsonParser createParser(Reader r) throws IOException
      Throws:
      IOException

    • createParser

      public abstract JsonParser createParser(String content) throws IOException
      Throws:
      IOException

    • createParser

      public abstract JsonParser createParser(URL url) throws IOException
      Throws:
      IOException

    • createNonBlockingByteArrayParser

      public abstract JsonParser createNonBlockingByteArrayParser() throws IOException
      Optional method for constructing parser for non-blocking parsing via ByteArrayFeeder interface (accessed using JsonParser.getNonBlockingInputFeeder() from constructed instance).

      If this factory does not support non-blocking parsing (either at all, or from byte array), will throw UnsupportedOperationException.

      Note that JSON-backed factory only supports parsing of UTF-8 encoded JSON content (and US-ASCII since it is proper subset); other encodings are not supported at this point.

      Throws:
      IOException
      Since:
      2.9

    • createNonBlockingByteBufferParser

      public abstract JsonParser createNonBlockingByteBufferParser() throws IOException
      Optional method for constructing parser for non-blocking parsing via ByteBufferFeeder interface (accessed using JsonParser.getNonBlockingInputFeeder() from constructed instance).

      If this factory does not support non-blocking parsing (either at all, or from byte array), will throw UnsupportedOperationException.

      Note that JSON-backed factory only supports parsing of UTF-8 encoded JSON content (and US-ASCII since it is proper subset); other encodings are not supported at this point.

      Throws:
      IOException
      Since:
      2.14

    • createGenerator

      public abstract JsonGenerator createGenerator(DataOutput out, JsonEncoding enc) throws IOException
      Throws:
      IOException

    • createGenerator

      public abstract JsonGenerator createGenerator(DataOutput out) throws IOException
      Throws:
      IOException

    • createGenerator

      public abstract JsonGenerator createGenerator(File f, JsonEncoding enc) throws IOException
      Throws:
      IOException

    • createGenerator

      public abstract JsonGenerator createGenerator(OutputStream out) throws IOException
      Throws:
      IOException

    • createGenerator

      public abstract JsonGenerator createGenerator(OutputStream out, JsonEncoding enc) throws IOException
      Throws:
      IOException

    • createGenerator

      public abstract JsonGenerator createGenerator(Writer w) throws IOException
      Throws:
      IOException

    • _createDataOutputWrapper

      protected OutputStream _createDataOutputWrapper(DataOutput out)

    • _optimizedStreamFromURL

      protected InputStream _optimizedStreamFromURL(URL url) throws IOException
      Helper method used for constructing an optimal stream for parsers to use, when input is to be read from an URL. This helps when reading file content via URL.
      Parameters:
      url - Source to read content to parse from
      Returns:
      InputStream constructed for given URL
      Throws:
      IOException - If there is a problem accessing content from specified URL

    • _fileInputStream

      protected InputStream _fileInputStream(File f) throws IOException
      Helper methods used for constructing an InputStream for parsers to use, when input is to be read from given File.
      Parameters:
      f - File to open stream for
      Returns:
      InputStream constructed
      Throws:
      IOException - If there is a problem opening the stream
      Since:
      2.14

    • _fileOutputStream

      protected OutputStream _fileOutputStream(File f) throws IOException
      Helper methods used for constructing an OutputStream for generator to use, when target is to be written into given File.
      Parameters:
      f - File to open stream for
      Returns:
      OutputStream constructed
      Throws:
      IOException - If there is a problem opening the stream
      Since:
      2.14

    • _checkRangeBoundsForByteArray

      protected void _checkRangeBoundsForByteArray(byte[] data, int offset, int len) throws IllegalArgumentException
      Throws:
      IllegalArgumentException

    • _checkRangeBoundsForCharArray

      protected void _checkRangeBoundsForCharArray(char[] data, int offset, int len) throws IOException
      Throws:
      IOException

    • _reportRangeError

      protected <T> T _reportRangeError(String msg) throws IllegalArgumentException
      Throws:
      IllegalArgumentException