software.amazon.awssdk.protocols.query.unmarshall

Class XmlElement

java.lang.Object

software.amazon.awssdk.protocols.query.unmarshall.XmlElement

public final class XmlElement
extends Object

Represents an element in an XML document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlElement.Builder Builder for XmlElement.

Method Summary

Modifier and Type	Method and Description
static XmlElement.Builder	builder()
List<XmlElement>	children()
String	elementName()
static XmlElement	empty()
XmlElement	getElementByName(String tagName) Retrieves a single child element by tag name.
List<XmlElement>	getElementsByName(String tagName) Get all child elements by the given tag name.
XmlElement	getFirstChild()
Optional<XmlElement>	getOptionalElementByName(String tagName) Retrieves a single child element by tag name.
String	textContent()

Methods inherited from class java.lang.Object

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

Method Detail

elementName

public String elementName()

Returns:

Tag name of the element.

children

public List<XmlElement> children()

Returns:

The list of direct children of this element. May be empty.

getFirstChild

public XmlElement getFirstChild()

Returns:

The first child element of this element. Null if this element has no children.

getElementsByName

public List<XmlElement> getElementsByName(String tagName)

Get all child elements by the given tag name. This only returns direct children elements.

Parameters:

tagName - Tag name of elements to retrieve.

Returns:

List of elements or empty list of no elements found with given name.

getElementByName

public XmlElement getElementByName(String tagName)

Retrieves a single child element by tag name. If more than one element is found then this method will throw an exception.

Parameters:

tagName - Tag name of element to get.

Returns:

XmlElement with the matching tag name or null if no element exists.

Throws:

SdkClientException - If more than one element with the given tag name is found.

getOptionalElementByName

public Optional<XmlElement> getOptionalElementByName(String tagName)

Retrieves a single child element by tag name. If more than one element is found then this method will throw an exception.

Parameters:

tagName - Tag name of element to get.

Returns:

Fulfilled Optional of XmlElement with the matching tag name or empty Optional if no element exists.

Throws:

SdkClientException - If more than one element with the given tag name is found.

textContent

public String textContent()

Returns:

Text content of this element.

builder

public static XmlElement.Builder builder()

Returns:

New XmlElement.Builder instance.

empty

public static XmlElement empty()

Returns:

An empty XmlElement ().