JAXB Annotate Plugin adds annoations to getters that return an enum type value

[kermit-the-frog]

I've got a problem with the JAXB Annotate Plugin and annotations for enum types. There are unwanted/unexpected annotations on getters that return an enum type value.

sample.xsd:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns="http://www.example.org/sample"
           xmlns:xs="http://www.w3.org/2001/XMLSchema"
           targetNamespace="http://www.example.org/sample"
           elementFormDefault="qualified" attributeFormDefault="unqualified">
    <xs:simpleType name="enumType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="VALUE_1"/>
            <xs:enumeration value="VALUE_2"/>
            <xs:enumeration value="VALUE_3"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:complexType name="enumWithCommentType">
        <xs:simpleContent>
            <xs:extension base="enumType">
                <xs:attribute name="comment" type="xs:string" use="optional"/>
            </xs:extension>
        </xs:simpleContent>
    </xs:complexType>
</xs:schema>

sample.jxb:

<?xml version="1.0" encoding="UTF-8"?>
<jaxb:bindings xmlns:jaxb="https://jakarta.ee/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="3.0"
               xmlns:namespace="urn:jaxb.jvnet.org:plugin:namespace-prefix"
               xmlns:annox="urn:jaxb.jvnet.org:annox">
    <jaxb:bindings schemaLocation="sample.xsd">
        <jaxb:bindings>
            <namespace:prefix name="sample"/>
        </jaxb:bindings>
        <jaxb:bindings node="//xsd:simpleType[@name='enumType']">
            <annox:annotate>
                <annox:annotate annox:class="org.example.annotation.SampleAnnotation"/>
            </annox:annotate>
            <jaxb:bindings multiple="true" node="xsd:restriction/xsd:enumeration">
                <annox:annotate>
                    <annox:annotate annox:class="java.lang.Deprecated"/>
                </annox:annotate>
            </jaxb:bindings>
        </jaxb:bindings>
    </jaxb:bindings>
</jaxb:bindings>

SampleAnnotation.java:

package org.example.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.TYPE, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface SampleAnnotation
{
}

Resulting EnumType.java

//
// This file was generated by the Eclipse Implementation of JAXB, v4.0.6 
// See https://eclipse-ee4j.github.io/jaxb-ri 
// Any modifications to this file will be lost upon recompilation of the source schema. 
//


package org.example.sample;

import jakarta.xml.bind.annotation.XmlEnum;
import jakarta.xml.bind.annotation.XmlType;
import org.example.annotation.SampleAnnotation;


/**
 * 
 * 
 * <p>Java class for enumType</p>.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.</p>
 * <pre>{@code
 * <simpleType name="enumType">
 *   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
 *     <enumeration value="VALUE_1"/>
 *     <enumeration value="VALUE_2"/>
 *     <enumeration value="VALUE_3"/>
 *   </restriction>
 * </simpleType>
 * }</pre>
 * 
 */
@XmlType(name = "enumType")
@XmlEnum
@SampleAnnotation
public enum EnumType {

    VALUE_1,
    VALUE_2,
    VALUE_3;

    public String value() {
        return name();
    }

    public static EnumType fromValue(String v) {
        return valueOf(v);
    }

}

Resulting EnumWithCommentType.java

//
// This file was generated by the Eclipse Implementation of JAXB, v4.0.6 
// See https://eclipse-ee4j.github.io/jaxb-ri 
// Any modifications to this file will be lost upon recompilation of the source schema. 
//


package org.example.sample;

import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlType;
import jakarta.xml.bind.annotation.XmlValue;
import org.example.annotation.SampleAnnotation;


