Package com.puppycrawl.tools.checkstyle.api

Class BeforeExecutionFileFilterSet

java.lang.Object

com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilterSet

All Implemented Interfaces:

BeforeExecutionFileFilter

public final class BeforeExecutionFileFilterSet
extends Object
implements BeforeExecutionFileFilter

A before execution file filter set applies filters to events. If a before execution file filter in the set rejects an event, then the event is rejected. Otherwise, the event is accepted.

Field Summary

Fields

Modifier and Type	Field	Description
private final Set<BeforeExecutionFileFilter>	beforeExecutionFileFilters	Filter set.

Constructor Summary

Constructors

Constructor	Description
BeforeExecutionFileFilterSet()

Method Summary

Modifier and Type	Method	Description
boolean	accept(String uri)	Determines whether or not a before execution file filtered event is accepted.
void	addBeforeExecutionFileFilter(BeforeExecutionFileFilter filter)	Adds a Filter to the set.
void	clear()	Clears the BeforeExecutionFileFilterSet.
Set<BeforeExecutionFileFilter>	getBeforeExecutionFileFilters()	Returns the Filters of the filter set.
void	removeBeforeExecutionFileFilter(BeforeExecutionFileFilter filter)	Removes filter.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

beforeExecutionFileFilters

private final Set<BeforeExecutionFileFilter> beforeExecutionFileFilters

Filter set.

Constructor Details

BeforeExecutionFileFilterSet

public BeforeExecutionFileFilterSet()

Method Details

addBeforeExecutionFileFilter

public void addBeforeExecutionFileFilter(BeforeExecutionFileFilter filter)

Adds a Filter to the set.

Parameters:

filter - the Filter to add.

removeBeforeExecutionFileFilter

public void removeBeforeExecutionFileFilter(BeforeExecutionFileFilter filter)

Removes filter.

Parameters:

filter - filter to remove.

getBeforeExecutionFileFilters

public Set<BeforeExecutionFileFilter> getBeforeExecutionFileFilters()

Returns the Filters of the filter set.

Returns:

the Filters of the filter set.

toString

public String toString()

Overrides:

toString in class Object

accept

public boolean accept(String uri)

Description copied from interface: BeforeExecutionFileFilter

Determines whether or not a before execution file filtered event is accepted.

Specified by:

accept in interface BeforeExecutionFileFilter

Parameters:

uri - the uri to filter.

Returns:

true if the event is accepted.

clear

public void clear()

Clears the BeforeExecutionFileFilterSet.