Package net.sourceforge.pmd.lang.xml.rule

Class AbstractXmlRule

java.lang.Object

net.sourceforge.pmd.properties.AbstractPropertySource

net.sourceforge.pmd.lang.rule.AbstractRule

net.sourceforge.pmd.lang.xml.rule.AbstractXmlRule

All Implemented Interfaces:

ImmutableLanguage, PropertySource, Rule

Direct Known Subclasses:

AbstractDomXmlRule, AbstractWsdlRule

public class AbstractXmlRule
extends AbstractRule
implements ImmutableLanguage

This is a base class for XML Java bases rules. Subclasses should override visit(XmlNode, RuleContext) and can call super to visit children.

Field Summary

Fields

Modifier and Type	Field	Description
static BooleanProperty	COALESCING_DESCRIPTOR	Deprecated.
static BooleanProperty	EXPAND_ENTITY_REFERENCES_DESCRIPTOR	Deprecated.
static BooleanProperty	IGNORING_COMMENTS_DESCRIPTOR	Deprecated.
static BooleanProperty	IGNORING_ELEMENT_CONTENT_WHITESPACE_DESCRIPTOR	Deprecated.
static BooleanProperty	NAMESPACE_AWARE_DESCRIPTOR	Deprecated.
static BooleanProperty	VALIDATING_DESCRIPTOR	Deprecated.
static BooleanProperty	XINCLUDE_AWARE_DESCRIPTOR	Deprecated.

Fields inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

propertyDescriptors, propertyValuesByDescriptor

Fields inherited from interface net.sourceforge.pmd.Rule

VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractXmlRule()
protected	AbstractXmlRule(Language language)

Method Summary

Modifier and Type	Method	Description
void	apply(List<? extends Node> nodes, RuleContext ctx)
ParserOptions	getParserOptions()
protected void	visit(XmlNode node, RuleContext ctx)	Deprecated. Not useful, will be removed in PMD 7.
protected void	visitAll(List<? extends Node> nodes, RuleContext ctx)	Deprecated. Not useful, will be removed in PMD 7.

Methods inherited from class net.sourceforge.pmd.lang.rule.AbstractRule

addExample, addRuleChainVisit, addRuleChainVisit, addViolation, addViolation, addViolation, addViolationWithMessage, addViolationWithMessage, addViolationWithMessage, asCtx, deepCopy, deepCopyValuesTo, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getPriority, getPropertySourceType, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, hashCode, isDeprecated, isDfa, isMultifile, isRuleChain, isTypeResolution, setDeprecated, setDescription, setDfa, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setMultifile, setName, setPriority, setRuleClass, setRuleSetName, setSince, setTypeResolution, setUsesDFA, setUsesMultifile, setUsesTypeResolution, start, usesDFA, usesMultifile, usesRuleChain, usesTypeResolution

Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, isPropertyOverridden, setProperty, setProperty, useDefaultValueFor, usesDefaultValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.properties.PropertySource

definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, isPropertyOverridden, setProperty, setProperty, useDefaultValueFor, usesDefaultValues

Field Detail

COALESCING_DESCRIPTOR

@Deprecated
public static final BooleanProperty COALESCING_DESCRIPTOR

Deprecated.

EXPAND_ENTITY_REFERENCES_DESCRIPTOR

@Deprecated
public static final BooleanProperty EXPAND_ENTITY_REFERENCES_DESCRIPTOR

Deprecated.

IGNORING_COMMENTS_DESCRIPTOR

@Deprecated
public static final BooleanProperty IGNORING_COMMENTS_DESCRIPTOR

Deprecated.

IGNORING_ELEMENT_CONTENT_WHITESPACE_DESCRIPTOR

@Deprecated
public static final BooleanProperty IGNORING_ELEMENT_CONTENT_WHITESPACE_DESCRIPTOR

Deprecated.

NAMESPACE_AWARE_DESCRIPTOR

@Deprecated
public static final BooleanProperty NAMESPACE_AWARE_DESCRIPTOR

Deprecated.

VALIDATING_DESCRIPTOR

@Deprecated
public static final BooleanProperty VALIDATING_DESCRIPTOR

Deprecated.

XINCLUDE_AWARE_DESCRIPTOR

@Deprecated
public static final BooleanProperty XINCLUDE_AWARE_DESCRIPTOR

Deprecated.

Constructor Detail

AbstractXmlRule

public AbstractXmlRule()

AbstractXmlRule

protected AbstractXmlRule(Language language)

Method Detail

getParserOptions

public ParserOptions getParserOptions()

Specified by:

getParserOptions in interface Rule

Overrides:

getParserOptions in class AbstractRule

apply

public void apply(List<? extends Node> nodes,
                  RuleContext ctx)

Specified by:

apply in interface Rule

visitAll

@Deprecated
protected void visitAll(List<? extends Node> nodes,
                        RuleContext ctx)

Deprecated.

Not useful, will be removed in PMD 7.

visit

@Deprecated
protected void visit(XmlNode node,
                     RuleContext ctx)

Deprecated.

Not useful, will be removed in PMD 7.