ConditionalExecution (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.services.render.filter.ConditionalExecution

Direct Known Subclasses:

AbstractFilter, DefaultRenderTimeMonitor
```
public abstract class ConditionalExecution
extends Object
```
Base class that supports conditions, allowing to configure when the implementor is executed.

Author:

Thomas Draier, Sergiy Shyrkov

Constructor Summary

Constructors
Constructor and Description
`ConditionalExecution()` Initializes an instance of this class.
`ConditionalExecution(AbstractFilter.ExecutionCondition... conditions)` Initializes an instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCondition(AbstractFilter.ExecutionCondition condition)` Adds the specified condition for this filter.
`void`	`addCondition(int index, AbstractFilter.ExecutionCondition condition)` Adds the specified condition for this filter at the specified position.
`boolean`	`areConditionsMatched(RenderContext renderContext, Resource resource)`
`String`	`getConditionsSummary()` Returns a text-based representation of filter conditions.
`void`	`setApplyOnConfigurations(String configurations)` Comma-separated list of resource configuration this filter will be executed for (all others are skipped).
`void`	`setApplyOnEditMode(Boolean applyOnEditMode)` Apply this filter if RenderContext isEditMode method call return true.
`void`	`setApplyOnMainResource(boolean bool)` If set to `true`, the current filter will only be executed on the main resource.
`void`	`setApplyOnModes(String modes)` Comma-separated list of modes this filter will be executed for (all others are skipped).
`void`	`setApplyOnModules(String modules)` Comma-separated list of module names this filter will be executed for (all others are skipped).
`void`	`setApplyOnNodeTypes(String nodeTypes)` Comma-separated list of node type names this filter will be executed for (all others are skipped).
`void`	`setApplyOnSiteTemplateSets(String templateSets)` Comma-separated list of template set names this filter will be executed for (all others are skipped).
`void`	`setApplyOnTemplates(String templates)` Comma-separated list of template names this filter will be executed for (all others are skipped).
`void`	`setApplyOnTemplateTypes(String templateTypes)` Comma-separated list of template type names this filter will be executed for (all others are skipped).
`void`	`setConditions(Set<AbstractFilter.ExecutionCondition> conditions)` Adds specified conditions to the list of filter conditions.
`void`	`setSkipOnAjaxRequest(Boolean skip)`
`void`	`setSkipOnConfiguration(String configurations)` Deprecated.
`void`	`setSkipOnConfigurations(String configurations)` Comma-separated list of configuration names this filter won't be executed for.
`void`	`setSkipOnEditMode(Boolean skipOnEditMode)` Skip this filter if RenderContext isEditMode method call return false.
`void`	`setSkipOnMainResource(boolean bool)` If set to `true`, the current filter won't be executed on main resources.
`void`	`setSkipOnModes(String modes)` Comma-separated list of mode names this filter won't be executed for.
`void`	`setSkipOnModules(String modules)` Comma-separated list of module names this filter won't be executed for.
`void`	`setSkipOnNodeTypes(String nodeTypes)` Comma-separated list of node type names this filter won't be executed for.
`void`	`setSkipOnTemplates(String templates)` Comma-separated list of template names this filter won't be executed for.
`void`	`setSkipOnTemplateTypes(String templateTypes)` Comma-separated list of template type names this filter won't be executed for.
`void`	`setSkipOnWebflowRequest(Boolean skipOnWebflowRequest)` Skip this filter if the render chain is processing a Webflow request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConditionalExecution
```
public ConditionalExecution()
```
    Initializes an instance of this class.
  - ConditionalExecution
```
public ConditionalExecution(AbstractFilter.ExecutionCondition... conditions)
```
    Initializes an instance of this class.
    
    Parameters:
    
    conditions - the execution conditions to be matched.
- Method Detail
  - addCondition
```
public void addCondition(AbstractFilter.ExecutionCondition condition)
```
    Adds the specified condition for this filter.
    
    Parameters:
    
    condition - the condition to be added for this filter
  - addCondition
```
public void addCondition(int index,
                         AbstractFilter.ExecutionCondition condition)
```
    Adds the specified condition for this filter at the specified position.
    
    Parameters:
    
    condition - the condition to be added for this filter
  - areConditionsMatched
```
public boolean areConditionsMatched(RenderContext renderContext,
                                    Resource resource)
```
  - getConditionsSummary
```
public String getConditionsSummary()
```
    Returns a text-based representation of filter conditions.
    
    Returns:
    
    a text-based representation of filter conditions
  - setApplyOnConfigurations
```
public void setApplyOnConfigurations(String configurations)
```
    Comma-separated list of resource configuration this filter will be executed for (all others are skipped).
    
    Parameters:
    
    configurations - comma-separated list of configurations this filter will be executed for (all others are skipped)
  - setApplyOnMainResource
```
public void setApplyOnMainResource(boolean bool)
```
    If set to true, the current filter will only be executed on the main resource.
    
    Parameters:
    
    bool - set to true to limit filter execution for main resource only.
  - setApplyOnModes
```
public void setApplyOnModes(String modes)
```
    Comma-separated list of modes this filter will be executed for (all others are skipped).
    
    Parameters:
    
    modes - comma-separated list of modes this filter will be executed for (all others are skipped)
  - setApplyOnEditMode
```
public void setApplyOnEditMode(Boolean applyOnEditMode)
```
    Apply this filter if RenderContext isEditMode method call return true.
    
    Parameters:
    
    applyOnEditMode - true to apply this configuration
  - setApplyOnModules
```
public void setApplyOnModules(String modules)
```
    Comma-separated list of module names this filter will be executed for (all others are skipped).
    
    Parameters:
    
    modules - comma-separated list of module names this filter will be executed for (all others are skipped)
  - setApplyOnNodeTypes
```
public void setApplyOnNodeTypes(String nodeTypes)
```
    Comma-separated list of node type names this filter will be executed for (all others are skipped).
    
    Parameters:
    
    nodeTypes - comma-separated list of node type names this filter will be executed for (all others are skipped)
  - setApplyOnTemplates
```
public void setApplyOnTemplates(String templates)
```
    Comma-separated list of template names this filter will be executed for (all others are skipped).
    
    Parameters:
    
    templates - comma-separated list of template names this filter will be executed for (all others are skipped)
  - setApplyOnTemplateTypes
```
public void setApplyOnTemplateTypes(String templateTypes)
```
    Comma-separated list of template type names this filter will be executed for (all others are skipped).
    
    Parameters:
    
    templateTypes - comma-separated list of template type names this filter will be executed for (all others are skipped)
  - setApplyOnSiteTemplateSets
```
public void setApplyOnSiteTemplateSets(String templateSets)
```
    Comma-separated list of template set names this filter will be executed for (all others are skipped).
    
    Parameters:
    
    templateSets - comma-separated list of template type names this filter will be executed for (all others are skipped)
    
    Since:
    
    6.6.1.0
  - setConditions
```
public void setConditions(Set<AbstractFilter.ExecutionCondition> conditions)
```
    Adds specified conditions to the list of filter conditions. N.B. this operation does not reset the list of conditions, but rather appends specified list to the current one.
    
    Parameters:
    
    conditions - list of conditions to be added for this filter
  - setSkipOnAjaxRequest
```
public void setSkipOnAjaxRequest(Boolean skip)
```
  - setSkipOnConfiguration
```
@Deprecated
public void setSkipOnConfiguration(String configurations)
```
    Deprecated.
  - setSkipOnConfigurations
```
public void setSkipOnConfigurations(String configurations)
```
    Comma-separated list of configuration names this filter won't be executed for.
    
    Parameters:
    
    configurations - comma-separated list of node type names this filter won't be executed for
  - setSkipOnMainResource
```
public void setSkipOnMainResource(boolean bool)
```
    If set to true, the current filter won't be executed on main resources.
    
    Parameters:
    
    bool - set to true to prevent filter from executing on main module
  - setSkipOnModes
```
public void setSkipOnModes(String modes)
```
    Comma-separated list of mode names this filter won't be executed for.
    
    Parameters:
    
    modes - comma-separated list of node type names this filter won't be executed for
  - setSkipOnEditMode
```
public void setSkipOnEditMode(Boolean skipOnEditMode)
```
    Skip this filter if RenderContext isEditMode method call return false.
    
    Parameters:
    
    skipOnEditMode - true to apply this configuration
  - setSkipOnModules
```
public void setSkipOnModules(String modules)
```
    Comma-separated list of module names this filter won't be executed for.
    
    Parameters:
    
    modules - comma-separated list of module names this filter won't be executed for
  - setSkipOnNodeTypes
```
public void setSkipOnNodeTypes(String nodeTypes)
```
    Comma-separated list of node type names this filter won't be executed for.
    
    Parameters:
    
    nodeTypes - comma-separated list of node type names this filter won't be executed for
  - setSkipOnTemplates
```
public void setSkipOnTemplates(String templates)
```
    Comma-separated list of template names this filter won't be executed for.
    
    Parameters:
    
    templates - comma-separated list of template names this filter won't be executed for
  - setSkipOnTemplateTypes
```
public void setSkipOnTemplateTypes(String templateTypes)
```
    Comma-separated list of template type names this filter won't be executed for.
    
    Parameters:
    
    templateTypes - comma-separated list of template type names this filter won't be executed for
  - setSkipOnWebflowRequest
```
public void setSkipOnWebflowRequest(Boolean skipOnWebflowRequest)
```
    Skip this filter if the render chain is processing a Webflow request.
    
    Parameters:
    
    skipOnWebflowRequest - true to apply this configuration

Class ConditionalExecution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConditionalExecution

ConditionalExecution

Method Detail

addCondition

addCondition

areConditionsMatched

getConditionsSummary

setApplyOnConfigurations

setApplyOnMainResource

setApplyOnModes

setApplyOnEditMode

setApplyOnModules

setApplyOnNodeTypes

setApplyOnTemplates

setApplyOnTemplateTypes

setApplyOnSiteTemplateSets

setConditions

setSkipOnAjaxRequest

setSkipOnConfiguration

setSkipOnConfigurations

setSkipOnMainResource

setSkipOnModes

setSkipOnEditMode

setSkipOnModules

setSkipOnNodeTypes

setSkipOnTemplates

setSkipOnTemplateTypes

setSkipOnWebflowRequest