An alternative API for working with XML files using JAXB.
Minimum of Java 8 required. Joda Time 2 also required if using any of the Joda Time adapters (JodaDateTimeAdapter or JodaLocalDateAdapter).
Add a dependency to your project with the following co-ordinates:
- GroupId:
nz.net.ultraq.jaxb - ArtifactId:
jaxb-utilities - Version: (as per the badges above)
Check the project releases for a list of available versions. Each release page also includes a downloadable JAR if you want to manually add it to your project classpath.
Wraps the job of unmarshalling XML content into a Java object, adding methods for enabling validation against a schema or schemas during unmarshalling.
Example usage:
XmlReader<YourClass> xmlReader = new XmlReader<>(YourClass.class);
xmlReader.addValidatingSchema(new File("YourSchema.xsd"));
YourClass instance = xmlReader.read(source);Wraps the job of marshalling Java objects back into XML files, adding methods for enabling CDATA sections, mapping namespaces to custom prefixes, and validating against a schema or schemas during marshalling.
Example usage:
XmlWriter<YourClass> xmlWriter = new XmlWriter<>(YourClass.class);
xmlWriter.setFormatOutput(true);
xmlWriter.write(instance, new File("Output.xml"));Used in conjunction with XmlWriter and its setUseCDataSections() method,
causes JAXB to write CDATA sections instead of the usual XML-escaped strings
that it produces. Handy when your string content contains lots of XML-reserved
characters (eg: HTML or XML content).
To generate classes from a schema that use this adapter, annotate the string property you want to be converted into a CDATA-aware string instead:
<xsd:element name="html-content" type="xsd:string">
<xsd:annotation>
<xsd:appinfo>
<jxb:property>
<xjc:javaType
adapter="nz.net.ultraq.jaxb.adapters.CDataAdapter"
name="java.lang.String"/>
</jxb:property>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>Alternatively, to have JAXB write CDATA sections into XML files from your existing Java classes, annotate the string property like so:
@XmlJavaTypeAdapter(CDataAdapter.class)
protected String htmlContent;Then, set the XmlWriter to output CDATA sections:
XmlWriter<YourClass> xmlWriter = new XmlWriter<>();
xmlWriter.setUseCDATASections(true);The next time you use one of XmlWriter's write methods, the resulting XML
will wrap the element you've annotated in a CDATA section:
<html-content><![CDATA[
I'm an element containing <html> content, but I <i>won't</i> get
escaped because this is a CDATA section
]]></html-content>Marshal/unmarshal XML dates/times to the Joda
DateTime object.
To generate classes from a schema that use this adapter, annotate the XML date/time
property you want to be converted into a Joda DateTime instead:
<xsd:element name="date" type="xsd:date">
<xsd:annotation>
<xsd:appinfo>
<jxb:property>
<xjc:javaType
adapter="nz.net.ultraq.jaxb.adapters.JodaDateTimeAdapter"
name="org.joda.time.DateTime"/>
</jxb:property>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>Alternatively, to have existing Java classes that use Joda DateTime map to XML
date/time, annotate your date properties like so:
@XmlJavaTypeAdapter(JodaDateTimeAdapter.class)
@XmlSchemaType(name = "date")
private DateTime date;Similar usage to the JodaDateTimeAdapter, instead using
Joda LocalDate objects. Just swap JodaDateTimeAdapter for JodaLocalDateAdapter
in the examples above.
