org.glassfish.jersey.message.filtering.spi

Class AbstractEntityProcessor

java.lang.Object

org.glassfish.jersey.message.filtering.spi.AbstractEntityProcessor

All Implemented Interfaces:

EntityProcessor

Direct Known Subclasses:

SelectableEntityProcessor

public abstract class AbstractEntityProcessor
extends Object
implements EntityProcessor

Common entity processor supposed to be used as a base class for custom implementations. Provides convenient methods for adding entity-filtering scopes to entity graph as well as a common implementation of process(org.glassfish.jersey.message.filtering.spi.EntityProcessorContext).

Author:

Michal Gajdos

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.jersey.message.filtering.spi.EntityProcessor

EntityProcessor.Result

Constructor Summary

Constructors

Constructor and Description
AbstractEntityProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	addFilteringScopes(String field, Class<?> fieldClass, Set<String> filteringScopes, EntityGraph graph) Add entity-filtering scopes of a field to an entity-graph.
protected void	addGlobalScopes(Set<String> filteringScopes, EntityGraph graph) Add entity-filtering scopes into given graph.
EntityProcessor.Result	process(EntityProcessorContext context) Process given (class/property/accessor) context by modifying provided EntityGraph.
protected EntityProcessor.Result	process(String fieldName, Class<?> fieldClass, Annotation[] fieldAnnotations, Annotation[] annotations, EntityGraph graph) Method is called from the default implementation of process(org.glassfish.jersey.message.filtering.spi.EntityProcessorContext) and is supposed to be overridden by custom implementations of this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractEntityProcessor

public AbstractEntityProcessor()

Method Detail

process

public EntityProcessor.Result process(EntityProcessorContext context)

Description copied from interface: EntityProcessor

Process given (class/property/accessor) context by modifying provided EntityGraph.

Specified by:

process in interface EntityProcessor

Parameters:

context - context to be processed.

Returns:

result of processing a context.

process

protected EntityProcessor.Result process(String fieldName,
                                         Class<?> fieldClass,
                                         Annotation[] fieldAnnotations,
                                         Annotation[] annotations,
                                         EntityGraph graph)

Method is called from the default implementation of process(org.glassfish.jersey.message.filtering.spi.EntityProcessorContext) and is supposed to be overridden by custom implementations of this class.

Parameters:

fieldName - name of the field (can be null).

fieldClass - class of the field (can be null).

fieldAnnotations - annotations associated with the field (cannot be null).

annotations - annotations associated with class/accessor (cannot be null).

graph - entity graph to be processed.

Returns:

result of the processing (default is Result#SKIP).

addFilteringScopes

protected final void addFilteringScopes(String field,
                                        Class<?> fieldClass,
                                        Set<String> filteringScopes,
                                        EntityGraph graph)

Add entity-filtering scopes of a field to an entity-graph. The method determines whether the field should be added as a simple field or a subgraph.

Parameters:

field - name of a field to be added to the graph.

fieldClass - class of the field.

filteringScopes - entity-filtering scopes the field will be associated with in the graph.

graph - entity graph the field will be added to.

addGlobalScopes

protected final void addGlobalScopes(Set<String> filteringScopes,
                                     EntityGraph graph)

Add entity-filtering scopes into given graph. This method should be called only in class-level context.

Parameters:

filteringScopes - entity-filtering scopes to be added to graph.

graph - entity graph to be enhanced by new scopes.