com.puppycrawl.tools.checkstyle
Class PackageNamesLoader

java.lang.Object
  extended by org.xml.sax.helpers.DefaultHandler
      extended by com.puppycrawl.tools.checkstyle.api.AbstractLoader
          extended by com.puppycrawl.tools.checkstyle.PackageNamesLoader
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.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
 void endElement(java.lang.String aNamespaceURI, java.lang.String aLocalName, java.lang.String aQName)
           
static java.util.Set<java.lang.String> getPackageNames(java.lang.ClassLoader aClassLoader)
          Returns the set of package names, compiled from all checkstyle_packages.xml files found on the given classloaders classpath.
 void startElement(java.lang.String aNamespaceURI, java.lang.String aLocalName, java.lang.String aQName, org.xml.sax.Attributes aAtts)
           
 
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(java.lang.String aNamespaceURI,
                         java.lang.String aLocalName,
                         java.lang.String aQName,
                         org.xml.sax.Attributes aAtts)
                  throws org.xml.sax.SAXException
Specified by:
startElement in interface org.xml.sax.ContentHandler
Overrides:
startElement in class org.xml.sax.helpers.DefaultHandler
Throws:
org.xml.sax.SAXException

endElement

public void endElement(java.lang.String aNamespaceURI,
                       java.lang.String aLocalName,
                       java.lang.String aQName)
Specified by:
endElement in interface org.xml.sax.ContentHandler
Overrides:
endElement in class org.xml.sax.helpers.DefaultHandler

getPackageNames

public static java.util.Set<java.lang.String> getPackageNames(java.lang.ClassLoader aClassLoader)
                                                       throws CheckstyleException
Returns the set of package names, compiled from all checkstyle_packages.xml files found on the given classloaders classpath.

Parameters:
aClassLoader - the class loader for loading the checkstyle_packages.xml files.
Returns:
the set of package names.
Throws:
CheckstyleException - if an error occurs.


Copyright © 2001-2010. All Rights Reserved.