@XmlElements @XmlElementsRef support in docs module

Yuck.

Thanks for the report. I suppose for now the workaround is to disable the example json output...

Thanks for the quick reply Ryan! I have the inclusion disabled but is there a way to skip the generation process, either via a maven plugin option or in the enunciate.xml? Also, thanks a bunch of your hard work on this product.

The only way to disable just the JSON output is via annotation on each specific class annotated with @XmlRootElement. I wish there were a global config option, but there isn't. Yet.

Anyway, to disable the json output:

For each class annotated with @XmlRootElement, add @org.codehaus.enunciate.doc.DocumentationExample(validTypes=ExampleType.XML)

fixed at f9dde17

closed with the release of 1.23

In 1.24 @DocumentationExample(validTypes=ExampleType.XML) AND @DocumentationExample(exclude=true) appear to have no effect. I examined the output in the generated docs.xml and I can see it's still attempting to generate JSON where it chokes.

What happens in 1.24?

[INFO] Trace
org.apache.maven.lifecycle.LifecycleExecutionException: Problem assembling the enunciate app.
at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeGoals(DefaultLifecycleExecutor.java:719)
at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeGoalWithLifecycle(DefaultLifecycleExecutor.java:556)
at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeGoal(DefaultLifecycleExecutor.java:535)
at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeGoalAndHandleFailures(DefaultLifecycleExecutor.java:387)
at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeTaskSegments(DefaultLifecycleExecutor.java:348)
at org.apache.maven.lifecycle.DefaultLifecycleExecutor.execute(DefaultLifecycleExecutor.java:180)
at org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:328)
at org.apache.maven.DefaultMaven.execute(DefaultMaven.java:138)
at org.apache.maven.cli.MavenCli.main(MavenCli.java:362)
at org.apache.maven.cli.compat.CompatibleMain.main(CompatibleMain.java:60)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at org.codehaus.classworlds.Launcher.launchEnhanced(Launcher.java:315)
at org.codehaus.classworlds.Launcher.launch(Launcher.java:255)
at org.codehaus.classworlds.Launcher.mainWithExitCode(Launcher.java:430)
at org.codehaus.classworlds.Launcher.main(Launcher.java:375)
Caused by: org.apache.maven.plugin.MojoExecutionException: Problem assembling the enunciate app.
at org.codehaus.enunciate.AssembleMojo.execute(AssembleMojo.java:74)
at org.apache.maven.plugin.DefaultPluginManager.executeMojo(DefaultPluginManager.java:490)
at org.apache.maven.lifecycle.DefaultLifecycleExecutor.executeGoals(DefaultLifecycleExecutor.java:694)
... 17 more
Caused by: java.lang.RuntimeException: java.lang.UnsupportedOperationException: No single reference for this element: multiple choices.
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.exec(GenerateExampleJsonMethod.java:100)
at freemarker.core.MethodCall._getAsTemplateModel(MethodCall.java:93)
at freemarker.core.Expression.getAsTemplateModel(Expression.java:89)
at freemarker.core.Expression.getStringValue(Expression.java:93)
at freemarker.core.StringBuiltins$StringBuiltIn._getAsTemplateModel(StringBuiltins.java:71)
at freemarker.core.Expression.getAsTemplateModel(Expression.java:89)
at freemarker.core.Expression.getStringValue(Expression.java:93)
at freemarker.core.DollarVariable.accept(DollarVariable.java:76)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.MixedContent.accept(MixedContent.java:92)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.ConditionalBlock.accept(ConditionalBlock.java:79)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.MixedContent.accept(MixedContent.java:92)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.ConditionalBlock.accept(ConditionalBlock.java:79)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.IteratorBlock$Context.runLoop(IteratorBlock.java:179)
at freemarker.core.Environment.visit(Environment.java:415)
at freemarker.core.IteratorBlock.accept(IteratorBlock.java:102)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.MixedContent.accept(MixedContent.java:92)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.ConditionalBlock.accept(ConditionalBlock.java:79)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.Environment.visit(Environment.java:297)
at freemarker.core.UnifiedCall.accept(UnifiedCall.java:130)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.MixedContent.accept(MixedContent.java:92)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.Environment.visit(Environment.java:297)
at freemarker.core.UnifiedCall.accept(UnifiedCall.java:130)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.MixedContent.accept(MixedContent.java:92)
at freemarker.core.Environment.visit(Environment.java:208)
at freemarker.core.Environment.process(Environment.java:188)
at freemarker.template.Template.process(Template.java:237)
at org.codehaus.enunciate.modules.FreemarkerDeploymentModule.processTemplate(FreemarkerDeploymentModule.java:106)
at org.codehaus.enunciate.modules.FreemarkerDeploymentModule.processTemplate(FreemarkerDeploymentModule.java:85)
at org.codehaus.enunciate.modules.FreemarkerDeploymentModule.processTemplate(FreemarkerDeploymentModule.java:70)
at org.codehaus.enunciate.modules.docs.DocumentationDeploymentModule.doFreemarkerGenerate(DocumentationDeploymentModule.java:736)
at org.codehaus.enunciate.modules.FreemarkerDeploymentModule.doGenerate(FreemarkerDeploymentModule.java:51)
at org.codehaus.enunciate.modules.BasicDeploymentModule.step(BasicDeploymentModule.java:107)
at org.codehaus.enunciate.apt.EnunciateAnnotationProcessor.process(EnunciateAnnotationProcessor.java:113)
at com.sun.mirror.apt.AnnotationProcessors$CompositeAnnotationProcessor.process(AnnotationProcessors.java:60)
at com.sun.tools.apt.comp.Apt.main(Apt.java:454)
at com.sun.tools.apt.main.JavaCompiler.compile(JavaCompiler.java:258)
at com.sun.tools.apt.main.Main.compile(Main.java:1102)
at com.sun.tools.apt.main.Main.compile(Main.java:964)
at com.sun.tools.apt.Main.processing(Main.java:95)
at com.sun.tools.apt.Main.process(Main.java:85)
at com.sun.tools.apt.Main.process(Main.java:67)
at org.codehaus.enunciate.main.Enunciate.invokeApt(Enunciate.java:776)
at org.codehaus.enunciate.main.Enunciate.doGenerate(Enunciate.java:365)
at org.codehaus.enunciate.ConfigMojo$MavenSpecificEnunciate.doGenerate(ConfigMojo.java:634)
at org.codehaus.enunciate.main.Enunciate$Stepper.step(Enunciate.java:1706)
at org.codehaus.enunciate.main.Enunciate$Stepper.stepTo(Enunciate.java:1738)
at org.codehaus.enunciate.AssembleMojo.execute(AssembleMojo.java:70)
... 19 more
Caused by: java.lang.UnsupportedOperationException: No single reference for this element: multiple choices.
at org.codehaus.enunciate.contract.jaxb.ElementRef.getRef(ElementRef.java:253)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:184)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:132)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:110)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:220)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:185)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:132)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:110)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:220)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:201)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:132)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.generateExampleJson(GenerateExampleJsonMethod.java:110)
at org.codehaus.enunciate.modules.docs.GenerateExampleJsonMethod.exec(GenerateExampleJsonMethod.java:89)
... 76 more

