org.apache.juneau.parser

Class ParserPipe

java.lang.Object

org.apache.juneau.parser.ParserPipe

All Implemented Interfaces:

Closeable, AutoCloseable

public final 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:

• Reader
• CharSequence
• InputStream
• byte[]
• File
• null

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

• InputStream
• byte[]
• File
• String - Hex-encoded bytes. (not BASE-64!)
• null

Note that Readers and InputStreams will NOT be automatically closed when close() is called, but streams and readers created from other types (e.g. Files) WILL be automatically closed.

Constructor Summary

Constructors

Constructor and Description
ParserPipe(Object input) Shortcut constructor, typically for straight string input.
ParserPipe(Object input, boolean debug, boolean autoCloseStreams, boolean unbuffered, BinaryFormat binaryFormat) Constructor for stream-based parsers.
ParserPipe(Object input, boolean debug, boolean strict, boolean autoCloseStreams, boolean unbuffered, Charset streamCharset, Charset fileCharset) Constructor for reader-based parsers.

Method Summary

Modifier and Type	Method and Description
void	close()
Reader	getBufferedReader() Returns the contents of this pipe as a buffered reader.
String	getInputAsString() Returns the input to this parser as a plain string.
InputStream	getInputStream() Wraps the specified input object inside an input stream.
ParserReader	getParserReader() Converts this pipe into a ParserReader.
Reader	getReader() Wraps the specified input object inside a reader.
boolean	isString() Returns true if the contents passed into this pipe was a CharSequence.
void	setPositionable(Positionable positionable) Sets the ParserReader/ParserInputStream/XmlReader constructed from this pipe.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParserPipe

public ParserPipe(Object input,
                  boolean debug,
                  boolean strict,
                  boolean autoCloseStreams,
                  boolean unbuffered,
                  Charset streamCharset,
                  Charset fileCharset)

Constructor for reader-based parsers.

Parameters:

input - The parser input object.

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.

fileCharset - The charset to expect when reading from Files.

streamCharset - The charset to expect when reading from InputStreams.

ParserPipe

public ParserPipe(Object input,
                  boolean debug,
                  boolean autoCloseStreams,
                  boolean unbuffered,
                  BinaryFormat binaryFormat)

Constructor for stream-based parsers.

Parameters:

input - The parser input object.

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.

ParserPipe

public ParserPipe(Object input)

Shortcut constructor, typically for straight string input.

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

Parameters:

input - The input object.

Method Detail

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.

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.

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 BeanContext.BEAN_debug is enabled.

Returns:

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

getParserReader

public ParserReader getParserReader()
                             throws IOException

Converts this pipe into a ParserReader.

Returns:

The converted pipe.

Throws:

IOException - Thrown by underlying stream.

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.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable