com.puppycrawl.tools.checkstyle

Class PackageNamesLoader

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.puppycrawl.tools.checkstyle.XmlLoader

com.puppycrawl.tools.checkstyle.PackageNamesLoader

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public final class PackageNamesLoader
extends XmlLoader

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

Author:

Rick Giles

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.XmlLoader

XmlLoader.FeaturesForVerySecureJavaInstallations

Method Summary

Modifier and Type	Method and Description
void	endElement(String uri, 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 class loaders classpath.
void	startElement(String uri, String localName, String qName, Attributes attributes)

Methods inherited from class com.puppycrawl.tools.checkstyle.XmlLoader

error, fatalError, parseInputSource, resolveEntity

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

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

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 uri,
                         String localName,
                         String qName,
                         Attributes attributes)

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

endElement

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

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class 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 class loaders 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.