org.apache.juneau.parser

Class ParserGroup

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.parser.ParserGroup

@ConfigurableContext(nocache=true)
public final class ParserGroup
extends BeanContext

Represents a group of Parsers that can be looked up by media type.

Description

Provides the following features:

• Finds parsers based on HTTP Content-Type header values.
• Sets common properties on all parsers in a single method call.
• Locks all parsers in a single method call.
• Clones existing groups and all parsers within the group in a single method call.

Match ordering

Parsers are matched against Content-Type strings in the order they exist in this group.

Adding new entries will cause the entries to be prepended to the group. This allows for previous parsers to be overridden through subsequent calls.

For example, calling g.append(P1.class,P2.class).append(P3.class,P4.class) will result in the order P3, P4, P1, P2.

Example:

// Construct a new parser group builder ParserGroupBuilder b = ParserGroup.create(); // Add some parsers to it b.append(JsonParser.class, XmlParser.class); // Change settings on parsers simultaneously b.set(BeanContext.BEAN_beansRequireSerializable, true) .pojoSwaps(TemporalCalendarSwap.IsoLocalDateTime.class); ParserGroup g = b.build(); // Find the appropriate parser by Content-Type ReaderParser p = (ReaderParser)g.getParser("text/json"); // Parse a bean from JSON String json = "{...}"; AddressBook addressBook = p.parse(json, AddressBook.class);

Field Summary

Fields

Modifier and Type	Field and Description
static ParserGroup	EMPTY An unmodifiable empty parser group.

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, DEFAULT_SORTED

Constructor Summary

Constructors

Constructor and Description
ParserGroup(PropertyStore ps, Parser[] parsers) Constructor.

Method Summary

Modifier and Type	Method and Description
ParserGroupBuilder	builder() Returns a builder that's a copy of the settings on this parser group.
static ParserGroupBuilder	create() Instantiates a new clean-slate ParserGroupBuilder object.
Parser	getParser(MediaType mediaType) Same as getParserMatch(MediaType) but returns just the matched parser.
Parser	getParser(String contentTypeHeader) Same as getParserMatch(String) but returns just the matched parser.
ParserMatch	getParserMatch(MediaType mediaType) Same as getParserMatch(String) but matches using a MediaType instance.
ParserMatch	getParserMatch(String contentTypeHeader) Searches the group for a parser that can handle the specified Content-Type header value.
List<Parser>	getParsers() Returns the parsers in this group.
List<MediaType>	getSupportedMediaTypes() Returns the media types that all parsers in this group can handle

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createDefaultSessionArgs, createSession, 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, toMap

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

EMPTY

public static final ParserGroup EMPTY

An unmodifiable empty parser group.

Constructor Detail

ParserGroup

public ParserGroup(PropertyStore ps,
                   Parser[] parsers)

Constructor.

Parameters:

ps - The modifiable properties that were used to initialize the parsers. A snapshot of these will be made so that we can clone and modify this group.

parsers - The parsers defined in this group. The order is important because they will be tried in reverse order (e.g. newer first) in which they will be tried to match against media types.

Method Detail

create

public static ParserGroupBuilder create()

Instantiates a new clean-slate ParserGroupBuilder object.

This is equivalent to simply calling new ParserGroupBuilder().

Returns:

A new ParserGroupBuilder object.

builder

public ParserGroupBuilder builder()

Returns a builder that's a copy of the settings on this parser group.

Overrides:

builder in class BeanContext

Returns:

A new ParserGroupBuilder initialized to this group.

getParserMatch

public ParserMatch getParserMatch(String contentTypeHeader)

Searches the group for a parser that can handle the specified Content-Type header value.

The returned object includes both the parser and media type that matched.

Parameters:

contentTypeHeader - The HTTP Content-Type header value.

Returns:

The parser and media type that matched the content type header, or null if no match was made.

getParserMatch

public ParserMatch getParserMatch(MediaType mediaType)

Same as getParserMatch(String) but matches using a MediaType instance.

Parameters:

mediaType - The HTTP Content-Type header value as a media type.

Returns:

The parser and media type that matched the media type, or null if no match was made.

getParser

public Parser getParser(String contentTypeHeader)

Same as getParserMatch(String) but returns just the matched parser.

Parameters:

contentTypeHeader - The HTTP Content-Type header string.

Returns:

The parser that matched the content type header, or null if no match was made.

getParser

public Parser getParser(MediaType mediaType)

Same as getParserMatch(MediaType) but returns just the matched parser.

Parameters:

mediaType - The HTTP media type.

Returns:

The parser that matched the media type, or null if no match was made.

getSupportedMediaTypes

public List<MediaType> getSupportedMediaTypes()

Returns the media types that all parsers in this group can handle

Entries are ordered in the same order as the parsers in the group.

Returns:

An unmodifiable list of media types.

getParsers

public List<Parser> getParsers()

Returns the parsers in this group.

Returns:

An unmodifiable list of parsers in this group.