SerializerGroup (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.Context
- - org.apache.juneau.BeanContext
  - - org.apache.juneau.serializer.SerializerGroup

```
public final class SerializerGroup
extends BeanContext
```
Represents a group of Serializers that can be looked up by media type.
Description
Provides the following features:
- Finds serializers based on HTTP Accept header values.
- Sets common properties on all serializers in a single method call.
- Clones existing groups and all serializers within the group in a single method call.
Match ordering
Serializers are matched against Accept 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 serializers to be overridden through subsequent calls.
For example, calling g.append(S1.class,S2.class).append(S3.class,S4.class) will result in the order S3, S4, S1, S2.
Example:

// Construct a new serializer group SerializerGroup g = SerializerGroup.create(); .append(JsonSerializer.class, XmlSerializer.class); // Add some serializers to it .ws().pojoSwaps(CalendarSwap.ISO8601DT.class) // Change settings for all serializers in the group. .build(); // Find the appropriate serializer by Accept type WriterSerializer s = g.getWriterSerializer("text/foo, text/json;q=0.8, text/*;q:0.6, *\/*;q=0.0"); // Serialize a bean to JSON text AddressBook addressBook = new AddressBook(); // Bean to serialize. String json = s.serialize(addressBook);

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

Constructor Summary

Constructors
Constructor and Description

SerializerGroup(PropertyStore ps, Serializer[] serializers)
Constructor.

Constructors
Constructor and Description
`SerializerGroup(PropertyStore ps, Serializer[] serializers)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SerializerGroupBuilder`	`builder()` Returns a builder that's a copy of the settings on this serializer group.
`static SerializerGroupBuilder`	`create()` Instantiates a new clean-slate `SerializerGroupBuilder` object.
`Serializer`	`getSerializer(MediaType mediaType)` Same as `getSerializerMatch(MediaType)` but returns just the matched serializer.
`Serializer`	`getSerializer(String acceptHeader)` Same as `getSerializerMatch(String)` but returns just the matched serializer.
`SerializerMatch`	`getSerializerMatch(MediaType mediaType)` Same as `getSerializerMatch(String)` but matches using a `MediaType` instance.
`SerializerMatch`	`getSerializerMatch(String acceptHeader)` Searches the group for a serializer that can handle the specified `Accept` value.
`List<Serializer>`	`getSerializers()` Returns a copy of the serializers in this group.
`OutputStreamSerializer`	`getStreamSerializer(MediaType mediaType)` Same as `getSerializer(MediaType)`, but casts it to a `OutputStreamSerializer`.
`OutputStreamSerializer`	`getStreamSerializer(String acceptHeader)` Same as `getSerializer(String)`, but casts it to an `OutputStreamSerializer`.
`List<MediaType>`	`getSupportedMediaTypes()` Returns the media types that all serializers in this group can handle.
`WriterSerializer`	`getWriterSerializer(MediaType mediaType)` Same as `getSerializer(MediaType)`, but casts it to a `WriterSerializer`.
`WriterSerializer`	`getWriterSerializer(String acceptHeader)` Same as `getSerializer(String)`, but casts it to a `WriterSerializer`.

Methods inherited from class org.apache.juneau.BeanContext
_class, asMap, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createDefaultSessionArgs, createSession, 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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SerializerGroup
```
public SerializerGroup(PropertyStore ps,
                       Serializer[] serializers)
```
    Constructor.
    
    Parameters:
    
    ps - The modifiable properties that were used to initialize the serializers. A snapshot of these will be made so that we can clone and modify this group.
    
    serializers - The serializers 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 SerializerGroupBuilder create()
```
    Instantiates a new clean-slate SerializerGroupBuilder object.
    This is equivalent to simply calling new SerializerGroupBuilder().
    
    Returns:
    
    A new SerializerGroupBuilder object.
  - builder
```
public SerializerGroupBuilder builder()
```
    Returns a builder that's a copy of the settings on this serializer group.
    
    Overrides:
    
    builder in class BeanContext
    
    Returns:
    
    A new SerializerGroupBuilder initialized to this group.
  - getSerializerMatch
```
public SerializerMatch getSerializerMatch(String acceptHeader)
```
    Searches the group for a serializer that can handle the specified Accept value.
    The accept value complies with the syntax described in RFC2616, Section 14.1, as described below:
    Accept = "Accept" ":" #( media-range [ accept-params ] ) media-range = ( "*\/*" | ( type "/" "*" ) | ( type "/" subtype ) ) *( ";" parameter ) accept-params = ";" "q" "=" qvalue *( accept-extension ) accept-extension = ";" token [ "=" ( token | quoted-string ) ]
    
    The returned object includes both the serializer and media type that matched.
    
    Parameters:
    
    acceptHeader - The HTTP Accept header string.
    
    Returns:
    
    The serializer and media type that matched the accept header, or null if no match was made.
  - getSerializerMatch
```
public SerializerMatch getSerializerMatch(MediaType mediaType)
```
    Same as getSerializerMatch(String) but matches using a MediaType instance.
    
    Parameters:
    
    mediaType - The HTTP media type.
    
    Returns:
    
    The serializer and media type that matched the media type, or null if no match was made.
  - getSerializer
```
public Serializer getSerializer(String acceptHeader)
```
    Same as getSerializerMatch(String) but returns just the matched serializer.
    
    Parameters:
    
    acceptHeader - The HTTP Accept header string.
    
    Returns:
    
    The serializer that matched the accept header, or null if no match was made.
  - getSerializer
```
public Serializer getSerializer(MediaType mediaType)
```
    Same as getSerializerMatch(MediaType) but returns just the matched serializer.
    
    Parameters:
    
    mediaType - The HTTP media type.
    
    Returns:
    
    The serializer that matched the accept header, or null if no match was made.
  - getWriterSerializer
```
public WriterSerializer getWriterSerializer(String acceptHeader)
```
    Same as getSerializer(String), but casts it to a WriterSerializer.
    
    Parameters:
    
    acceptHeader - The HTTP Accept header string.
    
    Returns:
    
    The serializer that matched the accept header, or null if no match was made.
  - getWriterSerializer
```
public WriterSerializer getWriterSerializer(MediaType mediaType)
```
    Same as getSerializer(MediaType), but casts it to a WriterSerializer.
    
    Parameters:
    
    mediaType - The HTTP media type.
    
    Returns:
    
    The serializer that matched the accept header, or null if no match was made.
  - getStreamSerializer
```
public OutputStreamSerializer getStreamSerializer(String acceptHeader)
```
    Same as getSerializer(String), but casts it to an OutputStreamSerializer.
    
    Parameters:
    
    acceptHeader - The HTTP Accept header string.
    
    Returns:
    
    The serializer that matched the accept header, or null if no match was made.
  - getStreamSerializer
```
public OutputStreamSerializer getStreamSerializer(MediaType mediaType)
```
    Same as getSerializer(MediaType), but casts it to a OutputStreamSerializer.
    
    Parameters:
    
    mediaType - The HTTP media type.
    
    Returns:
    
    The serializer that matched the accept header, or null if no match was made.
  - getSupportedMediaTypes
```
public List<MediaType> getSupportedMediaTypes()
```
    Returns the media types that all serializers in this group can handle.
    Entries are ordered in the same order as the serializers in the group.
    
    Returns:
    
    An unmodifiable list of media types.
  - getSerializers
```
public List<Serializer> getSerializers()
```
    Returns a copy of the serializers in this group.
    
    Returns:
    
    An unmodifiable list of serializers in this group.

Class SerializerGroup

Description

Match ordering

Example:

Field Summary

Fields inherited from class org.apache.juneau.BeanContext

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.BeanContext

Methods inherited from class org.apache.juneau.Context

Methods inherited from class java.lang.Object

Constructor Detail

SerializerGroup

Method Detail

create

builder

getSerializerMatch

getSerializerMatch

getSerializer

getSerializer

getWriterSerializer

getWriterSerializer

getStreamSerializer

getStreamSerializer

getSupportedMediaTypes

getSerializers