com.rexsl.page

Class JaxbGroup

java.lang.Object

com.rexsl.page.JaxbGroup

public final class JaxbGroup
extends Object

JAXB group of elements.

A convenient utility class that enables on-fly creation of JAXB annotated collections of elements, for example:

 @XmlRootElement
 public class Page {
   @XmlElement
   public Object getEmployees() {
     Collection<Employee> employees = this.retrieve();
     return JaxbGroup.build(employees, "employee");
   }
 }

It's even more convenient in combination with JaxbBundle, for example:

 @XmlRootElement
 public class Page {
   @XmlElement
   public Object getEmployee() {
     return new JaxbBundle("employee")
       .attr("age", "45")
       .add("depts", JaxbGroup.build(this.depts(), "dept"))
       .up()
       .element();
   }
 }

The class is immutable and thread-safe.

Since:

0.3.7

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Constructor Summary

Constructors

Constructor and Description
JaxbGroup() Public ctor, for JAXB (always throws a runtime exception).

Method Summary

Methods

Modifier and Type	Method and Description
static Object	build(Collection<?> grp, String name) Creates a new JAXB-annotated collection of elements.
Collection<?>	getGroup() Get group of elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

JaxbGroup

public JaxbGroup()

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

Method Detail

build

@NotNull
public static Object build(@NotNull(message="group can\'t be NULL")
                   Collection<?> grp,
                   @NotNull(message="name can\'t be NULL")
                   String name)

Creates a new JAXB-annotated collection of elements.

Parameters:

grp - Group of elements (JAXB-annotated)

name - Name of parent XML element

Returns:

JAXB-annotated object, just created

getGroup

@NotNull(message="collection is never NULL")
public Collection<?> getGroup()

Get group of elements.

Returns:

The collection