JAXB2 Annotate Plugin

JAXB2 Annotate Plugin adds arbitrary annotations to Java classes generated by JAXB/XJC.

License	License BSD 2-Clause License
Categories	Categories Net
GroupId	GroupId org.jvnet.jaxb2_commons
ArtifactId	ArtifactId jaxb2-basics-annotate
Last Version	Last Version 1.1.0
Release Date	Release Date Jun 6, 2018
Type	Type jar
Description	Description JAXB2 Annotate Plugin JAXB2 Annotate Plugin adds arbitrary annotations to Java classes generated by JAXB/XJC.

Download jaxb2-basics-annotate

Filename	Size
jaxb2-basics-annotate-1.1.0.pom
jaxb2-basics-annotate-1.1.0.jar	15 KB
jaxb2-basics-annotate-1.1.0-sources.jar	5 KB
jaxb2-basics-annotate-1.1.0-javadoc.jar	36 KB
Browse

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.jvnet.jaxb2_commons/jaxb2-basics-annotate/ -->
<dependency>
    <groupId>org.jvnet.jaxb2_commons</groupId>
    <artifactId>jaxb2-basics-annotate</artifactId>
    <version>1.1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.jvnet.jaxb2_commons/jaxb2-basics-annotate/
implementation 'org.jvnet.jaxb2_commons:jaxb2-basics-annotate:1.1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.jvnet.jaxb2_commons/jaxb2-basics-annotate/
implementation ("org.jvnet.jaxb2_commons:jaxb2-basics-annotate:1.1.0")

Apache Buildr

'org.jvnet.jaxb2_commons:jaxb2-basics-annotate:jar:1.1.0'

Apache Ivy

<dependency org="org.jvnet.jaxb2_commons" name="jaxb2-basics-annotate" rev="1.1.0">
  <artifact name="jaxb2-basics-annotate" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.jvnet.jaxb2_commons', module='jaxb2-basics-annotate', version='1.1.0')
)

Scala SBT

libraryDependencies += "org.jvnet.jaxb2_commons" % "jaxb2-basics-annotate" % "1.1.0"

Leiningen

