Update of /cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/entity
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv9677
Modified Files:
PkTagsHandler.java
Log Message:
Javadocs (XDT-1225)
Index: PkTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/entity/PkTagsHandler.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -r1.17 -r1.18
*** PkTagsHandler.java 10 Apr 2005 09:55:22 -0000 1.17
--- PkTagsHandler.java 15 Apr 2005 00:11:03 -0000 1.18
***************
*** 25,28 ****
--- 25,30 ----
/**
+ * Tags used in generating PK classes for entity EJBs.
+ *
* @author Ara Abrahamian ([EMAIL PROTECTED])
* @created 13. juni 2002
***************
*** 33,38 ****
{
/**
* @param clazz The class to look into
! * @return The value of the ejb:bean primkey-field
parameter
* @exception XDocletException
*/
--- 35,43 ----
{
/**
+ * Get the primary key field specified for a given class. This is given
by the <code>primkey-field</code> parameter
+ * on the <code>ejb.bean</code> tag, although this may be inherited from
a superclass.
+ *
* @param clazz The class to look into
! * @return The value of the ejb.bean primkey-field
parameter
* @exception XDocletException
*/
***************
*** 43,47 ****
String pkField = clazz.getDoc().getTagAttributeValue("ejb:bean",
"primkey-field", true);
! /* TODO what should be done if only one cmp-field is marekd with
ejb.pk-field
* if (pkField == null) {
* / search for a single ejb.pk-field tag
--- 48,53 ----
String pkField = clazz.getDoc().getTagAttributeValue("ejb:bean",
"primkey-field", true);
! /*
! * TODO what should be done if only one cmp-field is marked with
ejb.pk-field
* if (pkField == null) {
* / search for a single ejb.pk-field tag
***************
*** 56,63 ****
--- 62,72 ----
/**
+ * Test if a given method is the getter or setter for the primary key
field specified for the class.
+ *
* @param clazz The class to look into
* @param method The method to check for primkey-field
* @return true if the method is a getter or setter
for the primkey-field
* @exception XDocletException
+ * @see #getPrimkeyFieldFor(XClass)
*/
public static boolean isMethodPrimkeyField(XClass clazz, XMethod method)
***************
*** 71,79 ****
/**
! * Gets the PrimkeyGetterFor attribute of the PkTagsHandler class
*
! * @param clazz Describe what the parameter does
! * @return The PrimkeyGetterFor value
* @exception XDocletException
*/
public static String getPrimkeyGetterFor(XClass clazz) throws
XDocletException
--- 80,90 ----
/**
! * Returns the getter method of the primary key field specified for a
given class.
*
! * @param clazz The class to look into
! * @return The name of the ejb.bean primkey-field
parameter's getter method, or null if there
! * isn't one
* @exception XDocletException
+ * @see #getPrimkeyFieldFor(XClass)
*/
public static String getPrimkeyGetterFor(XClass clazz) throws
XDocletException
***************
*** 100,108 ****
/**
! * Gets the PrimkeySetterFor attribute of the PkTagsHandler class
*
! * @param clazz Describe what the parameter does
! * @return The PrimkeySetterFor value
* @exception XDocletException
*/
public static String getPrimkeySetterFor(XClass clazz) throws
XDocletException
--- 111,121 ----
/**
! * Returns the setter method of the primary key field specified for a
given class.
*
! * @param clazz The class to look into
! * @return The name of the ejb.bean primkey-field
parameter's setter method, or null if there
! * isn't one
* @exception XDocletException
+ * @see #getPrimkeyFieldFor(XClass)
*/
public static String getPrimkeySetterFor(XClass clazz) throws
XDocletException
***************
*** 129,136 ****
/**
! * Gets the PkClassFor attribute of the PkTagsHandler class
*
! * @param clazz Describe what the parameter does
! * @return The PkClassFor value
* @exception XDocletException
*/
--- 142,152 ----
/**
! * Get the primary key class specified for a given class. If a primary
key field has been specified, using the
! * <code>primkey-field</code> parameter on the <code>ejb.bean</code> tag,
this will be the return type of that
! * field's getter method. Otherwise, it will be determined by the various
parameters of the <code>ejb.pk</code> tag
! * and the subtask's settings for default pattern, packageSubstitution,
etc.
*
! * @param clazz The class to look into
! * @return Fully qualified name of the primary key's
type
* @exception XDocletException
*/
***************
*** 192,196 ****
* Gets the PkClassForEjbJarXmlFor attribute of the PkTagsHandler class
*
! * @param clazz Describe what the parameter does
* @return The PkClassForEjbJarXmlFor value
* @exception XDocletException
--- 208,212 ----
* Gets the PkClassForEjbJarXmlFor attribute of the PkTagsHandler class
*
! * @param clazz The class to look into
* @return The PkClassForEjbJarXmlFor value
* @exception XDocletException
***************
*** 217,225 ****
/**
! * Returns true if the clazz has a primkey-field defined on the ejb:bean
tag (opposed to having a separate PK class)
*
* @param clazz The class to look into.
* @return true if the class has a defined
primkey-field
* @exception XDocletException
*/
public static boolean classHasPrimkeyField(XClass clazz) throws
XDocletException
--- 233,243 ----
/**
! * Returns true if the specified class has a primkey-field defined on the
ejb.bean tag (opposed to having a separate
! * PK class).
*
* @param clazz The class to look into.
* @return true if the class has a defined
primkey-field
* @exception XDocletException
+ * @see #getPrimkeyFieldFor(XClass)
*/
public static boolean classHasPrimkeyField(XClass clazz) throws
XDocletException
***************
*** 231,237 ****
/**
! * Gets the EntityPkClassPattern attribute of the PkTagsHandler class
*
! * @return The EntityPkClassPattern value
*/
protected static String getEntityPkClassPattern()
--- 249,256 ----
/**
! * Returns the pattern which is used to calculate the Primary Key class'
name from the EJB name. The default is to
! * append "PK", unless overridden on the subtask.
*
! * @return pattern
*/
protected static String getEntityPkClassPattern()
***************
*** 268,275 ****
/**
! * Process the tag body if the current class has a defined primkey-field
*
! * @param template
! * @param attributes
* @exception XDocletException
* @doc.tag type="block"
--- 287,294 ----
/**
! * Process the tag body if the current class has a defined primkey-field.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException
* @doc.tag type="block"
***************
*** 284,291 ****
/**
! * Process the tag body if the current method is a getter or setter for
the primkey-field
*
! * @param template
! * @param attributes
* @exception XDocletException
* @doc.tag type="block"
--- 303,310 ----
/**
! * Process the tag body if the current method is a getter or setter for
the primkey-field.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException
* @doc.tag type="block"
***************
*** 300,307 ****
/**
! * Process the tag body if the current method is not a getter or setter
for the primkey-field
*
! * @param template
! * @param attributes
* @exception XDocletException
* @doc.tag type="block"
--- 319,326 ----
/**
! * Process the tag body if the current method is not a getter or setter
for the primkey-field.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException
* @doc.tag type="block"
***************
*** 316,323 ****
/**
! * Process the tag body if the current class doesn't have a defined
primkey-field
*
! * @param template
! * @param attributes
* @exception XDocletException
* @doc.tag type="block"
--- 335,342 ----
/**
! * Process the tag body if the current class doesn't have a defined
primkey-field.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException
* @doc.tag type="block"
***************
*** 332,340 ****
/**
! * Returns the primkey-field defined for the current class
*
! * @param attributes
! * @return The value of the ejb:bean primkey-field
parameter
* @exception XDocletException
* @doc.tag type="content"
*/
--- 351,360 ----
/**
! * Returns the primkey-field defined for the current class.
*
! * @param attributes The attributes of the template tag
! * @return The value of the ejb.bean primkey-field
parameter
* @exception XDocletException
+ * @see #getPrimkeyFieldFor(XClass)
* @doc.tag type="content"
*/
***************
*** 346,354 ****
/**
! * Returns the getter name for the primkey-field
*
! * @param attributes
* @return The primkey-field getter
* @exception XDocletException
* @doc.tag type="content"
*/
--- 366,375 ----
/**
! * Returns the getter name for the primkey-field.
*
! * @param attributes The attributes of the template tag
* @return The primkey-field getter
* @exception XDocletException
+ * @see #getPrimkeyGetterFor(XClass)
* @doc.tag type="content"
*/
***************
*** 360,368 ****
/**
! * Returns the setter name for the primkey-field
*
! * @param attributes
* @return The primkey-field setter
* @exception XDocletException
* @doc.tag type="content"
*/
--- 381,390 ----
/**
! * Returns the setter name for the primkey-field.
*
! * @param attributes The attributes of the template tag
* @return The primkey-field setter
* @exception XDocletException
+ * @see #getPrimkeySetterFor(XClass)
* @doc.tag type="content"
*/
***************
*** 376,382 ****
* Process the tag body if the current class has defined a setter for the
primkey-field.
*
! * @param template
! * @param attributes
* @exception XDocletException
*/
public void ifHasPrimkeySetter(String template, Properties attributes)
--- 398,406 ----
* Process the tag body if the current class has defined a setter for the
primkey-field.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException
+ * @see #getPrimkeySetterFor(XClass)
+ * @doc.tag type="block"
*/
public void ifHasPrimkeySetter(String template, Properties attributes)
***************
*** 415,419 ****
* Returns a string containing comma-separated list of primary key fields
with their types.
*
! * @return A string containing comma-separated list
of primary key fields without their types.
* @exception XDocletException
* @see
xdoclet.modules.ejb.entity.PersistentTagsHandler#fieldList(XClass, String,
String,
--- 439,443 ----
* Returns a string containing comma-separated list of primary key fields
with their types.
*
! * @return A string containing comma-separated list
of primary key fields with their types.
* @exception XDocletException
* @see
xdoclet.modules.ejb.entity.PersistentTagsHandler#fieldList(XClass, String,
String,
***************
*** 430,434 ****
* parameter.
*
! * @param attributes
* @return A string containing comma-separated list
of primary key fields without their types.
* @exception XDocletException
--- 454,458 ----
* parameter.
*
! * @param attributes The attributes of the template tag
* @return A string containing comma-separated list
of primary key fields without their types.
* @exception XDocletException
***************
*** 436,439 ****
--- 460,465 ----
* int, String, boolean)
* @doc.tag type="content"
+ * @doc.param name="name" optional="false"
description="The name of the variable to get the fields
+ * from."
*/
public String pkfieldListFrom(Properties attributes) throws
XDocletException
***************
*** 459,463 ****
* Returns the name of the class pk class extends.
*
! * @return The name of generated PK class.
* @exception XDocletException
* @doc.tag type="content"
--- 485,489 ----
* Returns the name of the class pk class extends.
*
! * @return superclass name
* @exception XDocletException
* @doc.tag type="content"
-------------------------------------------------------
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
