Package org.apache.juneau.parser

Class InputStreamParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.parser.Parser

org.apache.juneau.parser.InputStreamParser

All Implemented Interfaces:

AnnotationProvider

Direct Known Subclasses:

ImageParser, MsgPackParser

public class InputStreamParser
extends Parser

Subclass of Parser for byte-based parsers.

Description

This class is typically the parent class of all character-based parsers. It has 1 abstract method to implement on the session object...

• parse(ParserSession, ClassMeta)

Notes:

• This class is thread safe and reusable.

See Also:

• Serializers and Parsers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InputStreamParser.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.parser.Parser

Parser.Null

Field Summary

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider

DEFAULT, DISABLE_ANNOTATION_CACHING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InputStreamParser(InputStreamParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static InputStreamParser.Builder	create()	Creates a new builder for this object.
InputStreamParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
protected final BinaryFormat	getBinaryFormat()	Binary input format.
InputStreamParserSession	getSession()	Returns a session to use for this context.
final boolean	isReaderParser()	Returns true if this parser subclasses from ReaderParser.
protected JsonMap	properties()	Returns the properties on this bean as a map for debugging.

Methods inherited from class org.apache.juneau.parser.Parser

canHandle, copy, createParserBuilder, doParse, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, init, isDebug, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation, toString

Methods inherited from class java.lang.Object

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

Constructor Details

InputStreamParser

protected InputStreamParser(InputStreamParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static InputStreamParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

isReaderParser

public final boolean isReaderParser()

Description copied from class: Parser

Returns true if this parser subclasses from ReaderParser.

Overrides:

isReaderParser in class Parser

Returns:

true if this parser subclasses from ReaderParser.

createSession

public InputStreamParserSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class Parser

Returns:

A new session builder.

getSession

public InputStreamParserSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class Parser

Returns:

A new session object.

getBinaryFormat

protected final BinaryFormat getBinaryFormat()

Binary input format.

Returns:

The format to use when converting strings to byte arrays.

See Also:

• InputStreamParser.Builder.binaryFormat(BinaryFormat)

properties

protected JsonMap properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class Parser

Returns:

The properties on this bean as a map for debugging.