[org.jvnet.jaxb2_commons/jaxb2-basics-annotate "1.1.0"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.jvnet.jaxb2_commons : jaxb2-basics-tools	jar	0.12.0
org.jvnet.annox : annox	jar	1.0.2

provided (1)

Group / Artifact	Type	Version
org.glassfish.jaxb : jaxb-xjc	jar	2.3.0

test (2)

Group / Artifact	Type	Version
junit : junit	jar	4.11
org.hamcrest : hamcrest-all	jar	1.3

Project Modules

There are no modules declared in this project.

jaxb2-annotate-plugin

JAXB2 Annotate Plugin is capable of adding or removing arbitrary annotations to/from the generated sources.

Usage overview

Annotate your schema using binding files or directly in schema
Add the plugin to the XJC classpath.
Add your annotation classes to the XJC classpath.
Activate the plugin using -Xannotate-switch.

Providing annotations

You can annotate your schema-derived elements using normal Java annotation syntax. (Old XML syntax is still supported but no longer recommended.)

Current limitations:

Annotation classes must be known in compile time. I.e. annotation classes must be made available in the XJC classpath. If you want to use your own annotations, you have to pre-compile them and add your annotation classes to the XJC classpath.
As a consequence, currently you can't use schema-derived enums in your annotations. Since you have to compile annotations before compiling the schema - and as your enums are first generated from the schema, this is a chicken-and-egg-problem.
All class names (classes of annotations or classes you use as values in annotations) must be fully qualified. Inner classes should use the dot (.) as delimiter (not $).

You can put your annotations directly in schema:

<xsd:schema
	xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
	xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
	jaxb:version="2.1" 
	xmlns:annox="http://annox.dev.java.net" 
	jaxb:extensionBindingPrefixes="annox">



	<xsd:complexType name="FooType">
		<xsd:annotation>
			<xsd:appinfo>
				<annox:annotate>@java.lang.SuppressWarnings({"unchecked","rawtypes"})</annox:annotate>
				<annox:annotate target="package">@javax.annotation.Generated({"XJC","JAXB2 Annotate Plugin"})</annox:annotate>
			</xsd:appinfo>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="bar" type="xsd:string"/>
			<xsd:element name="foobar" type="xsd:string">
				<xsd:annotation>
					<xsd:appinfo>
						<annox:annotate>@java.lang.SuppressWarnings({"unchecked","rawtypes"})</annox:annotate>
						<annox:annotate target="setter">@java.lang.Deprecated</annox:annotate>
						<annox:annotate target="setter-parameter">@java.lang.Deprecated</annox:annotate>
						<annox:annotate target="getter">@java.lang.Deprecated</annox:annotate>
						<annox:annotate target="field">@java.lang.Deprecated</annox:annotate>
						<annox:annotate target="class">@java.lang.Deprecated</annox:annotate>
					</xsd:appinfo>
				</xsd:annotation>
			</xsd:element>
		</xsd:sequence>
	</xsd:complexType>

    <xs:simpleType name="FooEnum">
        <xs:annotation>
            <xs:appinfo>
                <annox:annotateEnumValueMethod>@java.lang.Deprecated</annox:annotateEnumValueMethod>
            </xs:appinfo>
        </xs:annotation>

        <xs:restriction base="xs:string">
            <xs:enumeration value="BAR"/>
            <xs:enumeration value="BAZ"/>
        </xs:restriction>
    </xs:simpleType>

</xsd:schema>

Or in binding files:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jaxb:bindings
	xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" xmlns:xs="http://www.w3.org/2001/XMLSchema"
	xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:annox="http://annox.dev.java.net"
	xsi:schemaLocation="http://java.sun.com/xml/ns/jaxb http://java.sun.com/xml/ns/jaxb/bindingschema_2_0.xsd"
	jaxb:extensionBindingPrefixes="xjc annox"
	version="2.1">

	<jaxb:bindings schemaLocation="schema.xsd" node="/xs:schema">
		<jaxb:bindings node="xs:complexType[@name='issueJIIB39CType']">
			<annox:annotateClass>@javax.xml.bind.annotation.XmlRootElement(name="IssueJIIB39CType")</annox:annotateClass>
		</jaxb:bindings>
		<jaxb:bindings node="xs:complexType[@name='issueJIIB39CType']/xs:attribute[@name='test']">
			<annox:annotate target="field">@javax.xml.bind.annotation.XmlAttribute(required=false, name="test")</annox:annotate>
		</jaxb:bindings>
	</jaxb:bindings>

</jaxb:bindings>

You can use the following customization elements in the http://annox.dev.java.net namespace:

annotate with the optional target attribute
package
class
getter
setter
setter-parameter
field
enum-value-method
enum-fromValue-method
annotateProperty
annotatePackage
annotateClass
annotateElement
annotateEnum
annotateEnumConstant
annotateEnumValueMethod - annotate the value() method of the enum
annotateEnumFromValueMethod - annotate the fromValue(String) method of the enum

The http://annox.dev.java.net namespace must be declared in the jaxb:extensionBindingPrefixes attribute via prefix, ex.:

xmlns:annox="http://annox.dev.java.net"
jaxb:extensionBindingPrefixes="xjc annox"

Note: yes, I know that http://annox.dev.java.net no longer exists. Changing this namespace would break old builds. This is just a namespace, there must not necessarily be content there. Treat it as a logical identifier, nothing else.

Removing annotations

Customize your schema using binding files or directly in schema
Add the plugin to the XJC classpath.
Activate the plugin using -XremoveAnnotation-switch.

You can remove annotations using customizations directly in schema:

<xsd:schema
	xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
	xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
	jaxb:version="2.1" 
	xmlns:annox="http://annox.dev.java.net" 
	jaxb:extensionBindingPrefixes="annox">



	<xsd:complexType name="FooType">
		<xsd:annotation>
			<xsd:appinfo>
				<annox:removeAnnotation class="javax.xml.bind.annotation.XmlType" />
			</xsd:appinfo>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="bar" type="xsd:string"/>
			<xsd:element name="foobar" type="xsd:string">
				<xsd:annotation>
					<xsd:appinfo>
						<annox:removeAnnotation class="javax.xml.bind.annotation.XmlElement" target="field" />
					</xsd:appinfo>
				</xsd:annotation>
			</xsd:element>
		</xsd:sequence>
	</xsd:complexType>

</xsd:schema>

Or in binding files:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jaxb:bindings
	xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" xmlns:xs="http://www.w3.org/2001/XMLSchema"
	xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:annox="http://annox.dev.java.net"
	xsi:schemaLocation="http://java.sun.com/xml/ns/jaxb http://java.sun.com/xml/ns/jaxb/bindingschema_2_0.xsd"
	jaxb:extensionBindingPrefixes="xjc annox"
	version="2.1">

	<jaxb:bindings schemaLocation="schema.xsd" node="/xs:schema">
		<jaxb:bindings node="xs:complexType[@name='FooType']">
			<annox:removeAnnotation class="javax.xml.bind.annotation.XmlType" />
		</jaxb:bindings>
		<jaxb:bindings node="xs:complexType[@name='FooType']//xs:element[@name='foobar']">
			<annox:removeAnnotation class="javax.xml.bind.annotation.XmlElement" target="field" />
		</jaxb:bindings>
	</jaxb:bindings>

</jaxb:bindings>

You can use the following customization elements in the http://annox.dev.java.net namespace:

removeAnnotation with the optional target attribute:
package
class
getter
setter
setter-parameter
field
enum-value-method
enum-fromValue-method
removeAnnotationFromProperty
removeAnnotationFromPackage
removeAnnotationFromClass
removeAnnotationFromElement
removeAnnotationFromeEnum
removeAnnotationFromEnumConstant
removeAnnotationFromEnumValueMethod - removes annotation from the value() method of the enum
removeAnnotationFromEnumFromValueMethod - removes annotation from the fromValue(String) method of the enum

The http://annox.dev.java.net namespace must be declared in the jaxb:extensionBindingPrefixes attribute via prefix, ex.:

xmlns:annox="http://annox.dev.java.net"
jaxb:extensionBindingPrefixes="xjc annox"

Using JAXB2 Annotate Plugin with Maven

Add org.jvnet.jaxb2_commons:jaxb2-basics-annotate as XJC plugin
Turn on the plugin using -Xannotate or -XremoveAnnotationswitch
Add artifact with your annotations as another XJC plugin

Example:

<plugin>
	<groupId>org.jvnet.jaxb2.maven2</groupId>
	<artifactId>maven-jaxb2-plugin</artifactId>
	<configuration>
		<extension>true</extension>
		<args>
			<arg>-Xannotate</arg>
			<arg>-XremoveAnnotation</arg>
		</args>
		<plugins>
			<plugin>
				<groupId>org.jvnet.jaxb2_commons</groupId>
				<artifactId>jaxb2-basics-annotate</artifactId>
			</plugin>
			<!-- Artifact with custom annotations -->
			<plugin>
				<groupId>com.acme.foo</groupId>
				<artifactId>my-custom-annotations</artifactId>
			</plugin>
		</plugins>
	</configuration>
</plugin>

See this example.

Note that annotations are first compiled in the annotations module and the added to the classpath of the maven-jaxb2-plugin in the schema module:

Using JAXB2 Annotate Plugin with Ant

See this example.

Versions

Version
1.1.0 Jun 6, 2018
1.0.4 Oct 25, 2017
1.0.3 Aug 23, 2017
1.0.2 Aug 29, 2015
1.0.1 Sep 1, 2014
1.0.0 Aug 23, 2014
0.6.5 Sep 10, 2013
0.6.4 Jul 10, 2012
0.6.3 Oct 9, 2011
0.6.2 Jul 3, 2011
0.6.1 Mar 25, 2011
0.6.0 Jul 30, 2010
0.5.3 Jun 28, 2010
0.5.2 May 20, 2010
0.5.1 May 20, 2010
0.5.0 May 20, 2010

JAXB2 Annotate Plugin

License

Categories

GroupId

ArtifactId

Last Version

Release Date

Type

Description