com.rexsl.page

Class JaxbBundle

java.lang.Object

com.rexsl.page.JaxbBundle

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

JAXB bundle.

It's a convenient instrument that enables on-fly creation of DOM/XML structures, for example (fluent interface):

 Element element = new JaxbBundle("root")
   .add("employee")
     .attr("age", "28")
     .add("dept", "Software")
       .attr("country", "DE")
     .up()
     .add("salary", "> \u20AC 50,000")
     .up()
     .add("rank", "high")
   .up()
   .attr("time", new Date())
   .element();

If you convert this element to XML this is how it will look:

 <?xml version="1.0" ?>
 <root time="Sun Jul 20 16:17:00 EDT 1969">
   <employee age="28">
     <dept country="DE">Software</dept>
     <salary>&gt; € 50,000</salary>
     <rank>high</rank>
   </employee>
 </root>

Then, you can add this Element to your JAXB object, and return it from a method annotated with XmlElement, for example:

 @XmlRootElement
 public class Page {
   @XmlElement
   public Object getEmployee() {
     return new JaxbBundle("employee")
       .attr("age", "35")
       .attr("country", "DE")
       .add("salary", "> \u20AC 50,000")
       .up()
       .element();
   }
 }

This mechanism, very often, is much more convenient and shorter than a declaration of a new POJO every time you need to return a small piece of XML data.

Since version 0.4.10 it's possible to add links, groups, and other bundles. For example:

 final Element element = new JaxbBundle("garage")
   .link(new Link("add", "/add-car"))
   .add("cars").add(
     new JaxbBundle.Group<String>(cars) {
       @Override
       public JaxbBundle bundle(Car car) {
         return new JaxbBundle("car").add("make", car.make()).up();
       }
     }
   ).up()
   .add(new JaxbBundle("owner").add("email", "...").up())
   .element();

The class is mutable and thread-safe.

Since:

0.3.7

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JaxbBundle.Group<T> Group.

Constructor Summary

Constructors

Constructor and Description
JaxbBundle() Default ctor, for JAXB (always throws a runtime exception).
JaxbBundle(String nam) Public ctor, with just a name of XML element and no text content.
JaxbBundle(String nam, String text) Public ctor, with XML element name and its content.

Method Summary

Methods

Modifier and Type	Method and Description
JaxbBundle	add(Element element) Add new child XML element.
JaxbBundle	add(JaxbBundle.Group<?> group) Add new group.
JaxbBundle	add(JaxbBundle bundle) Add new bundle.
JaxbBundle	add(String nam) Add new child XML element.
JaxbBundle	add(String nam, String txt) Add new child with text value.
JaxbBundle	attr(String nam, String val) Add XML attribute to this bundle.
Element	element() Convert this bundle into DOM/XML Element.
JaxbBundle	link(Link link) Add new link into &lt;links&gt; section.
JaxbBundle	up() Return parent bundle.

Methods inherited from class java.lang.Object

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

Constructor Detail

JaxbBundle

public JaxbBundle()

Default ctor, for JAXB (always throws a runtime exception).

You're not supposed to use this constructor. Instead, use either JaxbBundle(String) or JaxbBundle(String,String).

JaxbBundle

public JaxbBundle(@NotNull
          String nam)

Public ctor, with just a name of XML element and no text content.

Parameters:

nam - The name of XML element

JaxbBundle

public JaxbBundle(@NotNull
          String nam,
          @NotNull
          String text)

Public ctor, with XML element name and its content.

Parameters:

nam - The name of XML element

text - Text content of the XML document

Method Detail

add

@NotNull
public JaxbBundle add(@NotNull
                     String nam)

Add new child XML element.

Parameters:

nam - The name of child element

Returns:

The child bundle (use up() on it in order to get back to the parent bundle)

add

@NotNull
public JaxbBundle add(@NotNull
                     Element element)

Add new child XML element.

Parameters:

element - The DOM element to add

Returns:

The same bundle

Since:

0.4.15

add

@NotNull
public JaxbBundle add(@NotNull
                     String nam,
                     @NotNull
                     String txt)

Add new child with text value.

Parameters:

nam - The name of child

txt - The text

Returns:

The child bundle (use up() on it in order to get back to the parent bundle)

attr

@NotNull
public JaxbBundle attr(@NotNull
                      String nam,
                      @NotNull
                      String val)

Add XML attribute to this bundle.

Parameters:

nam - The name of attribute

val - The plain text value

Returns:

New bundle with set attribute

link

@NotNull
public JaxbBundle link(@NotNull
                      Link link)

Add new link into <links> section.

Parameters:

link - The link to attach

Returns:

New bundle with a newly added link

Since:

0.4.10

add

@NotNull
public JaxbBundle add(@NotNull
                     JaxbBundle bundle)

Add new bundle.

Parameters:

bundle - The bundle to add

Returns:

New bundle with a newly added element

Since:

0.4.10

add

@NotNull
public JaxbBundle add(@NotNull
                     JaxbBundle.Group<?> group)

Add new group.

Parameters:

group - The group

Returns:

New bundle with a newly added group of elements

Since:

0.4.10

up

@NotNull
public JaxbBundle up()

Return parent bundle.

Returns:

The parent bundle

element

@NotNull
public Element element()

Convert this bundle into DOM/XML Element.

Returns:

The element