org.apache.juneau.parser

Class InputStreamParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.parser.Parser

org.apache.juneau.parser.InputStreamParser

Direct Known Subclasses:

JsoParser, MsgPackParser

public abstract class InputStreamParser
extends Parser

Subclass of Parser for byte-based parsers.

Description

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

• parse(InputStream, ClassMeta, Parser)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ISPARSER_binaryFormat Configuration property: Binary input format.

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_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	InputStreamParser(PropertyStore ps, String... consumes) Constructor.

Method Summary

Modifier and Type	Method and Description
ObjectMap	asMap() Returns the properties defined on this bean context as a simple map for debugging purposes.
protected BinaryFormat	getBinaryFormat() Configuration property: Binary input format.
boolean	isReaderParser() Returns true if this parser subclasses from ReaderParser.

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

builder, canHandle, create, createDefaultSessionArgs, createSession, createSession, getDebugOutputLines, getListenerClass, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, 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, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getExcludeProperties, getImplClassConstructor, getIncludeProperties, getLocale, getMediaType, getPropertyNamer, getTimeZone, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newInstance, newInstance, newInstanceFromOuter, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, 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, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

ISPARSER_binaryFormat

public static final String ISPARSER_binaryFormat

Configuration property: Binary input format.

Property:

• Name: "InputStreamParser.binaryFormat.s"
• Data type: BinaryFormat
• Default: BinaryFormat.HEX
• Session property: false
• Methods:
  • InputStreamParserBuilder.binaryFormat(BinaryFormat)

Description:

When using the Parser.parse(Object,Class) method on stream-based parsers and the input is a string, this defines the format to use when converting the string into a byte array.

Example:

// Create a parser that parses from BASE64. InputStreamParser p = MsgPackParser .create() .binaryFormat(BASE64) .build(); // Same, but use property. InputStreamParser p = MsgPackParser .create() .set(ISPARSER_binaryFormat, "BASE64") .build();

See Also:

Constant Field Values

Constructor Detail

InputStreamParser

protected InputStreamParser(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").

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.

getBinaryFormat

protected final BinaryFormat getBinaryFormat()

Configuration property: Binary input format.

Returns:

The format to use when converting strings to byte arrays.

See Also:

ISPARSER_binaryFormat

asMap

public ObjectMap asMap()

Description copied from class: Context

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

Overrides:

asMap in class Parser

Returns:

A new map containing the properties defined on this context.