Package net.sourceforge.pmd.util.internal.xml

Class SchemaConstant

java.lang.Object

net.sourceforge.pmd.util.internal.xml.SchemaConstant

public class SchemaConstant
extends Object

Wraps the name of eg an attribute or element, and provides convenience methods to query the DOM.

Constructor Summary

Constructors

Constructor	Description
SchemaConstant(String name)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
boolean	getAsBooleanAttr(Element e, boolean defaultValue)
@Nullable Attr	getAttributeNode(Element element)
Optional<String>	getAttributeOpt(Element element)
@Nullable String	getAttributeOrNull(Element element)
@NonNull String	getAttributeOrThrow(Element element, PmdXmlReporter err)
List<Element>	getChildrenIn(Element elt)
List<Element>	getElementChildrenNamedReportOthers(Element elt, PmdXmlReporter err)
@NonNull String	getNonBlankAttribute(Element ruleElement, PmdXmlReporter err)
@NonNull String	getNonBlankAttributeOrThrow(Element element, PmdXmlReporter err)
Element	getOptChildIn(Element elt, PmdXmlReporter err)
Element	getSingleChildIn(Element elt, PmdXmlReporter err)
boolean	hasAttribute(Element element)
int	hashCode()
boolean	matchesElt(Node node)
void	setOn(Element element, String value)
String	toString()
String	xmlName()	Returns the String name of this attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaConstant

public SchemaConstant(String name)

Method Detail

getAsBooleanAttr

public boolean getAsBooleanAttr(Element e,
                                boolean defaultValue)

getAttributeOrThrow

public @NonNull String getAttributeOrThrow(Element element,
                                           PmdXmlReporter err)

getNonBlankAttributeOrThrow

public @NonNull String getNonBlankAttributeOrThrow(Element element,
                                                   PmdXmlReporter err)

getAttributeOrNull

public @Nullable String getAttributeOrNull(Element element)

getAttributeOpt

public Optional<String> getAttributeOpt(Element element)

getAttributeNode

public @Nullable Attr getAttributeNode(Element element)

hasAttribute

public boolean hasAttribute(Element element)

getChildrenIn

public List<Element> getChildrenIn(Element elt)

getElementChildrenNamedReportOthers

public List<Element> getElementChildrenNamedReportOthers(Element elt,
                                                         PmdXmlReporter err)

getSingleChildIn

public Element getSingleChildIn(Element elt,
                                PmdXmlReporter err)

getOptChildIn

public Element getOptChildIn(Element elt,
                             PmdXmlReporter err)

setOn

public void setOn(Element element,
                  String value)

xmlName

public String xmlName()

Returns the String name of this attribute.

Returns:

The attribute's name

toString

public String toString()

Overrides:

toString in class Object

matchesElt

public boolean matchesElt(Node node)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getNonBlankAttribute

public @NonNull String getNonBlankAttribute(Element ruleElement,
                                            PmdXmlReporter err)