JkDomElement

java.lang.Object
- dev.jeka.core.api.marshalling.xml.JkDomElement

```
public final class JkDomElement
extends java.lang.Object
```
Borrowed from VincerDom https://github.com/djeang/vincer-dom 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 and Description

JkDomElement __

Fields
Modifier and Type	Field and Description
`JkDomElement`	`__`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JkDomElement`	`add(java.lang.String name)` Adds a child element of the specified name on the underlying element.
`JkDomElement`	`addSibling(java.lang.String name)` Adds a sibling element of the specified name just before this one.
`JkDomElement`	`apply(java.util.function.Consumer<JkDomElement> consumer)` Runs the specified consumer with this element as argument.
`JkDomElement`	`applyIf(boolean condition, java.util.function.Consumer<JkDomElement> 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.
`JkDomElement`	`attr(java.lang.String name, java.lang.String value)` Adds the specified attribute name/value on the underlying element.
`JkDomElement`	`child(java.lang.String name)` Returns the child first child of this element having the specified name.
`JkDomElement`	`child(java.lang.String name, java.util.function.Predicate<JkDomElement> predicate)` Returns the child first child of this element having the specified name and verifying the specified predicate.
`java.util.List<JkDomElement>`	`children(java.lang.String name)` Returns an unmodifiable list of the child elements having the specified name.
`java.util.List<JkDomElement>`	`children(java.lang.String name, java.util.function.Predicate<JkDomElement> predicate)` Returns an unmodifiable list of the child elements having the specified name and verifying the specified predicate.
`boolean`	`exist()` Returns `true` if the underlying element exist.
`JkDomElement`	`get(java.lang.String name)` Returns the first child element of the underlying element having the specified name.
`JkDomDocument`	`getDoc()`
`org.w3c.dom.Element`	`getW3cElement()` Returns the underlying w3cElement.
`JkDomElement`	`make()` Creates the underlying element and its non-existing parents.
`static JkDomElement`	`of(org.w3c.dom.Element element)` Creates a VElement wrapping the specified element.
`static <P> JkDomElement`	`of(JkDomElement parent, org.w3c.dom.Element element)` Creates a VElement wrapping the specified parent and element.
`JkDomElement`	`remove()` Removes the underlying element from its parent children.
`JkDomElement`	`removeAttr(java.lang.String name)` Removes the specified attribute of the specified name from the underlying element.
`java.lang.String`	`text()` Returns the text pof the underlying element.
`JkDomElement`	`text(java.lang.String text)` Sets the specified text on the underlying element.
`java.lang.String`	`toString()`
`java.util.List<JkDomElement>`	`xPath(java.lang.String xPathExpression)` Returns an unmodifiable list of elements matching the specified xPath expression.
`java.util.List<JkDomElement>`	`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 JkDomElement __
```
- Method Detail
  - of
```
public static JkDomElement of(org.w3c.dom.Element element)
```
    Creates a VElement wrapping the specified element.
  - of
```
public static <P> JkDomElement of(JkDomElement 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 JkDomElement 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 JkDomElement 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 JkDomElement text(java.lang.String text)
```
    Sets the specified text on the underlying element.
    
    Throws:
    
    java.lang.IllegalStateException - if the underlying element does not exist.
  - text
```
public java.lang.String text()
```
    Returns the text pof the underlying element. null if the underlying element does not exist.
  - add
```
public JkDomElement add(java.lang.String name)
```
    Adds a child element of the specified name on the underlying element. This method returns the newly created element.
    
    Throws:
    
    java.lang.IllegalStateException - if the underlying element does not exist.
  - get
```
public JkDomElement 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<JkDomElement> children(java.lang.String name,
                                             java.util.function.Predicate<JkDomElement> predicate)
```
    Returns an unmodifiable list of the child elements having the specified name and verifying the specified predicate. Returns an empty list if the underlying element does not exist.
  - children
```
public java.util.List<JkDomElement> 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 JkDomElement child(java.lang.String name,
                          java.util.function.Predicate<JkDomElement> predicate)
```
    Returns the child first child of this element having the specified name and verifying the specified predicate. Returns null if the underlying element does not exist or no such named child exists.
  child public JkDomElement 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<JkDomElement> xPath(javax.xml.xpath.XPathExpression xPathExpression) Returns an unmodifiable list of elements matching the specified xPath expression. xPath public java.util.List<JkDomElement> xPath(java.lang.String xPathExpression) Returns an unmodifiable list of elements matching the specified xPath expression. addSibling public JkDomElement 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 JkDomElement remove() Removes the underlying element from its parent children. apply public JkDomElement apply(java.util.function.Consumer<JkDomElement> consumer) Runs the specified consumer with this element as argument. applyIf public JkDomElement applyIf(boolean condition, java.util.function.Consumer<JkDomElement> consumer) Runs the specified consumer with this element as argument. getDoc public JkDomDocument getDoc() exist public boolean exist() Returns true if the underlying element exist. make public JkDomElement 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

Class JkDomElement

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__

Method Detail

of

of

getW3cElement

attr

attr

removeAttr

text

text

add

get

children

children

child

child

xPath

xPath

addSibling

remove

apply

applyIf

getDoc

exist

make

toString