Package org.apache.juneau.marshall.parser

Class ReaderParser

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.parser.Parser

org.apache.juneau.marshall.parser.ReaderParser

Direct Known Subclasses:

CsvParser, HjsonParser, HoconParser, IniParser, JsonParser, MarkdownParser, PlainTextParser, RdfParser, SseParser, TomlParser, UonParser, XmlParser, YamlParser

public class ReaderParser
extends Parser

Subclass of Parser for character-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...

• ParserSession.doRead(ParserPipe, 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	ReaderParser.Builder<SELF extends ReaderParser.Builder<SELF>>	Builder class.
static final class	ReaderParser.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() / Parser.copy() path.

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

Parser.Null

Field Summary

Fields inherited from class org.apache.juneau.marshall.parser.Parser

autoCloseStreams, consumes, debugOutputLines, listener, nulls, trimStrings, unbuffered

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReaderParser(ReaderParser.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static ReaderParser.Builder<?>	create()	Creates a new builder for this object.
ReaderParserSession.Builder<?>	createSession()	Create a session builder based on the properties defined on this context.
ReaderParserSession	getSession()	Returns a session to use for this context.
protected final Charset	getStreamCharset()	Input stream charset.
final boolean	isReaderParser()	Returns true if this parser subclasses from ReaderParser.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.

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

canHandle, copy, createParserBuilder, doRead, getDebugOutputLines, getListener, getMediaTypes, getNulls, getPrimaryMediaType, isAutoCloseStreams, isTrimStrings, isUnbuffered, read, read, read, read, read, read, readArgs, readIntoCollection, readIntoMap, readWithOuter

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ReaderParser

protected ReaderParser(ReaderParser.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.
Cannot be null.

Method Details

create

public static ReaderParser.Builder<?> create()

Creates a new builder for this object.

Returns:

A new builder.

createSession

public ReaderParserSession.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 ReaderParserSession 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.

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.

getStreamCharset

protected final Charset getStreamCharset()

Input stream charset.

Returns:

The character set to use for converting InputStreams and byte arrays to readers.

See Also:

• ReaderParser.Builder.streamCharset(Charset)

properties

protected FluentMap<String,Object> 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.