Home » Java » Enterprise Java » JAXB and Unmapped Properties

About Blaise Doughan

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

JAXB and Unmapped Properties

JAXB (JSR-222) is configuration by exception, meaning that there is a default mapping applied to domain objects. This means that sometimes you need to explicitly exclude a field/property. In this post I’ll discuss how this can be done using @XmlTransient or @XmlAccessorType(XmlAccessType.NONE) and when each option is appropriate.

@XmlTransient

When you mark a field/property with @XmlTransient you are explicitly telling your JAXB implementation to treat it as an unmapped property. This is useful when less than half of the fields/properties are unmapped.

package blog.unmapped;
 
import java.util.List;
import javax.xml.bind.annotation.*;
 
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer {
 
    @XmlTransient
    private int id;
 
    private String firstName;
 
    private String lastName;
 
    private Address billingAddress;
 
    private Address shippingAddress;
 
    private List<PhoneNumber> phoneNumbers;
 
}

If more than half of the fields/properties are unmapped then we stop gaining the benefit of configuration by exception since we need to do more work to exclude properties with @XmlTransient than we would have had to do to map the mapped properties. Next I’ll demonstrate how we can leverage @XmlAccessorType(XmlAccessType.NONE) for this use case.

package blog.unmapped;
 
import java.util.List;
import javax.xml.bind.annotation.*;
 
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer {
 
    @XmlTransient
    private int id;
 
    private String firstName;
 
    private String lastName;
 
    @XmlTransient
    private Address billingAddress;
 
    @XmlTransient
    private Address shippingAddress;
 
    @XmlTransient
    private List<PhoneNumber> phoneNumbers;
 
}

@XmlAccessorType(XmlAccessType.NONE)

By setting @XmlAccessorType(XmlAccessType.NONE) we are disabling configuration by exception. Now only explicitly mapped properties will be mapped. This is useful when less than half of the fields/properties of a domain object are mapped.

package blog.unmapped;
 
import java.util.List;
import javax.xml.bind.annotation.*;
 
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer {
 
    @XmlTransient
    private int id;
 
    private String firstName;
 
    private String lastName;
 
    @XmlTransient
    private Address billingAddress;
 
    @XmlTransient
    private Address shippingAddress;
 
    @XmlTransient
    private List<PhoneNumber> phoneNumbers;
 
}

Further Reading

If you enjoyed this post then you also like:

Reference: JAXB and Unmapped Properties from our JCG partner Blaise Doughan at the Java XML & JSON Binding blog.

Do you want to know how to develop your skillset to become a Java Rockstar?

Subscribe to our newsletter to start Rocking right now!

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 ....

 

2 comments

  1. Your last example with @XmlAccessorType(XmlAccessType.NONE) doesn’t do what it claims. You still have marked the fields @XMLTransient. Besides how does one explicitly mark a property?

  2. Looks like the code snippet for @XmlAccessorType(XmlAccessType.NONE) is wrong, may be copy paste error?

Leave a Reply

Your email address will not be published. Required fields are marked *

*


Want to take your Java Skills to the next level?
Grab our programming books for FREE!
  • Save time by leveraging our field-tested solutions to common problems.
  • The books cover a wide range of topics, from JPA and JUnit, to JMeter and Android.
  • Each book comes as a standalone guide (with source code provided), so that you use it as reference.
Last Step ...

Where should we send the free eBooks?

Good Work!
To download the books, please verify your email address by following the instructions found on the email we just sent you.