Update of /cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/home In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv15104
Modified Files: HomeTagsHandler.java Log Message: Improve javadocs. XDT-1225 Index: HomeTagsHandler.java =================================================================== RCS file: /cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/home/HomeTagsHandler.java,v retrieving revision 1.33 retrieving revision 1.34 diff -C2 -r1.33 -r1.34 *** HomeTagsHandler.java 15 Nov 2003 00:02:42 -0000 1.33 --- HomeTagsHandler.java 21 Jan 2005 00:25:11 -0000 1.34 *************** *** 130,135 **** * Returns true if method is an ejbRemove method, false otherwise. * ! * @param method Description of Parameter ! * @return The RemoveMethod value */ public static boolean isRemoveMethod(XMethod method) --- 130,135 ---- * Returns true if method is an ejbRemove method, false otherwise. * ! * @param method The method to test ! * @return true if named ejbRemove */ public static boolean isRemoveMethod(XMethod method) *************** *** 139,157 **** /** ! * Returns true if method is a create method marked with a ejb:create-method tag, false otherwise. * ! * @param method Description of Parameter ! * @return The CreateMethod value */ public static boolean isCreateMethod(XMethod method) { ! return method.getDoc().hasTag("ejb:create-method"); } /** ! * Returns true if method is a home method marked with a ejb:home-method tag, false otherwise. * ! * @param method Description of Parameter ! * @return The HomeMethod value */ public static boolean isHomeMethod(XMethod method) --- 139,157 ---- /** ! * Returns true if method is a create method marked with a [EMAIL PROTECTED] tag, false otherwise. * ! * @param method The method to test ! * @return true if ejb.create-method tag found */ public static boolean isCreateMethod(XMethod method) { ! return method.getDoc().hasTag("ejb.create-method"); } /** ! * Returns true if method is a home method marked with a [EMAIL PROTECTED] tag, false otherwise. * ! * @param method The method to test ! * @return true if ejb.home-method tag found */ public static boolean isHomeMethod(XMethod method) *************** *** 161,169 **** /** ! * Gets the CompNameFor attribute of the HomeTagsHandler class * ! * @param clazz Describe what the parameter does ! * @param type Describe what the parameter does ! * @return The CompNameFor value */ public static String getCompNameFor(XClass clazz, String type) --- 161,169 ---- /** ! * Returns a suitable component name (which could be used, for example, in JNDI lookups) for a class. * ! * @param clazz the class ! * @param type interface view type, \"local\" or \"remote\" ! * @return compname */ public static String getCompNameFor(XClass clazz, String type) *************** *** 181,186 **** * Returns true if method is an ejbFind method, false otherwise. * ! * @param method Description of Parameter ! * @return The FinderMethod value */ public static boolean isFinderMethod(XMethod method) --- 181,186 ---- * Returns true if method is an ejbFind method, false otherwise. * ! * @param method The method to test ! * @return true if name starts with ejbFind */ public static boolean isFinderMethod(XMethod method) *************** *** 511,515 **** * * @param attributes The attributes of the template tag ! * @return Description of the Returned Value * @doc.tag type="content" */ --- 511,515 ---- * * @param attributes The attributes of the template tag ! * @return Equivalent ejbPostCreate method name * @doc.tag type="content" */ *************** *** 539,543 **** if (isHomeMethod(getCurrentMethod())) { ! if (superclasses == false && getCurrentMethod().getContainingClass() != getCurrentClass() && shouldTraverseSuperclassForDependentClass(getCurrentMethod().getContainingClass(), "ejb:home") == false) { return; } --- 539,544 ---- if (isHomeMethod(getCurrentMethod())) { ! if (superclasses == false && getCurrentMethod().getContainingClass() != getCurrentClass() ! && shouldTraverseSuperclassForDependentClass(getCurrentMethod().getContainingClass(), "ejb:home") == false) { return; } *************** *** 548,552 **** /** ! * Evaluates the body block if current method is ejbRemove method. * * @param template The body of the block tag --- 549,553 ---- /** ! * Evaluates the body block if current method is not an ejbRemove method. * * @param template The body of the block tag *************** *** 978,981 **** --- 979,983 ---- * @exception XDocletException * @doc.tag type="content" + * @todo i18n */ public String currentType() throws XDocletException *************** *** 997,1000 **** --- 999,1003 ---- * @exception XDocletException * @doc.tag type="content" + * @todo i18n */ public String finderClass() throws XDocletException *************** *** 1069,1075 **** * Return name of current home method. * ! * @return Describe the return value * @exception XDocletException * @doc.tag type="content" */ public String currentMethod() throws XDocletException --- 1072,1079 ---- * Return name of current home method. * ! * @return method name * @exception XDocletException * @doc.tag type="content" + * @todo i18n */ public String currentMethod() throws XDocletException *************** *** 1086,1094 **** /** ! * Return definition of parameter list for current home method. * ! * @return * @exception XDocletException * @doc.tag type="content" */ public String parameterListDefinition() throws XDocletException --- 1090,1099 ---- /** ! * Return parameter list definition (types and names) for current home method. * ! * @return comma-separated parameter list * @exception XDocletException * @doc.tag type="content" + * @todo i18n */ public String parameterListDefinition() throws XDocletException *************** *** 1105,1111 **** /** ! * Return parameter list for current home method. * ! * @return * @exception XDocletException * @doc.tag type="content" --- 1110,1116 ---- /** ! * Return parameter list (names only) for current home method. * ! * @return comma-separated parameter list * @exception XDocletException * @doc.tag type="content" *************** *** 1129,1133 **** * Return exceptions for current home method. * ! * @return * @exception XDocletException * @doc.tag type="content" --- 1134,1138 ---- * Return exceptions for current home method. * ! * @return exceptions * @exception XDocletException * @doc.tag type="content" *************** *** 1198,1201 **** --- 1203,1214 ---- } + /** + * Returns true if an XTag has a view-type compatible with the specified type. A view-type is compatible if it is + * the same as type or \"both\". A missing or empty view-type is assumed to be compatible. + * + * @param tag The XTag to check + * @param type The desired view-type + * @return true if the tag's view-type is compatible + */ protected boolean matchesViewType(XTag tag, String type) { *************** *** 1205,1208 **** --- 1218,1230 ---- } + /** + * Check every XTag in a collection and return true if they all have a view-type compatible with the specified type. + * A view-type is compatible if it is the same as type or \"both\". A missing or empty view-type is assumed to be + * compatible. + * + * @param tags Collection of XTag to be checked. + * @param type The desired view-type + * @return true if all tags' view-type parameters are compatible + */ protected boolean matchesViewType(Collection tags, String type) { ------------------------------------------------------- This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting Tool for open source databases. Create drag-&-drop reports. Save time by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc. Download a FREE copy at http://www.intelliview.com/go/osdn_nl _______________________________________________ xdoclet-devel mailing list xdoclet-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/xdoclet-devel