org.xembly

Class Xembler

java.lang.Object

org.xembly.Xembler

@Immutable
@Loggable(value=1)
public final class Xembler
extends Object

Processor of Xembly directives, main entry point to the package.

For example, to modify a DOM document:

 Document dom = DocumentBuilderFactory.newInstance()
   .newDocumentBuilder().newDocument();
 dom.appendChild(dom.createElement("root"));
 new Xembler(
   new Directives()
     .xpath("/root")
     .addIfAbsent("employees")
     .add("employee")
     .attr("id", 6564)
 ).apply(dom);

You can also convert your Xembly directives directly to XML document:

 String xml = new Xembler(
   new Directives()
     .xpath("/root")
     .addIfAbsent("employees")
     .add("employee")
     .attr("id", 6564)
 ).xml("root");

Since version 0.18 you can convert directives to XML without a necessity to catch checked exceptions. Use *Quietly() methods for that: xmlQuietly(), domQuietly(), and applyQuietly(org.w3c.dom.Node).

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Suppressed Checkstyle violations:

ClassDataAbstractionCouplingCheck (500 lines)

Constructor Summary

Constructors

Constructor and Description
Xembler(Iterable<Directive> dirs) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
Node	apply(Node dom) Apply all changes to the document/node.
Node	applyQuietly(Node dom) Apply all changes to the document/node, without any checked exceptions.
Document	dom() Apply all changes to an empty DOM.
Document	domQuietly() Apply all changes to an empty DOM, without checked exceptions.
static String	escape(String text) Utility method to escape text before using it as a text value in XML.
String	xml() Convert to XML document.
String	xmlQuietly() Convert to XML document, without checked exceptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

Xembler

public Xembler(@NotNull(message="collection of directives can\'t be NULL")
       Iterable<Directive> dirs)

Public ctor.

Parameters:

dirs - Directives

Method Detail

applyQuietly

public Node applyQuietly(Node dom)

Apply all changes to the document/node, without any checked exceptions.

Parameters:

dom - DOM document/node

Returns:

The same document/node

Since:

0.18

apply

@Loggable(value=1,
          ignore=ImpossibleModificationException.class)
public Node apply(@NotNull(message="DOM can\'t be NULL")
                                                                  Node dom)
           throws ImpossibleModificationException

Apply all changes to the document/node.

Parameters:

dom - DOM document/node

Returns:

The same document/node

Throws:

ImpossibleModificationException - If can't modify

domQuietly

public Document domQuietly()

Apply all changes to an empty DOM, without checked exceptions.

Returns:

DOM created

Since:

0.18

dom

@Loggable(value=1,
          ignore=ImpossibleModificationException.class)
public Document dom()
             throws ImpossibleModificationException

Apply all changes to an empty DOM.

Returns:

DOM created

Throws:

ImpossibleModificationException - If can't modify

Since:

0.9

xmlQuietly

public String xmlQuietly()

Convert to XML document, without checked exceptions.

Returns:

XML document

Since:

0.18

xml

@Loggable(value=1,
          ignore=ImpossibleModificationException.class)
public String xml()
           throws ImpossibleModificationException

Convert to XML document.

Returns:

XML document

Throws:

ImpossibleModificationException - If can't modify

Since:

0.9

escape

public static String escape(String text)

Utility method to escape text before using it as a text value in XML.

Use it like this, in order to avoid runtime exceptions:

new Directives().xpath("/test")
   .set(Xembler.escape("illegal: "));

Parameters:

text - Text to escape

Returns:

The same text with escaped characters, which are not XML-legal

Since:

0.14

Suppressed Checkstyle violations:

MagicNumber (20 lines), CyclomaticComplexity (20 lines), BooleanExpressionComplexity (20 lines)