org.apache.juneau.plaintext

Class PlainTextParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.parser.Parser

org.apache.juneau.parser.ReaderParser

org.apache.juneau.plaintext.PlainTextParser

public class PlainTextParser
extends ReaderParser

Parsers HTTP plain text request bodies into Group 5 POJOs.

See Group 5 POJOs.

Media types

Handles Accept types: text/plain

Produces Content-Type types: text/plain

Description

Essentially just converts plain text to POJOs via static fromString() or valueOf(), or through constructors that take a single string argument.

Also parses objects using a transform if the object class has an PojoSwap<?,String> transform defined on it.

Field Summary

Fields

Modifier and Type	Field and Description
static PlainTextParser	DEFAULT Default parser, all default settings.

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

PARSER_autoCloseStreams, PARSER_fileCharset, PARSER_inputStreamCharset, 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_excludeProperties, 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_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors

Constructor and Description
PlainTextParser(PropertyStore ps) Constructor.
PlainTextParser(PropertyStore ps, String... consumes) Constructor.

Method Summary

Modifier and Type	Method and Description
PlainTextParserBuilder	builder() Creates a builder from this context object.
static PlainTextParserBuilder	create() Instantiates a new clean-slate PlainTextParserBuilder object.
ReaderParserSession	createSession(ParserSessionArgs args) Create the session object that will be passed in to the parse method.

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

isReaderParser

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

asMap, createDefaultSessionArgs, createSession, getMediaTypes, getPrimaryMediaType, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getExcludeProperties, getImplClassConstructor, getIncludeProperties, hasSameCache, isBean, isNotABean, 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

DEFAULT

public static final PlainTextParser DEFAULT

Default parser, all default settings.

Constructor Detail

PlainTextParser

public PlainTextParser(PropertyStore ps)

Constructor.

Parameters:

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

PlainTextParser

public PlainTextParser(PropertyStore ps,
                       String... consumes)

Constructor.

Parameters:

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

consumes - The media types that this parser consumes.

Can contain meta-characters per the media-type specification of RFC2616/14.1

Method Detail

builder

public PlainTextParserBuilder builder()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

builder in class Parser

Returns:

A new ContextBuilder object.

create

public static PlainTextParserBuilder create()

Instantiates a new clean-slate PlainTextParserBuilder object.

This is equivalent to simply calling new PlainTextParserBuilder().

Note that this method creates a builder initialized to all default settings, whereas builder() copies the settings of the object called on.

Returns:

A new PlainTextParserBuilder object.

createSession

public ReaderParserSession createSession(ParserSessionArgs args)

Description copied from class: Parser

Create the session object that will be passed in to the parse method.

It's up to implementers to decide what the session object looks like, although typically it's going to be a subclass of ParserSession.

Specified by:

createSession in class Parser

Parameters:

args - Runtime arguments.

Returns:

The new session.