Update of /cvsroot/xdoclet/xdoclet/modules/ejb/src/META-INF
In directory
sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11807/modules/ejb/src/META-INF
Modified Files:
xtags.xml
Log Message:
environment-tags are also alowed at method and field level for easier
environment handling (XDT-1325)
Index: xtags.xml
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/modules/ejb/src/META-INF/xtags.xml,v
retrieving revision 1.65
retrieving revision 1.66
diff -C2 -r1.65 -r1.66
*** xtags.xml 6 Apr 2005 07:10:13 -0000 1.65
--- xtags.xml 6 Apr 2005 21:42:36 -0000 1.66
***************
*** 7,13 ****
<name>ejb</name>
<usage-description>Ejb tags</usage-description>
! <condition-description>All EJB types on class and method
level.</condition-description>
<condition type="and">
<condition type="or">
<condition type="method"/>
<condition type="class"/>
--- 7,14 ----
<name>ejb</name>
<usage-description>Ejb tags</usage-description>
! <condition-description>All EJB types on class, method and field
level.</condition-description>
<condition type="and">
<condition type="or">
+ <condition type="field"/>
<condition type="method"/>
<condition type="class"/>
***************
*** 763,766 ****
--- 764,769 ----
</tag>
<tag>
+ <level>field</level>
+ <level>method</level>
<level>class</level>
<name>ejb.ejb-external-ref</name>
***************
*** 768,776 ****
Defines an EJB reference to a bean which will be packaged in a
different
ejb jar file.
</usage-description>
<unique>false</unique>
<condition-description>Applicable to all types of
EJBs.</condition-description>
<condition type="and">
! <condition type="class"/>
<condition type="or">
<condition type="type">
--- 771,790 ----
Defines an EJB reference to a bean which will be packaged in a
different
ejb jar file.
+ For field-level tags, the Home-Interface is automatically looked up
and assigned to the field before
+ setSessionContext, setEntityContext or setMessageDrivenContext is
called when generating the technical
+ bean with the session, entitybmp, entitycmp or mdb subtask.
Therefore, the field must have the protected
+ access modifier.
+ The tag may also be used on abstract methods which return the
Home-Interface. Those methods are implemented
+ in the object generated by the session, entitybmp, entitycmp or mdb
subtasks. The implementation
+ performs a caching for the value.
</usage-description>
<unique>false</unique>
<condition-description>Applicable to all types of
EJBs.</condition-description>
<condition type="and">
! <condition type="or">
! <condition type="field"/>
! <condition type="method"/>
! <condition type="class"/>
! </condition>
<condition type="or">
<condition type="type">
***************
*** 868,871 ****
--- 882,887 ----
</tag>
<tag>
+ <level>field</level>
+ <level>method</level>
<level>class</level>
<name>ejb.ejb-ref</name>
***************
*** 876,883 ****
Attention: you have to import the referred class (the ejbdoclet one)
even your EJB does not need it.
</usage-description>
<unique>false</unique>
<condition type="and">
! <condition type="class"/>
<condition type="or">
<condition type="type">
--- 892,910 ----
Attention: you have to import the referred class (the ejbdoclet one)
even your EJB does not need it.
+ For field-level tags, the Home-Interface is automatically looked up
and assigned to the field before
+ setSessionContext, setEntityContext or setMessageDrivenContext is
called when generating the technical
+ bean with the session, entitybmp, entitycmp or mdb subtask.
Therefore, the field must have the protected
+ access modifier.
+ The tag may also be used on abstract methods which return the
Home-Interface's type. Those methods are implemented
+ in the object generated by the session, entitybmp, entitycmp or mdb
subtasks. The implementation
+ performs a caching for the value.
</usage-description>
<unique>false</unique>
<condition type="and">
! <condition type="or">
! <condition type="field"/>
! <condition type="method"/>
! <condition type="class"/>
! </condition>
<condition type="or">
<condition type="type">
***************
*** 930,940 ****
</tag>
<tag>
<level>class</level>
<name>ejb.ejb-service-ref</name>
! <usage-description>Defines a (web)service reference for an EJB.
This is a EJB2.1 thing.</usage-description>
<unique>false</unique>
<condition-description>Applicatble to all EJB types with
EJB-spec 2.1</condition-description>
<condition type="and">
! <condition type="class"/>
<condition type="or">
<condition type="type">
--- 957,982 ----
</tag>
<tag>
+ <level>field</level>
+ <level>method</level>
<level>class</level>
<name>ejb.ejb-service-ref</name>
! <usage-description>
! Defines a (web)service reference for an EJB. This is a EJB2.1 thing.
! For field-level tags, the service is automatically looked up and
assigned to the field before
! setSessionContext, setEntityContext or setMessageDrivenContext is
called when generating the technical
! bean with the session, entitybmp, entitycmp or mdb subtask.
Therefore, the field must have the protected
! access modifier.
! The tag may also be used on abstract methods which return the
servic-interface. Those methods are implemented
! in the object generated by the session, entitybmp, entitycmp or mdb
subtasks. The implementation
! performs a caching for the value.
! </usage-description>
<unique>false</unique>
<condition-description>Applicatble to all EJB types with
EJB-spec 2.1</condition-description>
<condition type="and">
! <condition type="or">
! <condition type="field"/>
! <condition type="method"/>
! <condition type="class"/>
! </condition>
<condition type="or">
<condition type="type">
***************
*** 949,961 ****
</condition>
</condition>
<parameter type="text">
<name>name</name>
! <usage-description>The logical name of the component to
be looked up.</usage-description>
! <mandatory>true</mandatory>
</parameter>
<parameter type="text">
<name>interface</name>
! <usage-description>The fully qualified class name of
the JAX-RPC interface</usage-description>
<mandatory>true</mandatory>
</parameter>
<parameter type="text">
--- 991,1016 ----
</condition>
</condition>
+ <parameter type="text">
+ <name>description</name>
+ <usage-description>Optional description</usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
<parameter type="text">
<name>name</name>
! <usage-description>
! The logical name of the component to be looked up. Mandatory
for class level
! tags. The default for method- and field-level tags is the method
or field name.
! </usage-description>
! <mandatory>false</mandatory>
</parameter>
<parameter type="text">
<name>interface</name>
! <usage-description>
! The fully qualified class name of the JAX-RPC interface. It
is automatically set for method- and
! field-level tags. For method-level tags, it is set to the
method's return type. For field-level tags,
! it is set to the field's type.
! </usage-description>
<mandatory>true</mandatory>
+ <condition type="class"/>
</parameter>
<parameter type="text">
***************
*** 978,988 ****
</tag>
<tag>
<level>class</level>
<name>ejb.env-entry</name>
! <usage-description>Defines an environment entry for an
EJB.</usage-description>
<unique>false</unique>
! <condition-description>Applicable to all EJB types with
EJB.</condition-description>
<condition type="and">
! <condition type="class"/>
<condition type="or">
<condition type="type">
--- 1033,1079 ----
</tag>
<tag>
+ <level>field</level>
+ <level>method</level>
<level>class</level>
<name>ejb.env-entry</name>
! <usage-description>
! Defines an environment entry for an EJB.
! For field-level tags, the env-entry's value is automatically
looked up and assigned to the field before
! setSessionContext, setEntityContext or setMessageDrivenContext is
called when generating the technical
! bean with the session, entitybmp, entitycmp or mdb subtask.
Therefore, the field must have the protected
! access modifier.
! The tag may also be used on abstract methods which return the
env-entry's value. Those methods are implemented
! in the object generated by the session, entitybmp, entitycmp or
mdb subtasks. The implementation
! performs a caching for the value.
! If the field type or the method's return type is primitive, the
env-entry is generated for the corresponding
! wrapper class and automatically converted during the lookup.
! Applicapable for the following field types and method return
types:
! java.lang.Boolean,
! java.lang.Byte,
! java.lang.Character,
! java.lang.String,
! java.lang.Short,
! java.lang.Integer,
! java.lang.Long,
! java.lang.Float,
! java.lang.Double,
! boolean,
! int,
! byte,
! char,
! short,
! int,
! long,
! float,
! double
! </usage-description>
<unique>false</unique>
! <condition-description>Applicable to all EJB
types</condition-description>
<condition type="and">
! <condition type="or">
! <condition type="class"/>
! <condition type="method"/>
! <condition type="field"/>
! </condition>
<condition type="or">
<condition type="type">
***************
*** 999,1004 ****
<parameter type="text">
<name>name</name>
! <usage-description>The name of the env-entry.</usage-description>
! <mandatory>true</mandatory>
</parameter>
<parameter type="text">
--- 1090,1098 ----
<parameter type="text">
<name>name</name>
! <usage-description>
! The name of the env-entry. Mandatory for class level tags. The
default for method- and field-level
! tags is the method or field name.
! </usage-description>
! <mandatory>false</mandatory>
</parameter>
<parameter type="text">
***************
*** 1007,1018 ****
<mandatory>false</mandatory>
</parameter>
! <parameter type="text">
<name>type</name>
<usage-description>
! The type of the env-entry, eg
! java.lang.String. Supported types outlined in
! the EJB spec.
</usage-description>
<mandatory>false</mandatory>
<option-sets>
<option-set>
--- 1101,1116 ----
<mandatory>false</mandatory>
</parameter>
! <parameter type="text">
<name>type</name>
<usage-description>
! The type of the env-entry, eg java.lang.String. Supported types
outlined in
! the EJB spec. It is automatically set for method- and field-level
tags. For method-level tags,
! it is set to the method's return type. For field-level tags, it
is set to the field's type.
</usage-description>
<mandatory>false</mandatory>
+ <condition-description>Only class level tags</condition-description>
+ <condition type="or">
+ <condition type="class"/>
+ </condition>
<option-sets>
<option-set>
***************
*** 2084,2097 ****
</tag>
<tag>
<level>class</level>
<name>ejb.resource-env-ref</name>
<usage-description>
! Defines a resource environment reference with the name name to a
resource
! of type type.
</usage-description>
<unique>false</unique>
<condition-description>Applicable to all EJB types.
</condition-description>
<condition type="and">
! <condition type="class"/>
<condition type="or">
<condition type="type">
--- 2182,2207 ----
</tag>
<tag>
+ <level>field</level>
+ <level>method</level>
<level>class</level>
<name>ejb.resource-env-ref</name>
<usage-description>
! Defines a resource environment reference with the specified name
and type.
! For field-level tags, the resource is automatically looked up and
assigned to the field before
! setSessionContext, setEntityContext or setMessageDrivenContext is
called when generating the technical
! bean with the session, entitybmp, entitycmp or mdb subtask.
Therefore, the field must have the protected
! access modifier.
! The tag may also be used on abstract methods which return the
resource's type. Those methods are implemented
! in the object generated by the session, entitybmp, entitycmp or mdb
subtasks. The implementation
! performs a caching for the value.
</usage-description>
<unique>false</unique>
<condition-description>Applicable to all EJB types.
</condition-description>
<condition type="and">
! <condition type="or">
! <condition type="field"/>
! <condition type="method"/>
! <condition type="class"/>
! </condition>
<condition type="or">
<condition type="type">
***************
*** 2107,2121 ****
</condition>
<parameter type="text">
<name>name</name>
! <usage-description>The name of the resource.</usage-description>
! <mandatory>true</mandatory>
</parameter>
<parameter type="text">
<name>type</name>
! <usage-description>The type of the resource.</usage-description>
<mandatory>true</mandatory>
</parameter>
</tag>
<tag>
<level>class</level>
<name>ejb.resource-ref</name>
--- 2217,2248 ----
</condition>
<parameter type="text">
+ <name>description</name>
+ <usage-description>A optional description for the
resource.</usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="text">
<name>name</name>
! <usage-description>
! The name of the resource. Mandatory for class level tags. The
default for method- and field-level
! tags is the method or field name.
! </usage-description>
! <mandatory>false</mandatory>
</parameter>
<parameter type="text">
<name>type</name>
! <usage-description>
! The resource type. It is automatically set for method- and
field-level tags. For method-level tags,
! it is set to the method's return type. For field-level tags, it
is set to the field's type.
! </usage-description>
<mandatory>true</mandatory>
+ <condition-description>Only class level tags</condition-description>
+ <condition type="or">
+ <condition type="class"/>
+ </condition>
</parameter>
</tag>
<tag>
+ <level>field</level>
+ <level>method</level>
<level>class</level>
<name>ejb.resource-ref</name>
***************
*** 2123,2131 ****
Defines a resource reference with the name res-ref-name to a
resource of type
res-type, and the authentication is done by the one specified in
res-auth.
</usage-description>
<unique>false</unique>
<condition-description>Applicable to all EJB
types.</condition-description>
<condition type="and">
! <condition type="class"/>
<condition type="or">
<condition type="type">
--- 2250,2269 ----
Defines a resource reference with the name res-ref-name to a
resource of type
res-type, and the authentication is done by the one specified in
res-auth.
+ For field-level tags, the resource is automatically looked up and
assigned to the field before
+ setSessionContext, setEntityContext or setMessageDrivenContext is
called when generating the technical
+ bean with the session, entitybmp, entitycmp or mdb subtask.
Therefore, the field must have the protected
+ access modifier.
+ The tag may also be used on abstract methods which return the
resource's type. Those methods are implemented
+ in the object generated by the session, entitybmp, entitycmp or mdb
subtasks. The implementation
+ performs a caching for the value.
</usage-description>
<unique>false</unique>
<condition-description>Applicable to all EJB
types.</condition-description>
<condition type="and">
! <condition type="or">
! <condition type="field"/>
! <condition type="method"/>
! <condition type="class"/>
! </condition>
<condition type="or">
<condition type="type">
***************
*** 2141,2152 ****
</condition>
<parameter type="text">
<name>res-ref-name</name>
! <usage-description>The name of the environment entry used in the
enterprise bean's code.</usage-description>
! <mandatory>true</mandatory>
</parameter>
<parameter type="text">
<name>res-type</name>
! <usage-description>The resource type.</usage-description>
<mandatory>true</mandatory>
</parameter>
<parameter type="text">
--- 2279,2305 ----
</condition>
<parameter type="text">
+ <name>description</name>
+ <usage-description>A optional description for the
resource.</usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="text">
<name>res-ref-name</name>
! <usage-description>
! The name of the environment entry used in the enterprise bean's
code. Mandatory for class level
! tags. The default for method- and field-level tags is the method
or field name.
! </usage-description>
! <mandatory>false</mandatory>
</parameter>
<parameter type="text">
<name>res-type</name>
! <usage-description>
! The resource type. It is automatically set for method- and
field-level tags. For method-level tags,
! it is set to the method's return type. For field-level tags, it
is set to the field's type.
! </usage-description>
<mandatory>true</mandatory>
+ <condition-description>Only class level tags</condition-description>
+ <condition type="or">
+ <condition type="class"/>
+ </condition>
</parameter>
<parameter type="text">
***************
*** 2596,2602 ****
Tell XDoclet how the accessor methods to this property
in the value object
should be called. The value of this parameter should be
the method name,
! sans get or set.
</usage-description>
<mandatory>false</mandatory>
</parameter>
<parameter type="text">
--- 2749,2765 ----
Tell XDoclet how the accessor methods to this property
in the value object
should be called. The value of this parameter should be
the method name,
! without get or set.
! </usage-description>
! <mandatory>false</mandatory>
! </parameter>
! <parameter type="text">
! <name>composes-name</name>
! <usage-description>
! Tell XDoclet how the accessor to collections of this
property in the value object
! should be called. The value of this parameter should be
the method name,
! without get or set. Default is [aggregate-name]s.
</usage-description>
<mandatory>false</mandatory>
+ <default>[compose-name]s</default>
</parameter>
<parameter type="text">
***************
*** 2613,2619 ****
Tell XDoclet how the accessor methods to this property
in the value object
should be called. The value of this parameter should be
the method name,
! sans get or set.
</usage-description>
<mandatory>false</mandatory>
</parameter>
<parameter type="text">
--- 2776,2792 ----
Tell XDoclet how the accessor methods to this property
in the value object
should be called. The value of this parameter should be
the method name,
! without get or set.
! </usage-description>
! <mandatory>false</mandatory>
! </parameter>
! <parameter type="text">
! <name>aggregates-name</name>
! <usage-description>
! Tell XDoclet how the accessor to collections of this
property in the value object
! should be called. The value of this parameter should be
the method name,
! without get or set. Default is [aggregate-name]s.
</usage-description>
<mandatory>false</mandatory>
+ <default>[aggregate-name]s</default>
</parameter>
<parameter type="text">
***************
*** 2638,2656 ****
</parameter>
<parameter type="text">
! <name>type</name>
<usage-description>
! On a multi-valued property, indicates the type of the
collection returned
! by the EJB property accessor. This should be set to
'java.util.Collection'
! or 'java.util.Set' in all multi-valued properties.
</usage-description>
<mandatory>false</mandatory>
! <option-sets>
! <option-set>
! <options>
! <option>java.util.Collection</option>
! <option>java.util.Set</option>
! </options>
! </option-set>
! </option-sets>
</parameter>
</tag>
--- 2811,2821 ----
</parameter>
<parameter type="text">
! <name>concrete-type</name>
<usage-description>
! This tells XDoclet which Collection implementation to
use for storing the related objects
! from a aggregation or composition.
</usage-description>
<mandatory>false</mandatory>
! <default>java.util.ArrayList for Collections and
java.util.HashSet for Sets</default>
</parameter>
</tag>
-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
_______________________________________________
xdoclet-devel mailing list
xdoclet-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
