Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.puppycrawl.tools.checkstyle.api
Class FilterSet

    java.lang.Object
      com.puppycrawl.tools.checkstyle.api.FilterSet

All Implemented Interfaces:
  Filter

public class FilterSet
extends java.lang.Object
implements Filter

A filter set applies filters to AuditEvents. If a filter in the set rejects an AuditEvent, then the AuditEvent is rejected. Otherwise, the AuditEvent is accepted.

Author:
  Rick Giles

Constructor Summary
`FilterSet()`

Method Summary
`boolean` | `accept(AuditEvent aEvent)` Determines whether or not a filtered AuditEvent is accepted.
`void` | `addFilter(Filter aFilter)` Adds a Filter to the set.
`void` | `clear()` Clears the FilterSet.
`boolean` | `equals(java.lang.Object aObject)`
`protected java.util.Set` | `getFilters()` Returns the Filters of the filter set.
`int` | `hashCode()`
`void` | `removeFilter(Filter aFilter)` Removes filter.
`java.lang.String` | `toString()`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

### FilterSet

    public FilterSet()

Method Detail

### addFilter

    public void addFilter(Filter aFilter)

  Adds a Filter to the set.

  Parameters:
    `aFilter` - the Filter to add.

### removeFilter

    public void removeFilter(Filter aFilter)

  Removes filter.

  Parameters:
    `aFilter` - filter to remove.

### getFilters

    protected java.util.Set getFilters()

  Returns the Filters of the filter set.

  Returns:
    the Filters of the filter set.

### toString

    public java.lang.String toString()

  See Also:
    `Object.toString()`

### hashCode

    public int hashCode()

  See Also:
    `Object.hashCode()`

### equals

    public boolean equals(java.lang.Object aObject)

  See Also:
    `Object.equals(java.lang.Object)`

### accept

    public boolean accept(AuditEvent aEvent)

  Description copied from interface: `Filter`
  Determines whether or not a filtered AuditEvent is accepted.

  Specified by:
    `accept` in interface `Filter`
  Parameters:
    `aEvent` - the AudtiEvent to filter.
  Returns:
    true if the aEvent is accepted.
  See Also:
    `Filter`

### clear

    public void clear()

  Clears the FilterSet.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Back to the Checkstyle Home Page
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD