[shrinkwrap-issues] [JBoss JIRA] Issue Comment Edited: (SHRINKDESC-54) Develop/split EE Spec and JBoss-specific descriptors in API / Impl Split

[Aslak Knutsen (JIRA)]

    [ https://issues.jboss.org/browse/SHRINKDESC-54?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12622404#comment-12622404 ] 

Aslak Knutsen edited comment on SHRINKDESC-54 at 8/22/11 5:59 AM:
------------------------------------------------------------------

* WebAppVersionType._3_0 vs WebAppVersionType.3_0
** The extra underscore is related to some of the defined enums which cannot be transfered 100% 
to java enums. They start for example with numbers like 1.x or 2.x. I wanted to have a procedure
that works for all enums. But if you wish, I can check if the enum name starts with a number and
only then a underscore will be added.
*** Sorry, of course java does not allow numbers to start names. Didn't cross my mind at the time. :)

* Missing some xml escape in javadoc comments
** I am not sure what the problem is here. Looking at the original documentation, it should be
one to one the same. Is it the '[' character?
*** The XML tags are not shown in the rendered HTML. I guess it should be written within a <pre> or by escaping the xml tags in the example &lt;xml&gt;

* getOrCreate on elements that support multiple ?
** Yes, in case of a multiple element, if returns the first one, if already created or creates a new
one, if no element was defined before.
*** To me getOrCreate only makes sense if only one element is supported. Maybe single elements should have, getX, getOrCreateX, removeX, while multiple has: getAllXs, createX, removeAllXs, and possible for removing single instances removeX(XType) 



      was (Author: aslak):
    * WebAppVersionType._3_0 vs WebAppVersionType.3_0
** The extra underscore is related to some of the defined enums which cannot be transfered 100% 
to java enums. They start for example with numbers like 1.x or 2.x. I wanted to have a procedure
that works for all enums. But if you wish, I can check if the enum name starts with a number and
only then a underscore will be added.

*** Sorry, of course java does not allow numbers to start names. Didn't cross my mind at the time. :)

* Missing some xml escape in javadoc comments
** I am not sure what the problem is here. Looking at the original documentation, it should be
one to one the same. Is it the '[' character?

*** The XML tags are not shown in the rendered HTML. I guess it should be written within a <pre> or by escaping the xml tags in the example &lt;xml&gt;

* getOrCreate on elements that support multiple ?
** Yes, in case of a multiple element, if returns the first one, if already created or creates a new
one, if no element was defined before.

*** To me getOrCreate only makes sense if only one element is supported. Maybe single elements should have, getX, getOrCreateX, removeX, while multiple has: getAllXs, createX, removeAllXs, and possible for removing single instances removeX(XType) 


  
> Develop/split EE Spec and JBoss-specific descriptors in API / Impl Split
> ------------------------------------------------------------------------
>
>                 Key: SHRINKDESC-54
>                 URL: https://issues.jboss.org/browse/SHRINKDESC-54
>             Project: ShrinkWrap Descriptors
>          Issue Type: Task
>            Reporter: Andrew Rubinger
>            Assignee: Ralf Battenfeld
>             Fix For: 1.2.0-alpha-1
>
>
> This task to track the extensive refactoring and reworking of Descriptors as done through the POC offered by Ralf Battenfeld.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira