User: pathoss
Date: 02/05/15 00:33:35
Modified: core/src/xdoclet Tag: MODULE_REFACTORING_BRANCH
XDocletTagSupport.java
Log:
Changed method name (getProgramElement).
Revision Changes Path
No revision
No revision
1.43.2.4 +47 -74 xdoclet/core/src/xdoclet/XDocletTagSupport.java
Index: XDocletTagSupport.java
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/src/xdoclet/XDocletTagSupport.java,v
retrieving revision 1.43.2.3
retrieving revision 1.43.2.4
diff -u -w -r1.43.2.3 -r1.43.2.4
--- XDocletTagSupport.java 12 May 2002 11:58:01 -0000 1.43.2.3
+++ XDocletTagSupport.java 15 May 2002 07:33:35 -0000 1.43.2.4
@@ -28,12 +28,11 @@
import xdoclet.util.TypeConversionUtil;
/**
- * Derives from TemplateTagHandler and adds handy support methods for working
- * with Javadoc Doclet classes.
+ * Derives from TemplateTagHandler and adds handy support methods for working with
Javadoc Doclet classes.
*
* @author Dmitri Colebatch ([EMAIL PROTECTED])
* @created October 12, 2001
- * @version $Revision: 1.43.2.3 $
+ * @version $Revision: 1.43.2.4 $
*/
public abstract class XDocletTagSupport extends TemplateTagHandler
{
@@ -64,8 +63,7 @@
}
/**
- * Provides the current method in the XDoclet build, or null if there is no
- * current method.
+ * Provides the current method in the XDoclet build, or null if there is no
current method.
*
* @return The CurrentMethod value
* @see #setCurrentMethod
@@ -76,8 +74,7 @@
}
/**
- * Provides the current field in the XDoclet build, or null if there is no
- * current field.
+ * Provides the current field in the XDoclet build, or null if there is no
current field.
*
* @return The CurrentField value
* @see #setCurrentField
@@ -88,8 +85,7 @@
}
/**
- * Provides the current constructor in the XDoclet build, or null if there
- * is no current constructor.
+ * Provides the current constructor in the XDoclet build, or null if there is
no current constructor.
*
* @return The CurrentConstructor value
* @see #setCurrentConstructor
@@ -100,8 +96,7 @@
}
/**
- * Provides the current class in the XDoclet build, or null if there is no
- * current class.
+ * Provides the current class in the XDoclet build, or null if there is no
current class.
*
* @return The CurrentClass value
* @see #pushCurrentClass
@@ -113,8 +108,7 @@
}
/**
- * Provides the current package in the XDoclet build, or null if there is no
- * current package.
+ * Provides the current package in the XDoclet build, or null if there is no
current package.
*
* @return The CurrentPackage value
*/
@@ -146,8 +140,7 @@
}
/**
- * Sets current class to clazz by clearing currentClassStack stack and
- * pushing clazz into top of it.
+ * Sets current class to clazz by clearing currentClassStack stack and pushing
clazz into top of it.
*
* @param clazz The new CurrentClass value
* @see #getCurrentClass()
@@ -200,19 +193,15 @@
}
/**
- * Replaces <code>${xxx}</code> style constructions in the given value with
- * the string value of the corresponding data types. NOTE: This method was
- * taken directly from Ant's source code
- * (org.apache.tools.ant.ProjectHelper) and modified slightly to use a Map
- * instead of a HashMap.
- *
- * @param value The string to be scanned for property references. May be
- * <code>null</code> , in which case this method returns immediately
- * with no effect.
- * @param keys Mapping (String to String) of property names to their
- * values. Must not be <code>null</code>.
- * @return the original string with the properties replaced, or
<code>null</code>
- * if the original string is <code>null</code>.
+ * Replaces <code>${xxx}</code> style constructions in the given value with the
string value of the corresponding
+ * data types. NOTE: This method was taken directly from Ant's source code
(org.apache.tools.ant.ProjectHelper) and
+ * modified slightly to use a Map instead of a HashMap.
+ *
+ * @param value The string to be scanned for property references. May be
<code>null</code> , in which case this
+ * method returns immediately with no effect.
+ * @param keys Mapping (String to String) of property names to their values.
Must not be <code>null</code>.
+ * @return the original string with the properties replaced, or
<code>null</code> if the original string is
+ * <code>null</code>.
*/
public static String replaceProperties(String value, Map keys)
{
@@ -245,20 +234,15 @@
}
/**
- * Parses a string containing <code>${xxx}</code> style property references
- * into two lists. The first list is a collection of text fragments, while
- * the other is a set of string property names. <code>null</code> entries in
- * the first list indicate a property reference from the second list. NOTE:
- * This method was taken directly from Ant's source code
- * (org.apache.tools.ant.ProjectHelper) with the BuildException throwing
- * removed.
+ * Parses a string containing <code>${xxx}</code> style property references
into two lists. The first list is a
+ * collection of text fragments, while the other is a set of string property
names. <code>null</code> entries in the
+ * first list indicate a property reference from the second list. NOTE: This
method was taken directly from Ant's
+ * source code (org.apache.tools.ant.ProjectHelper) with the BuildException
throwing removed.
*
* @param value Text to parse. Must not be <code>null</code>.
- * @param fragments List to add text fragments to. Must not be
<code>null</code>
- * .
+ * @param fragments List to add text fragments to. Must not be
<code>null</code> .
* @param propertyRefs List to add property names to. Must not be
<code>null</code>
- * @todo move to some Util class. -Not DocletUtil, some more
- * generic util class. .
+ * @todo move to some Util class. -Not DocletUtil, some more
generic util class. .
*/
public static void parsePropertyString(String value, List fragments, List
propertyRefs)
{
@@ -322,8 +306,7 @@
}
/**
- * Push the specified class to the top of the current class stack making it
- * effectively the current class.
+ * Push the specified class to the top of the current class stack making it
effectively the current class.
*
* @param clazz The class to push onto the top of the class stack.
* @return The class on the top of the stack.
@@ -356,17 +339,13 @@
}
/**
- * Return the Value of a tag specified in a Properties object. This method
- * work on the currentTag object variable, matchs it against the XTag
- * specified in the attributes Properties and returns the value of the
- * specified tag.
+ * Return the Value of a tag specified in a Properties object. This method work
on the currentTag object variable,
+ * matchs it against the XTag specified in the attributes Properties and
returns the value of the specified tag.
*
* @param attributes The attributes of the template tag
- * @param forType if FOR_CLASS, then a fifth property
- * superclasses is searched, if this is set to true, then the tag is
- * also searched in all superclasses of current class. If forType is
- * set to FOR_METHOD or FOR_CONSTRUCTOR or FOR_FIELD, current method or
- * field is searched for the tag.
+ * @param forType if FOR_CLASS, then a fifth property
superclasses is searched, if this is set to
+ * true, then the tag is also searched in all superclasses of current
class. If forType is set to FOR_METHOD or
+ * FOR_CONSTRUCTOR or FOR_FIELD, current method or field is searched for
the tag.
* @return The TagValue value
* @exception XDocletException Description of Exception
*/
@@ -436,7 +415,7 @@
// String currentParamNumber = paramNum;
if (currentParamNumber != null) {
- XProgramElement programElement = getPrgElem(forType);
+ XProgramElement programElement = getProgramElement(forType);
XDoc doc = programElement.doc();
XTag tag = doc.tag(currentTag, superclasses);
@@ -484,7 +463,7 @@
) throws XDocletException
{
- XProgramElement programElement = getPrgElem(forType);
+ XProgramElement programElement = getProgramElement(forType);
if (programElement == null) {
return null;
@@ -515,8 +494,7 @@
* @param forType
* @return The TagValue value
* @exception XDocletException Describe the exception
- * @todo (Aslak) maybe this method ought to be moved
- * to xjavadoc.XDoc? Not a big deal though.
+ * @todo (Aslak) maybe this method ought to be moved to
xjavadoc.XDoc? Not a big deal though.
*/
protected static String getTagValue(
int forType,
@@ -588,9 +566,8 @@
}
/**
- * A utility method used by ifMethodTagValueEquals/ifMethodTagValueNotEquals
- * and ifClassTagValueEquals/ifClassTagValueNotEquals, return true if the
- * value of the tag/XParameter equals with value.
+ * A utility method used by ifMethodTagValueEquals/ifMethodTagValueNotEquals and
+ * ifClassTagValueEquals/ifClassTagValueNotEquals, return true if the value of
the tag/XParameter equals with value.
*
* @param attributes The attributes of the template tag
* @param forType Describe what the parameter does
@@ -633,9 +610,8 @@
}
/**
- * Throws an XDocletException exception to stop the build process. The
- * exception has an informative message to help user find out the cause of
- * the error (not specifying a mandatory parameter for a tag).
+ * Throws an XDocletException exception to stop the build process. The
exception has an informative message to help
+ * user find out the cause of the error (not specifying a mandatory parameter
for a tag).
*
* @param paramName Description of Parameter
* @param tagName Description of Parameter
@@ -677,9 +653,8 @@
}
/**
- * A utility method used by ifHasClassTag/ifDoesntHaveClassTag and
- * ifHasMethodTag/ifDoesntHaveMethodTag, return true if at least one tag
- * exists with the specified name.
+ * A utility method used by ifHasClassTag/ifDoesntHaveClassTag and
ifHasMethodTag/ifDoesntHaveMethodTag, return true
+ * if at least one tag exists with the specified name.
*
* @param attributes The attributes of the template tag
* @param forType
@@ -695,8 +670,7 @@
* @param attributeValue Describe what the parameter does
* @param attributes Describe what the parameter does
* @return Describe the return value
- * @todo fix the () equals test, it is not nice. Test :
- * finder Home definition on AccountBean
+ * @todo fix the () equals test, it is not nice. Test : finder
Home definition on AccountBean
*/
protected static String delimit(String attributeValue, Properties attributes)
{
@@ -731,28 +705,28 @@
}
/**
- * Replace properties in a string. Properties are in the form ${prop.name}
- * and the replace properties are obtained from the DocletContext.
+ * Replace properties in a string. Properties are in the form ${prop.name} and
the replace properties are obtained
+ * from the DocletContext.
*
* @param value The string to check for properties.
* @return The value replaced with any property substitutions
*/
protected static String dereferenceProperties(String value)
{
- // check to see if the property has a value.
+ // check to see if the property has a value
Map properties = DocletContext.getInstance().getProperties();
return replaceProperties(value, properties);
}
/**
- * Gets the PrgElem attribute of the XDocletTagSupport class
+ * Gets the XProgramElement attribute of the XDocletTagSupport class.
*
* @param forType Describe what the parameter does
* @return The PrgElem value
* @exception XDocletException Describe the exception
*/
- private static XProgramElement getPrgElem(int forType) throws XDocletException
+ private static XProgramElement getProgramElement(int forType) throws
XDocletException
{
XProgramElement programElement = null;
@@ -776,9 +750,8 @@
}
/**
- * Throws an XDocletException exception to stop the build process. The
- * exception has an informative message to help user find out the cause of
- * the error (specifying an incorrect value for a parameter of a tag).
+ * Throws an XDocletException exception to stop the build process. The
exception has an informative message to help
+ * user find out the cause of the error (specifying an incorrect value for a
parameter of a tag).
*
* @param paramName Description of Parameter
* @param tagName Description of Parameter
@@ -830,7 +803,7 @@
*/
protected String modifiers(int forType) throws XDocletException
{
- return getPrgElem(forType).modifiers();
+ return getProgramElement(forType).modifiers();
}
/**
_______________________________________________________________
Have big pipes? SourceForge.net is looking for download mirrors. We supply
the hardware. You get the recognition. Email Us: [EMAIL PROTECTED]
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
