com.puppycrawl.tools.checkstyle

Class PackageNamesLoader

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.puppycrawl.tools.checkstyle.api.AbstractLoader

com.puppycrawl.tools.checkstyle.PackageNamesLoader

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public final class PackageNamesLoader
extends AbstractLoader

Loads a list of package names from a package name XML file.

Version:

4-Dec-2002

Author:

Rick Giles

Method Summary

Methods

Modifier and Type	Method and Description
void	endElement(String namespaceURI, String localName, String qName)
static Set<String>	getPackageNames(ClassLoader classLoader) Returns the set of package names, compiled from all checkstyle_packages.xml files found on the given classloaders classpath.
void	startElement(String namespaceURI, String localName, String qName, Attributes atts)

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractLoader

error, fatalError, parseInputSource, resolveEntity, warning

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endDocument, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Method Detail

startElement

public void startElement(String namespaceURI,
                String localName,
                String qName,
                Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

endElement

public void endElement(String namespaceURI,
              String localName,
              String qName)

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

getPackageNames

public static Set<String> getPackageNames(ClassLoader classLoader)
                                   throws CheckstyleException

Returns the set of package names, compiled from all checkstyle_packages.xml files found on the given classloaders classpath.

Parameters:

classLoader - the class loader for loading the checkstyle_packages.xml files.

Returns:

the set of package names.

Throws:

CheckstyleException - if an error occurs.