alexh.weak

Class XmlDynamic

java.lang.Object

alexh.weak.AbstractDynamic<Node>

alexh.weak.XmlDynamic

All Implemented Interfaces:

Dynamic, Weak<Dynamic>

public class XmlDynamic
extends AbstractDynamic<Node>

Dynamic implementation for XML documents All keys & values in an XmlDynamic unwrap to Strings, try Weak.convert() to implement basic string->type conversions

As an example consider the following XML structure stored in a String 'xmlMessage'

     <product>
         <investment>
             <info>
                 <current>
                     <name>some name</name>
                 </current>
             </info>
         </investment>
     </product>
 

We can select the nested 'name' element value with
new XmlDynamic(xmlMessage).get("product.investment.info.current.name", ".").asString()

Also since XML has certain key name restrictions the pipe character '|' can be used as a splitter without declaration
ie new XmlDynamic(xmlMessage).get("product|investment|info|current|name").asString()

Author:

Alex Butler

See Also:

get(Object)

Field Summary

Fields inherited from class alexh.weak.AbstractDynamic

inner

Fields inherited from interface alexh.weak.Dynamic

ROOT_KEY

Constructor Summary

Constructors

Constructor and Description
XmlDynamic(InputSource xml)
XmlDynamic(Node inner)
XmlDynamic(Reader xml)
XmlDynamic(String xml)

Method Summary

Modifier and Type	Method and Description
String	asObject() Returns inner value implicitly asserting that the value is not absent, ie Weak.isPresent() is true
protected Stream<alexh.weak.XmlDynamic.Child>	attributes()
protected Stream<alexh.weak.XmlDynamic.Child>	attributesWith(Predicate<Node> predicate)
Stream<Dynamic>	children()
String	describe()
protected Stream<alexh.weak.XmlDynamic.Child>	elements()
protected Stream<alexh.weak.XmlDynamic.Child>	elementsWith(Predicate<Node> predicate)
boolean	equals(Object o)
String	fullXml()
Dynamic	get(Object keyObject) Returns a dynamic wrapping the immediate child of this instance with the input key, or a dynamic representing the lack of such a child.
protected Dynamic	getWithNamespace(String namespace, String key)
static Predicate<? super Dynamic>	hasElementName(String elementName) Predicate for an xml element's name as it appears in the xml itself (case insensitive) Inside the xml dynamic multiple elements with the same names have unique suffices ie 1 2 the 'child' elements have internal names 'child' and 'child[1]' a predicate dynamic -> dynamic.key().asString().equals("child") would only match the first hasElementName("child") matches both
int	hashCode()
boolean	is(Class<?> type) Dynamic Xml values are always Strings
protected Object	keyLiteral()
protected LSSerializer	serializer()
String	toString()

Methods inherited from class alexh.weak.AbstractDynamic

isPresent, key

Methods inherited from class java.lang.Object

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

Methods inherited from interface alexh.weak.Dynamic

allChildren, allChildrenBreadthFirst, allChildrenDepthFirst, as, dget, from, get

Methods inherited from interface alexh.weak.Weak

asList, asMap, asOptional, asString, convert, isList, isMap, isString, maybe

Constructor Detail

XmlDynamic

public XmlDynamic(Node inner)

XmlDynamic

public XmlDynamic(InputSource xml)

XmlDynamic

public XmlDynamic(Reader xml)

XmlDynamic

public XmlDynamic(String xml)

Method Detail

hasElementName

public static Predicate<? super Dynamic> hasElementName(String elementName)

Predicate for an xml element's name as it appears in the xml itself (case insensitive) Inside the xml dynamic multiple elements with the same names have unique suffices ie 1 2 the 'child' elements have internal names 'child' and 'child[1]' a predicate dynamic -> dynamic.key().asString().equals("child") would only match the first hasElementName("child") matches both

Parameters:

elementName - xml element name

Returns:

predicate to match XmlDynamic instances of elements with input name

is

public boolean is(Class<?> type)

Dynamic Xml values are always Strings

Specified by:

is in interface Weak<Dynamic>

Parameters:

type - type to test inner value with

Returns:

value is present and an instance of input type

get

public Dynamic get(Object keyObject)

Returns a dynamic wrapping the immediate child of this instance with the input key, or a dynamic representing the lack of such a child. This is never null.

The pipe character '|' can be used as a splitter without declaration ie xmlDynamic.get("product|investment|info|current|name").asString(). Multiple child elements with the same local-name effectively have [i] appended to them where i is their index counting from top to bottom. For example:

     <product id="1234">
         <string>hello</string>
         <string>hey</string>
         <string>hi</string>
         <string>howdy</string>
     </product>
 

xmlDynamic.get("product|string") returns "hello"
xmlDynamic.get("product|string[0]") also returns "hello"
xmlDynamic.get("product|string[1]") returns "hey"
xmlDynamic.get("product|string[2]") returns "hi"
xmlDynamic.get("product|string[3]") returns "howdy"

Attributes can be accessed in exactly the same way as elements, or explicitly
xmlDynamic.get("product|id").asString() return "1234"
xmlDynamic.get("product|@id").asString() also returns "1234"

Namespaces are ignored by default, but can be used explicitly using the "::" separator For example:

     <ex:product xmlns:ex="http://example.com/example">
         <message>hello</message>
     </ex:product>
 

xmlDynamic.get("product|message") returns "hello"
xmlDynamic.get("http://example.com/example::product|none::message") also returns "hello"

Specified by:

get in interface Dynamic

Parameters:

keyObject - child key

Returns:

dynamic representing the child matching the input key, or a dynamic representing the key's absence

getWithNamespace

protected Dynamic getWithNamespace(String namespace,
                                   String key)

attributes

protected Stream<alexh.weak.XmlDynamic.Child> attributes()

attributesWith

protected Stream<alexh.weak.XmlDynamic.Child> attributesWith(Predicate<Node> predicate)

elements

protected Stream<alexh.weak.XmlDynamic.Child> elements()

elementsWith

protected Stream<alexh.weak.XmlDynamic.Child> elementsWith(Predicate<Node> predicate)

children

public Stream<Dynamic> children()

Specified by:

children in interface Dynamic

Returns:

stream of all immediate children of this instance

keyLiteral

protected Object keyLiteral()

Specified by:

keyLiteral in class AbstractDynamic<Node>

describe

public String describe()

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDynamic<Node>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDynamic<Node>

serializer

protected LSSerializer serializer()

asObject

public String asObject()

Description copied from interface: Weak

Returns inner value implicitly asserting that the value is not absent, ie Weak.isPresent() is true

Specified by:

asObject in interface Weak<Dynamic>

Overrides:

asObject in class AbstractDynamic<Node>

Returns:

unwrapped inner value

fullXml

public String fullXml()

Returns:

this dynamic key->value entry as an XML string

toString

public String toString()

Overrides:

toString in class Object