Package org.craftercms.core.processors.impl

Class SkipAllItemProcessor

java.lang.Object

org.craftercms.core.processors.impl.SkipAllItemProcessor

All Implemented Interfaces:

ItemProcessor

public class SkipAllItemProcessor
extends Object
implements ItemProcessor

No-op ItemProcessor exclusive implementation. This processor does nothing but return the item, a NOOP. It is also exclusive, so if passed into getItem, it will disable the processor chain and simply return the item as-is.

Since:

4.1.2

Constructor Summary

Constructors

Constructor	Description
SkipAllItemProcessor()

Method Summary

Modifier and Type	Method	Description
boolean	isExclusive()	When explicitly passing the processor (not in a pipeline), this method indicates whether the processor should be executed exclusively and ignore any other processors.
Item	process(Context context, CachingOptions cachingOptions, Item item)	Processes an Item.

Methods inherited from class java.lang.Object

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

Constructor Details

SkipAllItemProcessor

public SkipAllItemProcessor()

Method Details

isExclusive

public boolean isExclusive()

Description copied from interface: ItemProcessor

When explicitly passing the processor (not in a pipeline), this method indicates whether the processor should be executed exclusively and ignore any other processors.

Specified by:

isExclusive in interface ItemProcessor

Returns:

true if the processor should be executed exclusively, false otherwise.

process

public Item process(Context context,
 CachingOptions cachingOptions,
 Item item)
             throws ItemProcessingException

Description copied from interface: ItemProcessor

Processes an Item.

Specified by:

process in interface ItemProcessor

Parameters:

context - the current context

cachingOptions - caching options in case you need access to items

item - the item to process

Returns:

the modified item or a new item.

Throws:

ItemProcessingException - if an error occurred while processing the item