Package com.puppycrawl.tools.checkstyle

Class ConfigurationLoader.InternalLoader

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.puppycrawl.tools.checkstyle.XmlLoader

com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Enclosing class:

ConfigurationLoader

private final class ConfigurationLoader.InternalLoader
extends XmlLoader

Implements the SAX document handler interfaces, so they do not appear in the public API of the ConfigurationLoader.

Nested Class Summary

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

XmlLoader.LoadExternalDtdFeatureProvider

Field Summary

Fields

Modifier and Type	Field	Description
private final Deque<DefaultConfiguration>	configStack	The loaded configurations.
private Configuration	configuration	The Configuration that is being built.
private static final String	DEFAULT	Default attribute.
private static final String	KEY	Name of the key attribute.
private static final String	MESSAGE	Name of the message element.
private static final String	METADATA	Name of the message element.
private static final String	MODULE	Module elements.
private static final String	NAME	Name attribute.
private static final String	PROPERTY	Property element.
private static final String	SEVERITY	Name of the severity property.
private static final String	VALUE	Value attribute.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	InternalLoader()	Creates a new InternalLoader.

Method Summary

Modifier and Type	Method	Description
private static boolean	containsAttribute(Configuration module, String attributeName)	Util method to recheck attribute in module.
void	endElement(String uri, String localName, String qName)
private static void	parsePropertyString(String value, Collection<String> fragments, Collection<String> propertyRefs)	Parses a string containing ${xxx} style property references into two collections.
private String	replaceProperties(String value, String defaultValue)	Replaces ${xxx} style constructions in the given value with the string value of the corresponding data types.
void	startElement(String uri, String localName, String qName, Attributes attributes)

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

error, parseInputSource, resolveEntity

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

characters, endDocument, endPrefixMapping, fatalError, 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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Field Details

MODULE

private static final String MODULE

Module elements.

See Also:

• Constant Field Values

NAME

private static final String NAME

Name attribute.

See Also:

• Constant Field Values

PROPERTY

private static final String PROPERTY

Property element.

See Also:

• Constant Field Values

VALUE

private static final String VALUE

Value attribute.

See Also:

• Constant Field Values

DEFAULT

private static final String DEFAULT

Default attribute.

See Also:

• Constant Field Values

SEVERITY

private static final String SEVERITY

Name of the severity property.

See Also:

• Constant Field Values

MESSAGE

private static final String MESSAGE

Name of the message element.

See Also:

• Constant Field Values

METADATA

private static final String METADATA

Name of the message element.

See Also:

• Constant Field Values

KEY

private static final String KEY

Name of the key attribute.

See Also:

• Constant Field Values

configStack

private final Deque<DefaultConfiguration> configStack

The loaded configurations.

configuration

private Configuration configuration

The Configuration that is being built.

Constructor Details

InternalLoader

private InternalLoader()
                throws SAXException,
ParserConfigurationException

Creates a new InternalLoader.

Throws:

SAXException - if an error occurs

ParserConfigurationException - if an error occurs

Method Details

replaceProperties

private String replaceProperties(String value,
 String defaultValue)
                          throws CheckstyleException

Replaces ${xxx} style constructions in the given value with the string value of the corresponding data types.

Code copied from ant

Parameters:

value - The string to be scanned for property references. Must not be null.

defaultValue - default to use if one of the properties in value cannot be resolved from props.

Returns:

the original string with the properties replaced.

Throws:

CheckstyleException - if the string contains an opening ${} without a closing {@code }

parsePropertyString

private static void parsePropertyString(String value,
 Collection<String> fragments,
 Collection<String> propertyRefs)
                                 throws CheckstyleException

Parses a string containing ${xxx} style property references into two collections. The first one is a collection of text fragments, while the other is a set of string property names. null entries in the first collection indicate a property reference from the second collection.

Code copied from ant

Parameters:

value - Text to parse. Must not be null.

fragments - Collection to add text fragments to. Must not be null.

propertyRefs - Collection to add property names to. Must not be null.

Throws:

CheckstyleException - if the string contains an opening ${} without a closing {@code }

startElement

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

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

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

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

containsAttribute

private static boolean containsAttribute(Configuration module,
 String attributeName)

Util method to recheck attribute in module.

Parameters:

module - module to check

attributeName - name of attribute in module to find

Returns:

true if attribute is present in module