Class Filter

java.lang.Object

edu.umd.cs.findbugs.filter.CompoundMatcher

edu.umd.cs.findbugs.filter.OrMatcher

edu.umd.cs.findbugs.filter.Filter

All Implemented Interfaces:

Matcher

public class Filter
extends OrMatcher

Filter to match a subset of BugInstances. The filter criteria are read from an XML file.

Field Summary

Fields

Modifier and Type	Field	Description
private final IdentityHashMap<Matcher,Boolean>	disabled
private static final int	PRIME

Fields inherited from class CompoundMatcher

children

Constructor Summary

Constructors

Constructor	Description
Filter()	Constructor for empty filter
Filter(InputStream stream)	Constructor.
Filter(String fileName)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addChild(Matcher child)
void	clear()
boolean	contains(Matcher child)
void	disable(Matcher m)
void	enable(Matcher m)
boolean	equals(Object obj)
int	hashCode()
boolean	isEmpty()
boolean	isEnabled(Matcher m)
static void	main(String[] argv)
boolean	match(BugInstance bugInstance)	Determine whether or not the given BugInstance has the feature this Matcher tests for.
private void	parse(String fileName)	Parse and load the given filter file.
private void	parse(String fileName, InputStream stream)	Parse and load the given filter file.
static Filter	parseFilter(String fileName)
void	removeChild(Matcher child)
void	setEnabled(Matcher m, boolean value)
void	softAdd(Matcher child)	Add if not present, but do not enable if already present and disabled
void	writeAsXML(OutputStream out)
void	writeBodyAsXML(XMLOutput xmlOutput)
void	writeEnabledMatchersAsXML(OutputStream out)

Methods inherited from class OrMatcher

toString, writeXML

Methods inherited from class CompoundMatcher

childIterator, getChildren, maxChildren, numberChildren, writeChildrenXML

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PRIME

private static final int PRIME

See Also:

• Constant Field Values

disabled

private final IdentityHashMap<Matcher,Boolean> disabled

Constructor Details

Filter

public Filter()

Constructor for empty filter

Filter

public Filter(String fileName)
       throws IOException

Constructor.

Parameters:

fileName - name of the filter file

Throws:

IOException

Filter

public Filter(InputStream stream)
       throws IOException

Constructor.

Parameters:

stream - content of the filter file

Throws:

IOException

Method Details

hashCode

public int hashCode()

Overrides:

hashCode in class CompoundMatcher

equals

public boolean equals(Object obj)

Overrides:

equals in class CompoundMatcher

isEmpty

public boolean isEmpty()

setEnabled

public void setEnabled(Matcher m,
 boolean value)

disable

public void disable(Matcher m)

isEnabled

public boolean isEnabled(Matcher m)

enable

public void enable(Matcher m)

parseFilter

public static Filter parseFilter(String fileName)
                          throws IOException

Throws:

IOException

contains

public boolean contains(Matcher child)

softAdd

public void softAdd(Matcher child)

Add if not present, but do not enable if already present and disabled

Parameters:

child -

addChild

public void addChild(Matcher child)

Overrides:

addChild in class CompoundMatcher

removeChild

public void removeChild(Matcher child)

Overrides:

removeChild in class CompoundMatcher

clear

public void clear()

Overrides:

clear in class CompoundMatcher

match

public boolean match(BugInstance bugInstance)

Description copied from interface: Matcher

Determine whether or not the given BugInstance has the feature this Matcher tests for.

Specified by:

match in interface Matcher

Overrides:

match in class OrMatcher

Parameters:

bugInstance - the BugInstance

Returns:

true if the BugInstance matches, false if not

parse

private void parse(String fileName)
            throws IOException,
SAXException,
ParserConfigurationException

Parse and load the given filter file.

Parameters:

fileName - name of the filter file

Throws:

IOException

SAXException

ParserConfigurationException

parse

private void parse(String fileName,
 @WillClose
 InputStream stream)
            throws IOException,
SAXException,
ParserConfigurationException

Parse and load the given filter file.

Parameters:

fileName - name of the filter file

Throws:

IOException

SAXException

ParserConfigurationException

main

public static void main(String[] argv)

writeAsXML

public void writeAsXML(@WillClose
 OutputStream out)
                throws IOException

Throws:

IOException

writeEnabledMatchersAsXML

public void writeEnabledMatchersAsXML(@WillClose
 OutputStream out)
                               throws IOException

Throws:

IOException

writeBodyAsXML

public void writeBodyAsXML(XMLOutput xmlOutput)
                    throws IOException

Throws:

IOException