Class SAXBugCollectionHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

edu.umd.cs.findbugs.SAXBugCollectionHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class SAXBugCollectionHandler
extends DefaultHandler

Build a BugCollection based on SAX events. This is intended to replace the old DOM-based parsing of XML bug result files, which was very slow.

Field Summary

Fields

Modifier and Type	Field	Description
private AnalysisError	analysisError
private final File	base
private static final String	BUG_COLLECTION
private BugAnnotationWithSourceLines	bugAnnotationWithSourceLines
private final BugCollection	bugCollection
private BugInstance	bugInstance
private final MapCache<String,String>	cache
private ClassFeatureSet	classFeatureSet
private static boolean	DEBUG
private final ArrayList<String>	elementStack
private Filter	filter
private static final String	FIND_BUGS_FILTER
(package private) Pattern	ignoredElement
private static final org.slf4j.Logger	LOG
private final Stack<CompoundMatcher>	matcherStack
private int	nestingOfIgnoredElements
(package private) boolean	nextMatchedIsDisabled
private final Set<String>	outerElementTags
private final Project	project
private static final String	PROJECT
private final Map<String,Method>	qnameCache
(package private) List<String>	sourceDirs
private final ArrayList<String>	stackTrace
private final StringBuilder	textBuffer
private final String	topLevelName

Constructor Summary

Constructors

Modifier	Constructor	Description
	SAXBugCollectionHandler(BugCollection bugCollection)
	SAXBugCollectionHandler(BugCollection bugCollection, File base)
	SAXBugCollectionHandler(Filter filter, File base)
	SAXBugCollectionHandler(Project project, File base)
private	SAXBugCollectionHandler(String topLevelName, BugCollection bugCollection, Project project, File base)

Method Summary

Modifier and Type	Method	Description
private void	addMatcher(Matcher m)
void	characters(char[] ch, int start, int length)
private SourceLineAnnotation	createSourceLineAnnotation(String qName, Attributes attributes)
boolean	discardedElement(String qName)
void	endElement(String uri, String name, String qName)
String	getOptionalAttribute(Attributes attributes, String qName)
private String	getRequiredAttribute(Attributes attributes, String attrName, String elementName)
String	getTextContents()
private boolean	isCompoundElementTag(String qName)
private boolean	isTopLevelFilter(String qName)
private String	makeAbsolute(String possiblyRelativePath)
private String	memoized(String s)
private void	parseBugInstanceContents(String qName, Attributes attributes)
private long	parseLong(String s, long defaultValue)
private void	parseMatcher(String qName, Attributes attributes)
private void	pushCompoundMatcher(CompoundMatcher m)
private void	pushCompoundMatcherAsChild(CompoundMatcher m)
private void	setAnnotationRole(Attributes attributes, BugAnnotation bugAnnotation)
void	startElement(String uri, String name, String qName, Attributes attributes)

Methods inherited from class DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class Object

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

Methods inherited from interface ContentHandler

declaration

Field Details

LOG

private static final org.slf4j.Logger LOG

FIND_BUGS_FILTER

private static final String FIND_BUGS_FILTER

See Also:

• Constant Field Values

PROJECT

private static final String PROJECT

See Also:

• Constant Field Values

BUG_COLLECTION

private static final String BUG_COLLECTION

See Also:

• Constant Field Values

bugCollection

@CheckForNull
private final BugCollection bugCollection

project

@CheckForNull
private final Project project

matcherStack

private final Stack<CompoundMatcher> matcherStack

filter

private Filter filter

cache

private final MapCache<String,String> cache

elementStack

private final ArrayList<String> elementStack

textBuffer

private final StringBuilder textBuffer

bugInstance

private BugInstance bugInstance

bugAnnotationWithSourceLines

private BugAnnotationWithSourceLines bugAnnotationWithSourceLines

analysisError

private AnalysisError analysisError

classFeatureSet

private ClassFeatureSet classFeatureSet

stackTrace

private final ArrayList<String> stackTrace

nestingOfIgnoredElements

private int nestingOfIgnoredElements

base

@CheckForNull
private final File base

topLevelName

private final String topLevelName

qnameCache

private final Map<String,Method> qnameCache

ignoredElement

Pattern ignoredElement

DEBUG

private static boolean DEBUG

nextMatchedIsDisabled

boolean nextMatchedIsDisabled

outerElementTags

private final Set<String> outerElementTags

sourceDirs

List<String> sourceDirs

Constructor Details

SAXBugCollectionHandler

private SAXBugCollectionHandler(String topLevelName,
 @CheckForNull
 BugCollection bugCollection,
 @CheckForNull
 Project project,
 @CheckForNull
 File base)

SAXBugCollectionHandler

public SAXBugCollectionHandler(BugCollection bugCollection,
 @CheckForNull
 File base)

SAXBugCollectionHandler

public SAXBugCollectionHandler(BugCollection bugCollection)

SAXBugCollectionHandler

public SAXBugCollectionHandler(Project project,
 File base)

SAXBugCollectionHandler

public SAXBugCollectionHandler(Filter filter,
 File base)

Method Details

getOptionalAttribute

public String getOptionalAttribute(Attributes attributes,
 String qName)

discardedElement

public boolean discardedElement(String qName)

getTextContents

public String getTextContents()

memoized

private String memoized(String s)

startElement

public void startElement(String uri,
 String name,
 String qName,
 Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

isCompoundElementTag

private boolean isCompoundElementTag(String qName)

isTopLevelFilter

private boolean isTopLevelFilter(String qName)

addMatcher

private void addMatcher(Matcher m)

pushCompoundMatcherAsChild

private void pushCompoundMatcherAsChild(CompoundMatcher m)

pushCompoundMatcher

private void pushCompoundMatcher(CompoundMatcher m)

parseMatcher

private void parseMatcher(String qName,
 Attributes attributes)
                   throws SAXException

Throws:

SAXException

parseBugInstanceContents

private void parseBugInstanceContents(String qName,
 Attributes attributes)
                               throws SAXException

Throws:

SAXException

parseLong

private long parseLong(String s,
 long defaultValue)

setAnnotationRole

private void setAnnotationRole(Attributes attributes,
 BugAnnotation bugAnnotation)

createSourceLineAnnotation

private SourceLineAnnotation createSourceLineAnnotation(String qName,
 Attributes attributes)
                                                 throws SAXException

Throws:

SAXException

endElement

public void endElement(String uri,
 String name,
 String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

makeAbsolute

private String makeAbsolute(String possiblyRelativePath)

characters

public void characters(char[] ch,
 int start,
 int length)

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

getRequiredAttribute

private String getRequiredAttribute(Attributes attributes,
 String attrName,
 String elementName)
                             throws SAXException

Throws:

SAXException