Package org.apache.juneau.marshall.parser

Class ParserPipe

java.lang.Object
org.apache.juneau.marshall.parser.ParserPipe
All Implemented Interfaces:
Closeable, AutoCloseable
public class ParserPipe extends Object implements Closeable
A wrapper around an object that a parser reads its input from.

For character-based parsers, the input object can be any of the following:

For stream-based parsers, the input object can be any of the following:

Note that Readers and InputStreams will NOT be automatically closed when close() is called unless the autoCloseStreams setting is enabled.

See Also:

  • Constructor Details

    • ParserPipe

      public ParserPipe(Object input)
      Shortcut constructor, typically for straight string input.

      Equivalent to calling new ParserPipe(input, false, false, false, false, null);

      Parameters:
      input - The input object.
      Can be null (the pipe wraps no data; getReader()/getInputStream() return null).

    • ParserPipe

      public ParserPipe(Object input, boolean debug, boolean autoCloseStreams, boolean unbuffered, BinaryFormat binaryFormat)
      Constructor for stream-based parsers.
      Parameters:
      input - The parser input object.
      Can be null (the pipe wraps no data; getReader()/getInputStream() return null).
      debug - If true, the input contents will be copied locally and accessible via the getInputAsString() method. This allows the contents of the pipe to be accessed when a problem occurs.
      autoCloseStreams - Automatically close InputStreams and Readers when passed in as input.
      unbuffered - If true, we read one character at a time from underlying readers when the readers are expected to be parsed multiple times.
      Otherwise, we read character data into a reusable buffer.
      binaryFormat - The binary format of input strings when converted to bytes.
      Can be null (string input converts to an empty byte array).

    • ParserPipe

      public ParserPipe(Object input, boolean debug, boolean strict, boolean autoCloseStreams, boolean unbuffered, Charset streamCharset)
      Constructor for reader-based parsers.
      Parameters:
      input - The parser input object.
      Can be null (the pipe wraps no data; getReader()/getInputStream() return null).
      debug - If true, the input contents will be copied locally and accessible via the getInputAsString() method. This allows the contents of the pipe to be accessed when a problem occurs.
      strict - If true, sets CodingErrorAction.REPORT on CharsetDecoder.onMalformedInput(CodingErrorAction) and CharsetDecoder.onUnmappableCharacter(CodingErrorAction). Otherwise, sets them to CodingErrorAction.REPLACE.
      autoCloseStreams - Automatically close InputStreams and Readers when passed in as input.
      unbuffered - If true, we read one character at a time from underlying readers when the readers are expected to be parsed multiple times.
      Otherwise, we read character data into a reusable buffer.
      streamCharset - The charset to expect when reading from InputStreams.
      Can be null (defaults to UTF-8).

  • Method Details

    • asString

      public String asString() throws IOException
      Returns the contents of this pipe as a string.
      Returns:
      The contents of this pipe as a string.
      Throws:
      IOException - If thrown from inner reader.

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • getBufferedReader

      public Reader getBufferedReader() throws IOException
      Returns the contents of this pipe as a buffered reader.

      If the reader passed into this pipe is already a buffered reader, that reader will be returned.

      Returns:
      The contents of this pipe as a buffered reader.
      Throws:
      IOException - Thrown by underlying stream.

    • getInputAsString

      public String getInputAsString()
      Returns the input to this parser as a plain string.

      This method only returns a value if Context.Builder#debug() is enabled.

      Returns:
      The input as a string, or null if debug mode not enabled.

    • getInputStream

      public InputStream getInputStream() throws IOException
      Wraps the specified input object inside an input stream.

      Subclasses can override this method to implement their own input streams.

      Returns:
      The input object wrapped in an input stream, or null if the object is null.
      Throws:
      IOException - If object could not be converted to an input stream.

    • getParserReader

      public ParserReader getParserReader() throws IOException
      Converts this pipe into a ParserReader.
      Returns:
      The converted pipe, or null if the input object is null.
      Throws:
      IOException - Thrown by underlying stream.

    • getReader

      public Reader getReader() throws IOException
      Wraps the specified input object inside a reader.

      Subclasses can override this method to implement their own readers.

      Returns:
      The input object wrapped in a Reader, or null if the object is null.
      Throws:
      IOException - If object could not be converted to a reader.

    • isString

      public boolean isString()
      Returns true if the contents passed into this pipe was a CharSequence.
      Returns:
      true if the contents passed into this pipe was a CharSequence.

    • setPositionable

      public void setPositionable(Positionable positionable)
      Sets the ParserReader/ParserInputStream/XmlReader constructed from this pipe.

      Used for gathering the failure position when ParseException is thrown.

      Parameters:
      positionable - The ParserReader/ParserInputStream/XmlReader constructed from this pipe.
      Can be null (the failure position reported on ParseException is Position.UNKNOWN).