Update of /cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/entity
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29251/entity
Modified Files:
DataObjectSubTask.java EntityBmpSubTask.java
EntityPkSubTask.java ValueObjectSubTask.java
ValueObjectTagsHandler.java
Log Message:
Javadocs, plus eliminate a bunch of javadoc warnings. XDT-1225
Index: DataObjectSubTask.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/entity/DataObjectSubTask.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -r1.11 -r1.12
*** DataObjectSubTask.java 6 Sep 2004 05:18:30 -0000 1.11
--- DataObjectSubTask.java 15 Apr 2005 23:40:28 -0000 1.12
***************
*** 57,62 ****
/**
* Returns the configuration parameter for specifying the data object
class name pattern. By default the value is
! * used for deciding the entity data object class name. {0} in the value
mean current class's symbolic name which
! * for an EJBean is the EJB name. If nothing explicitly specified by user
then "{0}Data" is used by default.
*
* @return The DataObjectClassPattern value
--- 57,63 ----
/**
* Returns the configuration parameter for specifying the data object
class name pattern. By default the value is
! * used for deciding the entity data object class name. The placeholder
"{0}" in the value means the current class's
! * symbolic name which for an EJBean is the EJB name. If nothing
explicitly specified by user then "{0}Data" is used
! * by default.
*
* @return The DataObjectClassPattern value
***************
*** 74,78 ****
/**
! * The pattern by which the data object classes are named. {0}designates
the EJB name.
*
* @param new_pattern The new Pattern value
--- 75,79 ----
/**
! * The pattern by which the data object classes are named. The
placeholder "{0}" designates the EJB name.
*
* @param new_pattern The new Pattern value
Index: EntityBmpSubTask.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/entity/EntityBmpSubTask.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -r1.10 -r1.11
*** EntityBmpSubTask.java 15 Aug 2004 09:56:35 -0000 1.10
--- EntityBmpSubTask.java 15 Apr 2005 23:40:29 -0000 1.11
***************
*** 42,47 ****
/**
* A configuration parameter for specifying the concrete BMP entity bean
class name pattern. By default the value is
! * used for deciding the concrete BMP entity bean class name. {0} in the
value mean current class's symbolic name
! * which for an EJBean is the EJB name.
*
* @see #getEntityBmpClassPattern()
--- 42,47 ----
/**
* A configuration parameter for specifying the concrete BMP entity bean
class name pattern. By default the value is
! * used for deciding the concrete BMP entity bean class name. The
placeholder "{0}" in the value means the current
! * class's symbolic name which for an EJBean is the EJB name.
*
* @see #getEntityBmpClassPattern()
***************
*** 64,70 ****
/**
* Returns the configuration parameter for specifying the concrete BMP
entity bean class name pattern. By default
! * the value is used for deciding the concrete BMP entity bean class
name. {0} in the value mean current class's
! * symbolic name which for an EJBean is the EJB name. If nothing
explicitly specified by user then "{0}BMP" is used
! * by default.
*
* @return The EntityBmpClassPattern value
--- 64,70 ----
/**
* Returns the configuration parameter for specifying the concrete BMP
entity bean class name pattern. By default
! * the value is used for deciding the concrete BMP entity bean class
name. The placeholder "{0}" in the value means
! * the current class's symbolic name which for an EJBean is the EJB name.
If nothing explicitly specified by user
! * then "{0}BMP" is used by default.
*
* @return The EntityBmpClassPattern value
***************
*** 83,87 ****
/**
! * The pattern by which the BMP implementation classes are named. {0}
designates the EJB name.
*
* @param new_pattern The new Pattern value
--- 83,87 ----
/**
! * The pattern by which the BMP implementation classes are named. The
placeholder "{0}" designates the EJB name.
*
* @param new_pattern The new Pattern value
Index: EntityPkSubTask.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/entity/EntityPkSubTask.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -r1.10 -r1.11
*** EntityPkSubTask.java 15 Aug 2004 09:56:35 -0000 1.10
--- EntityPkSubTask.java 15 Apr 2005 23:40:29 -0000 1.11
***************
*** 36,41 ****
/**
* A configuration parameter for specifying the entity bean primary class
name pattern. By default the value is used
! * for deciding the entity bean primary class name. {0} in the value mean
current class's symbolic name which for an
! * EJBean is the EJB name.
*
* @see #getEntityPkClassPattern()
--- 36,41 ----
/**
* A configuration parameter for specifying the entity bean primary class
name pattern. By default the value is used
! * for deciding the entity bean primary class name. The placeholder "{0}"
in the value means the current class's
! * symbolic name which for an EJBean is the EJB name.
*
* @see #getEntityPkClassPattern()
***************
*** 55,61 ****
/**
* Returns the configuration parameter for specifying the entity bean
primary class name pattern. By default the
! * value is used for deciding the entity bean primary class name. {0} in
the value mean current class's symbolic
! * name which for an EJBean is the EJB name. If nothing explicitly
specified by user then "{0}PK" is used by
! * default.
*
* @return The EntityPkClassPattern value
--- 55,61 ----
/**
* Returns the configuration parameter for specifying the entity bean
primary class name pattern. By default the
! * value is used for deciding the entity bean primary class name. The
placeholder "{0}" in the value means the
! * current class's symbolic name which for an EJBean is the EJB name. If
nothing explicitly specified by user then
! * "{0}PK" is used by default.
*
* @return The EntityPkClassPattern value
***************
*** 73,77 ****
/**
! * The pattern by which the primary key classes are named. {0} designates
the EJB name.
*
* @param new_pattern The new Pattern value
--- 73,77 ----
/**
! * The pattern by which the primary key classes are named. The
placeholder "{0}" designates the EJB name.
*
* @param new_pattern The new Pattern value
Index: ValueObjectSubTask.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/entity/ValueObjectSubTask.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -r1.15 -r1.16
*** ValueObjectSubTask.java 9 Apr 2005 07:28:54 -0000 1.15
--- ValueObjectSubTask.java 15 Apr 2005 23:40:29 -0000 1.16
***************
*** 18,22 ****
/**
! * Creates "value objects" for Entity EJBs. This is task replaces <a
href="DataObjectSubTask.html">Data Object</a> .
*
* @author Vincent Harcq ([EMAIL PROTECTED])
--- 18,22 ----
/**
! * Creates "value objects" for Entity EJBs. This task replaces <a
href="DataObjectSubTask.html">Data Object</a> .
*
* @author Vincent Harcq ([EMAIL PROTECTED])
***************
*** 43,48 ****
/**
* A configuration parameter for specifying the data object class name
pattern. By default the value is used for
! * deciding the entity data object class name. {0} in the value mean
current class's symbolic name which for an
! * EJBean is the EJB name.
*
* @see #getValueObjectClassPattern()
--- 43,48 ----
/**
* A configuration parameter for specifying the data object class name
pattern. By default the value is used for
! * deciding the entity data object class name. The placeholder "{0}" in
the value means the current class's symbolic
! * name which for an EJBean is the EJB name.
*
* @see #getValueObjectClassPattern()
***************
*** 70,74 ****
}
-
/**
* Gets the CurrentValueObjectClass attribute of the ValueObjectSubTask
class
--- 70,73 ----
***************
*** 101,105 ****
}
-
/**
* Gets the CurrentValueObjectMatch attribute of the ValueObjectSubTask
class
--- 100,103 ----
***************
*** 114,119 ****
/**
* Returns the configuration parameter for specifying the data object
class name pattern. By default the value is
! * used for deciding the entity data object class name. {0} in the value
mean current class's symbolic name which
! * for an EJBean is the EJB name. If nothing explicitly specified by user
then "{0}Value" is used by default.
*
* @return The ValueObjectClassPattern value
--- 112,118 ----
/**
* Returns the configuration parameter for specifying the data object
class name pattern. By default the value is
! * used for deciding the entity data object class name. The placeholder
"{0}" in the value means the current class's
! * symbolic name which for an EJBean is the EJB name. If nothing
explicitly specified by user then "{0}Value" is
! * used by default.
*
* @return The ValueObjectClassPattern value
***************
*** 135,141 ****
}
-
/**
! * The pattern by which the value object classes are named. {0}
designates the EJB name.
*
* @param new_pattern The new Pattern value
--- 134,139 ----
}
/**
! * The pattern by which the value object classes are named. The
placeholder "{0}" designates the EJB name.
*
* @param new_pattern The new Pattern value
***************
*** 147,150 ****
--- 145,154 ----
}
+ /**
+ * Whether to generate a single-parameter constructor in the ValueObject,
which only sets up the PK.
+ *
+ * @param generatePKConstructor The new GeneratePKConstructor value
+ * @ant.not-required No, default is false
+ */
public void setGeneratePKConstructor(String generatePKConstructor)
{
***************
*** 169,176 ****
throw new
XDocletException(Translator.getString(XDocletModulesEjbMessages.class,
XDocletModulesEjbMessages.PATTERN_HAS_NO_PLACEHOLDER));
}
-
}
-
/**
* Gets the GeneratedFileName attribute of the ValueObjectSubTask object
--- 173,178 ----
***************
*** 206,210 ****
}
-
/**
* Describe what the method does
--- 208,211 ----
Index: ValueObjectTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/entity/ValueObjectTagsHandler.java,v
retrieving revision 1.27
retrieving revision 1.28
diff -C2 -r1.27 -r1.28
*** ValueObjectTagsHandler.java 9 Apr 2005 07:28:54 -0000 1.27
--- ValueObjectTagsHandler.java 15 Apr 2005 23:40:29 -0000 1.28
***************
*** 27,30 ****
--- 27,32 ----
/**
+ * Tags used by the Value Object templates.
+ *
* @author Vincent Harcq ([EMAIL PROTECTED])
* @created 13. juni 2002
***************
*** 228,234 ****
/**
! * Gets the SubTask attribute of the ValueObjectTagsHandler class
*
! * @return The SubTask value
*/
private static ValueObjectSubTask getSubTask()
--- 230,236 ----
/**
! * Gets a reference to the <valueobject> subtask.
*
! * @return subtask
*/
private static ValueObjectSubTask getSubTask()
***************
*** 261,264 ****
--- 263,275 ----
}
+ /**
+ * Whether or not the <code>abstract</code> parameter is set to true on
the supplied class' ejb.value-object tag for
+ * the given VO name.
+ *
+ * @param valueObjectName
+ * @param currentClass
+ * @return
+ * @exception XDocletException
+ */
public boolean isAbstractValueObject(String valueObjectName,
XClass currentClass)
***************
*** 316,321 ****
/**
! * @param template
! * @param attributes
* @exception XDocletException
* @doc.tag type="block"
--- 327,335 ----
/**
! * Evaluates the body if the <code>valueobject</code> subtask's
<code>generatePKConstructor</code> parameter is
! * <code>true</code>.
! *
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException
* @doc.tag type="block"
***************
*** 329,332 ****
--- 343,354 ----
}
+ /**
+ * Evaluates the body if the <code>abstract</code> parameter is set to
true on the ejb.value-object tag for the
+ * current VO.
+ *
+ * @param template The body of the block tag
+ * @exception XDocletException
+ * @doc.tag type="block"
+ */
public void ifIsAbstractValueObject(String template)
throws XDocletException
***************
*** 337,340 ****
--- 359,370 ----
}
+ /**
+ * Evaluates the body if the <code>abstract</code> parameter is set to
false (or is missing) on the ejb.value-object
+ * tag for the current VO.
+ *
+ * @param template The body of the block tag
+ * @exception XDocletException
+ * @doc.tag type="block"
+ */
public void ifNotIsAbstractValueObject(String template)
throws XDocletException
***************
*** 346,353 ****
/**
! * Describe what the method does
*
! * @return Describe the return value
* @exception XDocletException
*/
public String valueObjectClass() throws XDocletException
--- 376,384 ----
/**
! * Return the current value object's class name.
*
! * @return class name
* @exception XDocletException
+ * @doc.tag type="content"
*/
public String valueObjectClass() throws XDocletException
***************
*** 357,364 ****
/**
! * Describe what the method does
*
! * @return Describe the return value
* @exception XDocletException
*/
public String valueObjectName() throws XDocletException
--- 388,396 ----
/**
! * Return the current value object's name.
*
! * @return VO name
* @exception XDocletException
+ * @doc.tag type="content"
*/
public String valueObjectName() throws XDocletException
***************
*** 368,375 ****
/**
! * Describe what the method does
*
! * @return Describe the return value
* @exception XDocletException
*/
public String valueObjectMatch() throws XDocletException
--- 400,408 ----
/**
! * Return the current value object's match parameter.
*
! * @return match value
* @exception XDocletException
+ * @doc.tag type="content"
*/
public String valueObjectMatch() throws XDocletException
***************
*** 379,388 ****
/**
! * Returns the name of the class dataobject class extends.
*
! * @param attributes
* @return The name of generated PK class.
* @exception XDocletException
* @doc.tag type="content"
*/
public String extendsFrom(Properties attributes) throws XDocletException
--- 412,424 ----
/**
! * Returns the name of the class the specified value object extends. If
no <code>extends</code> parameter exists on
! * the <code>ejb.value-object</code> tag, <code>java.lang.Object</code>
is returned.
*
! * @param attributes The attributes of the template tag
* @return The name of generated PK class.
* @exception XDocletException
* @doc.tag type="content"
+ * @doc.param name="valueobject" optional="false"
description="The name of the value object to
+ * check."
*/
public String extendsFrom(Properties attributes) throws XDocletException
***************
*** 392,397 ****
/**
! * @param pTemplate
* @exception XDocletException
*/
public void forAllValueObjects(String pTemplate) throws XDocletException
--- 428,436 ----
/**
! * Loops over all the ejb.value-object tags in the class, and generates
the body for each one.
! *
! * @param pTemplate The body of the block tag
* @exception XDocletException
+ * @doc.tag type="block"
*/
public void forAllValueObjects(String pTemplate) throws XDocletException
***************
*** 422,428 ****
/**
! * Describe what the method does
*
! * @return Describe the return value
*/
public String currentValueObjectClass()
--- 461,468 ----
/**
! * Return the current value object's class name.
*
! * @return class name
! * @doc.tag type="content"
*/
public String currentValueObjectClass()
***************
*** 432,438 ****
/**
! * Describe what the method does
*
! * @return Describe the return value
*/
public String currentValueObjectAttribute()
--- 472,479 ----
/**
! * Return the current value object's attribute name.
*
! * @return attribute
! * @doc.tag type="content"
*/
public String currentValueObjectAttribute()
***************
*** 442,448 ****
/**
! * Describe what the method does
*
! * @return Describe the return value
*/
public String currentValueObjectMatch()
--- 483,490 ----
/**
! * Return the current value object's match parameter.
*
! * @return match value
! * @doc.tag type="content"
*/
public String currentValueObjectMatch()
***************
*** 452,459 ****
/**
! * Describe what the method does
*
! * @param attributes Describe what the parameter does
! * @return Describe the return value
*/
public String currentAggregateType(Properties attributes)
--- 494,503 ----
/**
! * Returns the class name of the current aggregate attribute's type.
*
! * @param attributes The attributes of the template tag
! * @return class
! * @doc.tag type="content"
! * @doc.param name="short" description="Use the short (not
fully-qualified) class name."
*/
public String currentAggregateType(Properties attributes)
***************
*** 478,482 ****
* return interfaces to be implemented
*
! * @return The name of generated PK class.
* @doc.tag type="content"
*/
--- 522,526 ----
* return interfaces to be implemented
*
! * @return interfaces
* @doc.tag type="content"
*/
***************
*** 490,494 ****
*
* @param attributes
! * @return
* @throws XDocletException if an error occures
* @doc.param name="plural" optional="true" values="true,
false" default="false" descriptions="return
--- 534,538 ----
*
* @param attributes
! * @return aggregate name
* @throws XDocletException if an error occures
* @doc.param name="plural" optional="true" values="true,
false" default="false" descriptions="return
***************
*** 513,519 ****
/**
! * Describe what the method does
*
! * @return Describe the return value
*/
public String currentRelationBeanClass()
--- 557,564 ----
/**
! * Return the bean class name for the current relation.
*
! * @return class name
! * @doc.tag type="content"
*/
public String currentRelationBeanClass()
***************
*** 527,530 ****
--- 572,576 ----
* @return Type of the constructor for aggregates or
compositions.
* @exception XDocletException
+ * @doc.tag type="content"
*/
public String concreteCollectionType() throws XDocletException
***************
*** 650,655 ****
* Describe what the method does
*
! * @param template Describe what the parameter does
* @exception XDocletException
*/
public void forAllSuperSetValue(String template) throws XDocletException
--- 696,702 ----
* Describe what the method does
*
! * @param template The body of the block tag
* @exception XDocletException
+ * @doc.tag type="block"
*/
public void forAllSuperSetValue(String template) throws XDocletException
***************
*** 683,691 ****
/**
! * Describe what the method does
*
! * @param template Describe what the parameter does
! * @param attributes Describe what the parameter does
* @exception XDocletException
*/
public void forAllAggregates(String template, Properties attributes)
throws XDocletException
--- 730,742 ----
/**
! * Loop over all the aggregate fields in the given value object, and
generate the body for each one.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException
+ * @doc.tag type="block"
+ * @doc.param name="superclasses" values="true,false"
description="Whether to include fields in
+ * superclasses."
+ * @doc.param name="valueobject" optional="false"
description="The value object name."
*/
public void forAllAggregates(String template, Properties attributes)
throws XDocletException
***************
*** 700,708 ****
/**
! * Describe what the method does
*
! * @param template Describe what the parameter does
! * @param attributes Describe what the parameter does
* @exception XDocletException
*/
public void forAllComposes(String template, Properties attributes) throws
XDocletException
--- 751,763 ----
/**
! * Loop over all the composed fields in the given value object, and
generate the body for each one.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException
+ * @doc.tag type="block"
+ * @doc.param name="superclasses" values="true,false"
description="Whether to include fields in
+ * superclasses."
+ * @doc.param name="valueobject" optional="false"
description="The value object name."
*/
public void forAllComposes(String template, Properties attributes) throws
XDocletException
***************
*** 717,725 ****
/**
! * Describe what the method does
*
! * @param template Describe what the parameter does
! * @param attributes Describe what the parameter does
* @exception XDocletException
*/
public void forAllRelations(String template, Properties attributes)
throws XDocletException
--- 772,784 ----
/**
! * Loop over all the relation fields in the given value object, and
generate the body for each one.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException
+ * @doc.tag type="block"
+ * @doc.param name="superclasses" values="true,false"
description="Whether to include fields in
+ * superclasses."
+ * @doc.param name="valueobject" optional="false"
description="The value object name."
*/
public void forAllRelations(String template, Properties attributes)
throws XDocletException
***************
*** 737,741 ****
* Evaluate the body block if Value Object subtask being used.
*
! * @param template
* @exception XDocletException
* @doc.tag type="block"
--- 796,800 ----
* Evaluate the body block if Value Object subtask being used.
*
! * @param template The body of the block tag
* @exception XDocletException
* @doc.tag type="block"
***************
*** 748,758 ****
}
- /**
- * Describe what the method does
- *
- * @param template Describe what the parameter does
- * @param methodName Describe what the parameter does
- * @exception XDocletException
- */
protected void forAllSetters(String template, String methodName) throws
XDocletException
{
--- 807,810 ----
-------------------------------------------------------
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
[email protected]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
