org.opendaylight.controller.config.util.xml

Class XmlElement

java.lang.Object

org.opendaylight.controller.config.util.xml.XmlElement

public final class XmlElement
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAMESPACE_PREFIX

Method Summary

Modifier and Type	Method and Description
void	appendChild(Element element)
void	checkName(String expectedName)
void	checkNamespace(String expectedNamespace)
void	checkNamespaceAttribute(String expectedNamespace)
void	checkUnrecognisedElements(List<XmlElement> recognisedElements, XmlElement... additionalRecognisedElements)
void	checkUnrecognisedElements(XmlElement... additionalRecognisedElements)
boolean	equals(Object o)
Map.Entry<String,String>	findNamespaceOfTextContent() Search for element's attributes defining namespaces.
static XmlElement	fromDomDocument(Document xml)
static XmlElement	fromDomElement(Element e)
static XmlElement	fromDomElementWithExpected(Element element, String expectedName)
static XmlElement	fromDomElementWithExpected(Element element, String expectedName, String expectedNamespace)
static XmlElement	fromString(String s)
String	getAttribute(String attributeName)
String	getAttribute(String attributeName, String namespace)
Map<String,Attr>	getAttributes()
List<XmlElement>	getChildElements()
List<XmlElement>	getChildElements(String tagName)
List<XmlElement>	getChildElementsWithinNamespace(String namespace)
List<XmlElement>	getChildElementsWithinNamespace(String childName, String namespace)
List<XmlElement>	getChildElementsWithSameNamespace(String childName)
Element	getDomElement()
NodeList	getElementsByTagName(String name)
String	getName()
String	getNamespace()
String	getNamespaceAttribute()
com.google.common.base.Optional<String>	getNamespaceAttributeOptionally()
com.google.common.base.Optional<String>	getNamespaceOptionally()
XmlElement	getOnlyChildElement()
XmlElement	getOnlyChildElement(String childName)
XmlElement	getOnlyChildElement(String childName, String namespace)
com.google.common.base.Optional<XmlElement>	getOnlyChildElementOptionally()
com.google.common.base.Optional<XmlElement>	getOnlyChildElementOptionally(String childName)
com.google.common.base.Optional<XmlElement>	getOnlyChildElementOptionally(String childName, String namespace)
XmlElement	getOnlyChildElementWithSameNamespace()
XmlElement	getOnlyChildElementWithSameNamespace(String childName)
com.google.common.base.Optional<XmlElement>	getOnlyChildElementWithSameNamespaceOptionally()
com.google.common.base.Optional<XmlElement>	getOnlyChildElementWithSameNamespaceOptionally(String childName)
com.google.common.base.Optional<String>	getOnlyTextContentOptionally()
String	getTextContent()
int	hashCode()
boolean	hasNamespace()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAMESPACE_PREFIX

public static final String DEFAULT_NAMESPACE_PREFIX

See Also:

Constant Field Values

Method Detail

fromDomElement

public static XmlElement fromDomElement(Element e)

fromDomDocument

public static XmlElement fromDomDocument(Document xml)

fromString

public static XmlElement fromString(String s)
                             throws DocumentedException

Throws:

DocumentedException

fromDomElementWithExpected

public static XmlElement fromDomElementWithExpected(Element element,
                                                    String expectedName)
                                             throws DocumentedException

Throws:

DocumentedException

fromDomElementWithExpected

public static XmlElement fromDomElementWithExpected(Element element,
                                                    String expectedName,
                                                    String expectedNamespace)
                                             throws DocumentedException

Throws:

DocumentedException

checkName

public void checkName(String expectedName)
               throws UnexpectedElementException

Throws:

UnexpectedElementException

checkNamespaceAttribute

public void checkNamespaceAttribute(String expectedNamespace)
                             throws UnexpectedNamespaceException,
                                    MissingNameSpaceException

Throws:

UnexpectedNamespaceException

MissingNameSpaceException

checkNamespace

public void checkNamespace(String expectedNamespace)
                    throws UnexpectedNamespaceException,
                           MissingNameSpaceException

Throws:

UnexpectedNamespaceException

MissingNameSpaceException

getName

public String getName()

getAttribute

