org.apache.juneau.parser

Class ReaderParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.parser.Parser

org.apache.juneau.parser.ReaderParser

Direct Known Subclasses:

CsvParser, JsonParser, PlainTextParser, RdfParser, UonParser, XmlParser

@ConfigurableContext
public abstract class ReaderParser
extends Parser

Subclass of Parser for characters-based parsers.

Description

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

• parse(ParserSession, ClassMeta)

Field Summary

Fields

Modifier and Type	Field and Description
static String	RPARSER_fileCharset Configuration property: File charset.
static String	RPARSER_streamCharset Configuration property: Input stream charset.

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

PARSER_autoCloseStreams, PARSER_debugOutputLines, PARSER_listener, PARSER_strict, PARSER_trimStrings, PARSER_unbuffered

Fields inherited from class org.apache.juneau.BeanContext

BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_debug, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReaderParser(PropertyStore ps, String... consumes) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Charset	getFileCharset() Configuration property: File charset.
protected Charset	getStreamCharset() Configuration property: Input stream charset.
boolean	isReaderParser() Returns true if this parser subclasses from ReaderParser.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

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

builder, canHandle, create, createDefaultSessionArgs, createSession, createSession, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getExamples, getImplClassConstructor, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getTimeZone, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, getStringPropertyWithNone, hashCode, identityCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RPARSER_fileCharset

public static final String RPARSER_fileCharset

Configuration property: File charset.

Property:

• Name: "ReaderParser.fileCharset.s"
• Data type: String
• Default: "DEFAULT"
• Session property: false
• Methods:
  • ReaderParserBuilder.fileCharset(Charset)

Description:

The character set to use for reading Files from the file system.

Used when passing in files to Parser.parse(Object, Class).

"DEFAULT" can be used to indicate the JVM default file system charset.

Example:

// Create a parser that reads UTF-8 files. ReaderParser p = JsonParser. .create() .fileCharset("UTF-8") .build(); // Same, but use property. ReaderParser p = JsonParser. .create() .set(RPARSER_fileCharset, "UTF-8") .build(); // Use it to read a UTF-8 encoded file. MyBean myBean = p.parse(new File("MyBean.txt"), MyBean.class);

See Also:

Constant Field Values

RPARSER_streamCharset

public static final String RPARSER_streamCharset

Configuration property: Input stream charset.

Property:

• Name: "ReaderParser.streamCharset.s"
• Data type: String
• Default: "UTF-8"
• Session property: false
• Methods:
  • ReaderParserBuilder.streamCharset(Charset)

Description:

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

Used when passing in input streams and byte arrays to Parser.parse(Object, Class).

Example:

// Create a parser that reads UTF-8 files. ReaderParser p = JsonParser. .create() .streamCharset(Charset.forName("UTF-8")) .build(); // Same, but use property. ReaderParser p = JsonParser. .create() .set(RPARSER_streamCharset, "UTF-8") .build(); // Use it to read a UTF-8 encoded input stream. MyBean myBean = p.parse(new FileInputStream("MyBean.txt"), MyBean.class);

See Also:

Constant Field Values

Constructor Detail

ReaderParser

protected ReaderParser(PropertyStore ps,
                       String... consumes)

Constructor.

Parameters:

ps - The property store containing all the settings for this object.

consumes - The list of media types that this parser consumes (e.g. "application/json", "*/json").

Method Detail

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.

getFileCharset

protected final Charset getFileCharset()

Configuration property: File charset.

Returns:

The character set to use for reading Files from the file system.

See Also:

RPARSER_fileCharset

getStreamCharset

protected final Charset getStreamCharset()

Configuration property: Input stream charset.

Returns:

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

See Also:

RPARSER_streamCharset

toMap

public ObjectMap toMap()

Description copied from class: Context

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

toMap in class Parser

Returns:

A new map containing the properties defined on this context.