Package com.github.djeang.vincerdom

Class VElement<P>

java.lang.Object

com.github.djeang.vincerdom.VElement<P>

public class VElement<P>
extends java.lang.Object

Wrapper for Element offering a Parent-Chaining fluent interface.

The underlying element may exist or not. If the underlying element does not exist, a proxy element is used in place but write methods are disabled. The concrete w3c element can be created afterward using the make() method.

Field Summary

Fields

Modifier and Type	Field	Description
P	__

Method Summary

Modifier and Type	Method	Description
VElement<VElement<P>>	add(java.lang.String name)	Adds a child element of the specified name on the underlying element.
VElement<P>	addSibling(java.lang.String name)	Adds a sibling element of the specified name just before this one.
VElement<P>	apply(java.util.function.Consumer<VElement<?>> consumer)	Runs the specified consumer with this element as argument.
java.lang.String	attr(java.lang.String name)	Returns the value of the specified attribute on this element.
VElement<P>	attr(java.lang.String name, java.lang.String value)	Adds the specified attribute name/value on the underlying element.
VElement	child(java.lang.String name)	Returns the child first child of this element having the specified name.
java.util.List<VElement>	children(java.lang.String name)	Returns an unmodifiable list of the child elements having the specified name.
boolean	exist()	Returns true if the underlying element exist.
VElement<VElement<P>>	get(java.lang.String name)	Returns the first child element of the underlying element having the specified name.
java.lang.String	getText()	Returns the text pof the underlying element.
org.w3c.dom.Element	getW3cElement()	Returns the underlying w3cElement.
VElement<P>	make()	Creates the underlying element and its non-existing parents.
static VElement<java.lang.Void>	of(org.w3c.dom.Element element)	Creates a VElement wrapping the specified element.
static <P> VElement	of(P parent, org.w3c.dom.Element element)	Creates a VElement wrapping the specified parent and element.
VElement<P>	remove()	Removes the underlying element from its parent children.
VElement<P>	removeAttr(java.lang.String name)	Removes the specified attribute of the specified name from the underlying element.
VElement<P>	text(java.lang.String text)	Sets the specified text on the underlying element.
java.lang.String	toString()
java.util.List<VElement>	xPath(java.lang.String xPathExpression)	Returns an unmodifiable list of elements matching the specified xPath expression.
java.util.List<VElement>	xPath(javax.xml.xpath.XPathExpression xPathExpression)	Returns an unmodifiable list of elements matching the specified xPath expression.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

__

public final P __

Method Detail

of

public static VElement<java.lang.Void> of(org.w3c.dom.Element element)

Creates a VElement wrapping the specified element.

of

public static <P> VElement of(P parent,
                              org.w3c.dom.Element element)

Creates a VElement wrapping the specified parent and element.

getW3cElement

public org.w3c.dom.Element getW3cElement()

Returns the underlying w3cElement. This element can be null if this VElement does not exist.

attr

public VElement<P> attr(java.lang.String name,
                        java.lang.String value)

Adds the specified attribute name/value on the underlying element.

Throws:

java.lang.IllegalStateException - if the underlying element does not exist.

attr

public java.lang.String attr(java.lang.String name)

Returns the value of the specified attribute on this element. Returns null if no such attribute exists.

removeAttr

public VElement<P> removeAttr(java.lang.String name)

Removes the specified attribute of the specified name from the underlying element.

Throws:

java.lang.IllegalStateException - if the underlying element does not exist.

text

public VElement<P> text(java.lang.String text)

Sets the specified text on the underlying element.

Throws:

java.lang.IllegalStateException - if the underlying element does not exist.

getText

public java.lang.String getText()

Returns the text pof the underlying element. null if the underlying element does not exist.

add

public VElement<VElement<P>> add(java.lang.String name)

Adds a child element of the specified name on the underlying element. This methods returns the newly created element.

Throws:

java.lang.IllegalStateException - if the underlying element does not exist.

get

public VElement<VElement<P>> get(java.lang.String name)

Returns the first child element of the underlying element having the specified name.

If no such element exist, this method returns a proxy element that let creation possible afterward.

children

public java.util.List<VElement> children(java.lang.String name)

Returns an unmodifiable list of the child elements having the specified name. Returns an empty list if the underlying element does not exist.

child

public VElement child(java.lang.String name)

Returns the child first child of this element having the specified name. Returns null if the underlying element does not exist or no such named child exists.

xPath

public java.util.List<VElement> xPath(javax.xml.xpath.XPathExpression xPathExpression)

Returns an unmodifiable list of elements matching the specified xPath expression.

xPath

public java.util.List<VElement> xPath(java.lang.String xPathExpression)

Returns an unmodifiable list of elements matching the specified xPath expression.

addSibling

public VElement<P> addSibling(java.lang.String name)

Adds a sibling element of the specified name just before this one. This method returns the newly created element.

remove

public VElement<P> remove()

Removes the underlying element from its parent children.

apply

public VElement<P> apply(java.util.function.Consumer<VElement<?>> consumer)

Runs the specified consumer with this element as argument.

exist

public boolean exist()

Returns true if the underlying element exist.

make

public VElement<P> make()

Creates the underlying element and its non-existing parents. Does nothing if the underlying element already exists.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object