CleanFilter (JCMS API)

All Known Implementing Classes:

CustomCleanFilter, JcmsCleanFilter
```
public interface CleanFilter
```
This interface must be implemented to define cleaning rules.

Since:

jcms-5.5.0

Version:

$Revision: 21412 $

Author:

Olivier Dedieu

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String REVISION

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cleanMergeMap(java.util.Map<java.lang.String,java.util.TreeSet<Stamp>> mergeMap)`	This method is called to clean the merge map.
`boolean`	`isCleanable(InnerLogEntry entry)`	Returns true if the entry can be cleaned or false otherwise.
`boolean`	`isCleanable(StorableLogEntry entry, java.lang.Class<?> clazz)`	Returns true if the entry can be cleaned or false otherwise.

- Field Detail
  - REVISION
```
static final java.lang.String REVISION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - isCleanable
```
boolean isCleanable(StorableLogEntry entry,
                    java.lang.Class<?> clazz)
```
    Returns true if the entry can be cleaned or false otherwise.
    
    Parameters:
    
    entry - the entry to be checked
    
    clazz - the class of which this entry is applied
    
    Returns:
    
    true if the entry can be cleaned or false otherwise
    
    Since:
    
    jcms-5.5.0
  - isCleanable
```
boolean isCleanable(InnerLogEntry entry)
```
    Returns true if the entry can be cleaned or false otherwise.
    
    Parameters:
    
    entry - the entry to be checked
    
    Returns:
    
    true if the entry can be cleaned or false otherwise
    
    Since:
    
    jcms-5.5.0
  - cleanMergeMap
```
void cleanMergeMap(java.util.Map<java.lang.String,java.util.TreeSet<Stamp>> mergeMap)
```
    This method is called to clean the merge map.
    
    Parameters:
    
    mergeMap - the merge map
    
    Since:
    
    jcms-5.5.0