It might be fixed for the JSon method but it seams still open for XML:

Caused by: java.lang.UnsupportedOperationException: No single reference for this element: multiple choices.
at org.codehaus.enunciate.contract.jaxb.ElementRef.getNamespace(ElementRef.java:238)
at org.codehaus.enunciate.modules.docs.GenerateExampleXmlMethod.generateExampleXml(GenerateExampleXmlMethod.java:210)
at org.codehaus.enunciate.modules.docs.GenerateExampleXmlMethod.generateExampleXml(GenerateExampleXmlMethod.java:155)
at org.codehaus.enunciate.modules.docs.GenerateExampleXmlMethod.exec(GenerateExampleXmlMethod.java:119)

I’ve found the problem producing the current exception:

    @XmlElementRefs({ @XmlElementRef(type = XxxDTO.class, name = "xxx"), @XmlElementRef(type = YyyDTO.class, name = "yyy") })
    private ZzzDTO zzz;

where XxxDTO and YyyDTO extends ZzzDTO

I’ve fixed it by using:

    @XmlElement(name = "xxx")
    private ZzzDTO zzz;

It works, but is not the same as I like to say...

Having the same problem. Any chance of relief?

Sorry, haven't tackled it yet.

Looks like this was fixed at 20b4a57. I'll have a 1.26 release candidate available soon. Please confirm and reopen if necessary.

Cool. I was about to try a nightly, but it looks like I'm on my own for a build. I'll wait for the RC.

Thanks.

Closed with the release of 1.26.

The case that wasn't getting caught was using @XmlElementRefs on a member that is not a collection. Fixed at 62fa7d6. Cutting 1.26.1 with this included now...

Thank you.

This resolved the compile error. It does however, generate somewhat incomplete documentation. Any JAXB member variables annotated with @XmlElementRefs do have possible child element names listed, separated by "or". However, these OR'd elements are missing references to their underlying types.

Progress none-the-less.

Opened ticket ENUNCIATE-731 for the aforementioned issue.