/**
 * <p>Java class for enumWithCommentType complex type</p>.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.</p>
 * 
 * <pre>{@code
 * <complexType name="enumWithCommentType">
 *   <simpleContent>
 *     <extension base="<http://www.example.org/sample>enumType">
 *       <attribute name="comment" type="{http://www.w3.org/2001/XMLSchema}string" />
 *     </extension>
 *   </simpleContent>
 * </complexType>
 * }</pre>
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "enumWithCommentType", propOrder = {
    "value"
})
public class EnumWithCommentType {

    @XmlValue
    protected EnumType value;
    @XmlAttribute(name = "comment")
    protected String comment;

    /**
     * Gets the value of the value property.
     * 
     * @return
     *     possible object is
     *     {@link EnumType }
     *     
     */
    @SampleAnnotation
    public EnumType getValue() {
        return value;
    }

    /**
     * Sets the value of the value property.
     * 
     * @param value
     *     allowed object is
     *     {@link EnumType }
     *     
     */
    public void setValue(EnumType value) {
        this.value = value;
    }

    /**
     * Gets the value of the comment property.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getComment() {
        return comment;
    }

    /**
     * Sets the value of the comment property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setComment(String value) {
        this.comment = value;
    }

}

As you can see there are two occurences of @SampleAnnotation. One at the enum declaration in EnumType.java. An one at the getter public EnumType getValue() in EnumWithCommentType. The first one ist wanted/expected. The second one is unwanted/unexpected. Is this a bug or a configuration issue?

Kind regards,
Martin

[laurentschoelens]

Hi @kermit-the-frog

Could you share the configuration part of the plugin in your pom.xml ?

Thanks

[kermit-the-frog]

Sure:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.example</groupId>
        <artifactId>parent</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>org.example</groupId>
    <artifactId>jaxb</artifactId>
    <packaging>jar</packaging>
    <name>${project.artifactId}-${project.version}</name>

    <build>
        <plugins>
            <plugin>
                <groupId>org.jvnet.jaxb</groupId>
                <artifactId>jaxb-maven-plugin</artifactId>
                <version>4.0.12</version>
                <dependencies>
                    <dependency>
                        <groupId>org.jvnet.jaxb</groupId>
                        <artifactId>jaxb-plugin-annotate</artifactId>
                        <version>4.0.12</version>
                    </dependency>
                    <dependency>
                        <groupId>org.jvnet.jaxb</groupId>
                        <artifactId>jaxb-plugins</artifactId>
                        <version>4.0.12</version>
                    </dependency>
                    <dependency>
                        <groupId>org.example</groupId>
                        <artifactId>annotations</artifactId>
                        <version>${project.parent.version}</version>
                        <scope>compile</scope>
                    </dependency>
                </dependencies>
                <configuration>
                    <extension>true</extension>
                    <enableIntrospection>true</enableIntrospection>
                    <locale>en</locale>
                    <args>
                        <arg>-Xnamespace-prefix</arg>
                        <arg>-Xannotate</arg>
                        <arg>-Xcopyable</arg>
                    </args>
                </configuration>
                <executions>
                    <execution>
                        <id>generate-sources</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                        <configuration>
                            <schemaIncludes>
                                <include>sample.xsd</include>
                            </schemaIncludes>
                            <bindingIncludes>
                                <include>sample.jxb</include>
                            </bindingIncludes>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    <dependencies>
        <dependency>
            <groupId>jakarta.xml.bind</groupId>
            <artifactId>jakarta.xml.bind-api</artifactId>
            <version>4.0.4</version>
        </dependency>
        <dependency>
            <groupId>org.jvnet.jaxb</groupId>
            <artifactId>jaxb-plugins-runtime</artifactId>
            <version>4.0.12</version>
        </dependency>
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>annotations</artifactId>
            <version>${project.parent.version}</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>
</project>

[laurentschoelens]

I manage to reproduce your issue, I need to debug to understand why annotation is going to the "value" attribute of EnumWithCommentType even if I think that's because of the "simpleType" extension

[laurentschoelens]

@kermit-the-frog you can add the extra-arg <arg>-Xannotate-defaultFieldTarget=field</arg>

This should generate good class definition according annotation

[kermit-the-frog]

@laurentschoelens This solution does indeed work for the example shown above. The annotation is now applied to the field rather than the getter method. However, I have just realized that the example does not accurately reflect my actual issue. I abstracted too much away from my original source code. When I modify the sample.jxb so that the annotation is generated exclusively on the enum type, I encounter the following error:
[ERROR] Failed to execute goal org.jvnet.jaxb:jaxb-maven-plugin:4.0.12:generate (generate-sources) on project jaxb: Execution generate-sources of goal org.jvnet.jaxb:jaxb-maven-plugin:4.0.12:generate failed: Annotation target [enum] cannot be applied to a field.

sample.jxb

<?xml version="1.0" encoding="UTF-8"?>
<jaxb:bindings xmlns:jaxb="https://jakarta.ee/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="3.0"
               xmlns:namespace="urn:jaxb.jvnet.org:plugin:namespace-prefix"
               xmlns:annox="urn:jaxb.jvnet.org:annox">
    <jaxb:bindings schemaLocation="sample.xsd">
        <jaxb:bindings>
            <namespace:prefix name="sample"/>
        </jaxb:bindings>
        <jaxb:bindings node="//xsd:simpleType[@name='enumType']">
            <annox:annotateEnum>
                <annox:annotate annox:class="org.example.annotation.SampleAnnotation"/>
            </annox:annotateEnum>
        </jaxb:bindings>
    </jaxb:bindings>
</jaxb:bindings>

[kermit-the-frog]

@laurentschoelens any ideas?

[laurentschoelens]

Maybe change annox:annotateEnum to annox:annotatePropertyField ?

[kermit-the-frog]

That's definitely not the way to solve the problem

1. I want the annotation to be present at the enum type itself and not at any getter/field. I think that’s exactly what annox:annotateEnum is intended for.
2. However it results in [ERROR] Failed to execute goal org.jvnet.jaxb:jaxb-maven-plugin:4.0.12:generate (generate-sources) on project jaxb: Execution generate-sources of goal org.jvnet.jaxb:jaxb-maven-plugin:4.0.12:generate failed: Annotation target [field] cannot be applied to an enum. -> [Help 1]

[laurentschoelens]

And by removing the nested annox ?
Like merging the two

<jaxb:bindings node="//xsd:simpleType[@name='enumType']">
    <annox:annotateEnum annox:class="org.example.annotation.SampleAnnotation"/>
</jaxb:bindings>

[kermit-the-frog]

That still results in:
[ERROR] Failed to execute goal org.jvnet.jaxb:jaxb-maven-plugin:4.0.12:generate (generate-sources) on project jaxb: Execution generate-sources of goal org.jvnet.jaxb:jaxb-maven-plugin:4.0.12:generate failed: Annotation target [enum] cannot be applied to a field. -> [Help 1]

[laurentschoelens]

Could you share MRE so I could investigate more about this ?

[kermit-the-frog]

What means MRE?