Package com.puppycrawl.tools.checkstyle

Class XmlLoader

  • All Implemented Interfaces:
    org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler
    Direct Known Subclasses:
    ConfigurationLoader.InternalLoader, ImportControlLoader, PackageNamesLoader, SuppressionsLoader
    public class XmlLoader
extends org.xml.sax.helpers.DefaultHandler
    Contains the common implementation of a loader, for loading a configuration from an XML file.

    The error handling policy can be described as being austere, dead set, disciplinary, dour, draconian, exacting, firm, forbidding, grim, hard, hard- boiled, harsh, harsh, in line, iron-fisted, no-nonsense, oppressive, persnickety, picky, prudish, punctilious, puritanical, rigid, rigorous, scrupulous, set, severe, square, stern, stickler, straight, strait-laced, stringent, stuffy, stuffy, tough, unpermissive, unsparing and uptight.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  XmlLoader.LoadExternalDtdFeatureProvider
      Used for setting specific for secure java installations features to SAXParserFactory.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.xml.sax.XMLReader parser
      Parser to read XML files.
      private java.util.Map<java.lang.String,​java.lang.String> publicIdToResourceNameMap
      Maps public id to resolve to resource name for the DTD.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected XmlLoader​(java.util.Map<java.lang.String,​java.lang.String> publicIdToResourceNameMap)
      Creates a new instance.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private static org.xml.sax.XMLReader createXmlReader​(org.xml.sax.helpers.DefaultHandler handler)
      Helper method to create XMLReader.
      void error​(org.xml.sax.SAXParseException exception)  
      void parseInputSource​(org.xml.sax.InputSource inputSource)
      Parses the specified input source.
      org.xml.sax.InputSource resolveEntity​(java.lang.String publicId, java.lang.String systemId)  

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

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

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • publicIdToResourceNameMap

        private final java.util.Map<java.lang.String,​java.lang.String> publicIdToResourceNameMap
        Maps public id to resolve to resource name for the DTD.

      • parser

        private final org.xml.sax.XMLReader parser
        Parser to read XML files.

    • Constructor Detail

      • XmlLoader

        protected XmlLoader​(java.util.Map<java.lang.String,​java.lang.String> publicIdToResourceNameMap)
             throws org.xml.sax.SAXException,
                    javax.xml.parsers.ParserConfigurationException
        Creates a new instance.
        Parameters:
        publicIdToResourceNameMap - maps public IDs to DTD resource names
        Throws:
        org.xml.sax.SAXException - if an error occurs
        javax.xml.parsers.ParserConfigurationException - if an error occurs

    • Method Detail

      • parseInputSource

        public void parseInputSource​(org.xml.sax.InputSource inputSource)
                      throws java.io.IOException,
                             org.xml.sax.SAXException
        Parses the specified input source.
        Parameters:
        inputSource - the input source to parse.
        Throws:
        java.io.IOException - if an error occurs
        org.xml.sax.SAXException - in an error occurs

      • resolveEntity

        public org.xml.sax.InputSource resolveEntity​(java.lang.String publicId,
                                             java.lang.String systemId)
                                      throws org.xml.sax.SAXException,
                                             java.io.IOException
        Specified by:
        resolveEntity in interface org.xml.sax.EntityResolver
        Overrides:
        resolveEntity in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException
        java.io.IOException

      • error

        public void error​(org.xml.sax.SAXParseException exception)
           throws org.xml.sax.SAXException
        Specified by:
        error in interface org.xml.sax.ErrorHandler
        Overrides:
        error in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException

      • createXmlReader

        private static org.xml.sax.XMLReader createXmlReader​(org.xml.sax.helpers.DefaultHandler handler)
                                              throws org.xml.sax.SAXException,
                                                     javax.xml.parsers.ParserConfigurationException
        Helper method to create XMLReader.
        Parameters:
        handler - the content handler
        Returns:
        new XMLReader instance
        Throws:
        javax.xml.parsers.ParserConfigurationException - if a parser cannot be created
        org.xml.sax.SAXException - for SAX errors