public String getAttribute(String attributeName)

getAttribute

public String getAttribute(String attributeName,
                           String namespace)

getElementsByTagName

public NodeList getElementsByTagName(String name)

appendChild

public void appendChild(Element element)

getDomElement

public Element getDomElement()

getAttributes

public Map<String,Attr> getAttributes()

getChildElements

public List<XmlElement> getChildElements()

getChildElementsWithinNamespace

public List<XmlElement> getChildElementsWithinNamespace(String childName,
                                                        String namespace)

getChildElementsWithinNamespace

public List<XmlElement> getChildElementsWithinNamespace(String namespace)

getChildElements

public List<XmlElement> getChildElements(String tagName)

Parameters:

tagName - tag name without prefix

Returns:

List of child elements

getOnlyChildElement

public XmlElement getOnlyChildElement(String childName)
                               throws DocumentedException

Throws:

DocumentedException

getOnlyChildElementOptionally

public com.google.common.base.Optional<XmlElement> getOnlyChildElementOptionally(String childName)

getOnlyChildElementOptionally

public com.google.common.base.Optional<XmlElement> getOnlyChildElementOptionally(String childName,
                                                                                 String namespace)

getOnlyChildElementWithSameNamespace

public XmlElement getOnlyChildElementWithSameNamespace(String childName)
                                                throws DocumentedException

Throws:

DocumentedException

getOnlyChildElementWithSameNamespaceOptionally

public com.google.common.base.Optional<XmlElement> getOnlyChildElementWithSameNamespaceOptionally(String childName)

getOnlyChildElementWithSameNamespace

public XmlElement getOnlyChildElementWithSameNamespace()
                                                throws DocumentedException

Throws:

DocumentedException

getOnlyChildElementWithSameNamespaceOptionally

public com.google.common.base.Optional<XmlElement> getOnlyChildElementWithSameNamespaceOptionally()

getOnlyChildElement

public XmlElement getOnlyChildElement(String childName,
                                      String namespace)
                               throws DocumentedException

Throws:

DocumentedException

getOnlyChildElement

public XmlElement getOnlyChildElement()
                               throws DocumentedException

Throws:

DocumentedException

getOnlyChildElementOptionally

public com.google.common.base.Optional<XmlElement> getOnlyChildElementOptionally()

getTextContent

public String getTextContent()
                      throws DocumentedException

Throws:

DocumentedException

getOnlyTextContentOptionally

public com.google.common.base.Optional<String> getOnlyTextContentOptionally()

getNamespaceAttribute

public String getNamespaceAttribute()
                             throws MissingNameSpaceException

Throws:

MissingNameSpaceException

getNamespaceAttributeOptionally

public com.google.common.base.Optional<String> getNamespaceAttributeOptionally()

getNamespaceOptionally

public com.google.common.base.Optional<String> getNamespaceOptionally()

getNamespace

public String getNamespace()
                    throws MissingNameSpaceException

Throws:

MissingNameSpaceException

toString

public String toString()

Overrides:

toString in class Object

findNamespaceOfTextContent

public Map.Entry<String,String> findNamespaceOfTextContent()
                                                    throws DocumentedException

Search for element's attributes defining namespaces. Look for the one namespace that matches prefix of element's text content. E.g.

 <type
 xmlns:th-java="urn:opendaylight:params:xml:ns:yang:controller:threadpool:impl">th-java:threadfactory-naming</type>
 

returns {"th-java","urn:.."}. If no prefix is matched, then default namespace is returned with empty string as key. If no default namespace is found value will be null.

Throws:

DocumentedException

getChildElementsWithSameNamespace

public List<XmlElement> getChildElementsWithSameNamespace(String childName)
                                                   throws MissingNameSpaceException

Throws:

MissingNameSpaceException

checkUnrecognisedElements

public void checkUnrecognisedElements(List<XmlElement> recognisedElements,
                                      XmlElement... additionalRecognisedElements)
                               throws DocumentedException

Throws:

DocumentedException

checkUnrecognisedElements

public void checkUnrecognisedElements(XmlElement... additionalRecognisedElements)
                               throws DocumentedException

Throws:

DocumentedException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasNamespace

public boolean hasNamespace()