Enterprise Java

Binding to JSON & XML – Handling Collections

One of EclipseLink JAXB (MOXy)‘s strengths is the ability to map an object model to both JSON and XML with a single set of metadata. The one weakness had been that you needed to compromise on the JSON key or XML element for collection properties. I’m happy to say that this issue has been solved in EclipseLink 2.5 (and EclipseLink 2.4.2), and I will demonstrate below with an example. You can try this out today by downloading an EclipseLink 2.5.0 (or EclipseLink 2.4.2) nightly build starting on March 15, 2013 from:

Domain Model

By default a JAXB (JSR-222) implementation will not output a grouping element around collection data. This can be done through the use of the @XmlElementWrapper annotation (see: J AXB & Collection Properties
). This grouping element often has a plural name and is a better fit for the key of a JSON array than the repeating element defined by the @XmlElement annotation is.

package blog.json.collections;

import java.util.*;
import javax.xml.bind.annotation.*;

@XmlType(propOrder={'name', 'emailAddresses'})
public class Customer {

    private String name;
    private List<String> emailAddresses = new ArrayList<String>();

    public String getName() {
        return name;

    public void setName(String name) {
        this.name = name;

    public List<String> getEmailAddresses() {
        return emailAddresses;

    public void setEmailAddresses(List&lt'String> emailAddresses) {
        this.emailAddresses = emailAddresses;



We will specify the JSON_WRAPPER_AS_ARRAY_NAME property with a true value to tell MOXy that it should use the grouping element as the name for the JSON array value. Then we will use the same Marshaller to output the same object to both XML and JSON.

package blog.json.collections;

import java.util.*;
import javax.xml.bind.*;
import org.eclipse.persistence.jaxb.MarshallerProperties;

public class Demo {

    public static void main(String[] args) throws Exception {
        Customer customer = new Customer();
        customer.setName('Jane Doe');

        Map<String, Object> properties = new HashMap<String, Object>(1);
        properties.put(MarshallerProperties.JSON_WRAPPER_AS_ARRAY_NAME, true);
        JAXBContext jc = JAXBContext.newInstance(new Class[] {Customer.class}, properties);

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);

        // Output XML
        marshaller.marshal(customer, System.out);

        // Output JSON
        marshaller.setProperty(MarshallerProperties.MEDIA_TYPE, 'application/json');
        marshaller.marshal(customer, System.out);


XML Output

Below is the XML output from running the demo code. We see that email-addresses is marshalled as the grouping element which contains an email-address element for each item in the collection.

<?xml version='1.0' encoding='UTF-8'?>
   <name>Jane Doe</name>

JSON Output

The following JSON output is produced from the same metadata. The only difference is that we told MOXy to use the grouping element as the name for JSON array values.

   'customer' : {
      'name' : 'Jane Doe',
      'email-addresses' : [ 'jane.doe@example.com', 'jdoe@example.org' ]


You can easily use MOXy as your JSON-binding provider in a JAX-RS environment (see: MOXy as your JAX-RS JSON Provider – MOXyJsonProvider). You can specify that the grouping element should be used as the JSON array name with the wrapperAsArrayName property on MOXyJsonProvider.

package blog.json.collections;

import java.util.*;
import javax.ws.rs.core.Application;
import org.eclipse.persistence.jaxb.rs.MOXyJsonProvider;

public class CustomerApplication  extends Application {

    public Set<Class<?>> getClasses() {
        HashSet<Class<?>> set = new HashSet<Class<?>>(1);
        return set;

    public Set<Object> getSingletons() {
        MOXyJsonProvider moxyJsonProvider = new MOXyJsonProvider();

        HashSet<Object> set = new HashSet<Object>(1);
        return set;



Reference: Binding to JSON & XML – Handling Collections from our JCG partner Blaise Doughan at the Java XML & JSON Binding blog.

Want to know how to develop your skillset to become a Java Rockstar?

Join our newsletter to start rocking!

To get you started we give you our best selling eBooks for FREE!


1. JPA Mini Book

2. JVM Troubleshooting Guide

3. JUnit Tutorial for Unit Testing

4. Java Annotations Tutorial

5. Java Interview Questions

6. Spring Interview Questions

7. Android UI Design


and many more ....


Receive Java & Developer job alerts in your Area

I have read and agree to the terms & conditions


Blaise Doughan

Team lead for the TopLink/EclipseLink JAXB & SDO implementations, and the Oracle representative on those specifications.
Notify of

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Newest Most Voted
Inline Feedbacks
View all comments
9 years ago

try it http://codebeautify.org/
its one of the good online editor for xml and json as well as other script.

Helmuth Stockmann
Helmuth Stockmann
8 years ago

Hi Blaise,

Looks exactly like what I need… however, I keep getting this error:

property “eclipselink.media-type” is not supported

And can’t find any relevant information online regarding this error. Are you able to help?

6 years ago

You can convert xml to json or json to xml using the website http://codeamaze.com You can convert xml to multiple format json csv tsv etc

Back to top button