You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by he...@apache.org on 2006/09/17 19:40:58 UTC
svn commit: r447102 - in
/jakarta/velocity/engine/trunk/src/java/org/apache/velocity: ./ anakia/
app/ app/event/ runtime/
Author: henning
Date: Sun Sep 17 10:40:57 2006
New Revision: 447102
URL: http://svn.apache.org/viewvc?view=rev&rev=447102
Log:
Fix up a number of javadoc problems.
Modified:
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/Template.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaElement.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/Velocity.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerUtil.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/Runtime.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeInstance.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeSingleton.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/VelocimacroFactory.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/VelocimacroManager.java
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/Template.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/Template.java?view=diff&rev=447102&r1=447101&r2=447102
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/Template.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/Template.java Sun Sep 17 10:40:57 2006
@@ -172,6 +172,7 @@
* dependant upon context, but we need to let the
* init() carry the template name down throught for VM
* namespace features
+ * @throws Exception When a problem occurs during the document initialization.
*/
public void initDocument()
throws Exception
@@ -221,6 +222,7 @@
* from any available source.
* @throws ParseErrorException if template cannot be parsed due
* to syntax (or other) error.
+ * @throws MethodInvocationException When a method on a referenced object in the context could not invoked.
* @throws Exception anything else.
*/
public void merge( Context context, Writer writer)
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaElement.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaElement.java?view=diff&rev=447102&r1=447101&r2=447102
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaElement.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaElement.java Sun Sep 17 10:40:57 2006
@@ -54,7 +54,7 @@
* </p>
*
* @param name <code>String</code> name of element.
- * @namespace <code>Namespace</code> to put element in.
+ * @param namespace <code>Namespace</code> to put element in.
*/
public AnakiaElement(String name, Namespace namespace)
{
@@ -101,6 +101,7 @@
* </p>
*
* @param name <code>String</code> name of element.
+ * @param prefix The prefix of the element.
* @param uri <code>String</code> URI for <code>Namespace</code> element
* should be in.
*/
@@ -131,7 +132,11 @@
/**
* Returns the XML serialized form of this element, as produced by the default
* {@link XMLOutputter}.
+
+ * @return The XML serialized form of this element, as produced by the default
+ * {@link XMLOutputter}.
*/
+
public String toString()
{
return DEFAULT_OUTPUTTER.outputString(this);
@@ -150,10 +155,10 @@
*
* @return a <code>List</code> containing the mixed content of the
* element: may contain <code>String</code>,
- * <code>{@link Element}</code>, <code>{@link Comment}</code>,
- * <code>{@link ProcessingInstruction}</code>,
- * <code>{@link CDATA}</code>, and
- * <code>{@link EntityRef}</code> objects.
+ * <code>{@link Element}</code>, <code>{@link org.jdom.Comment}</code>,
+ * <code>{@link org.jdom.ProcessingInstruction}</code>,
+ * <code>{@link org.jdom.CDATA}</code>, and
+ * <code>{@link org.jdom.EntityRef}</code> objects.
*/
public List getContent()
{
@@ -202,7 +207,7 @@
* and changes to it affect the element's actual contents.
* </p>
* <p>
- * Please see the notes for <code>{@link #getChildren}</code>
+ * Please see the notes for <code>{@link #getChildren()}</code>
* for a code example.
* </p>
*
@@ -225,7 +230,7 @@
* and changes to it affect the element's actual contents.
* </p>
* <p>
- * Please see the notes for <code>{@link #getChildren}</code>
+ * Please see the notes for <code>{@link #getChildren()}</code>
* for a code example.
* </p>
*
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/Velocity.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/Velocity.java?view=diff&rev=447102&r1=447101&r2=447102
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/Velocity.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/Velocity.java Sun Sep 17 10:40:57 2006
@@ -70,6 +70,8 @@
/**
* initialize the Velocity runtime engine, using the default
* properties of the Velocity distribution
+ *
+ * @throws Exception When an error during initialization occurs.
*/
public static void init()
throws Exception
@@ -83,6 +85,7 @@
*
* @param propsFilename file containing properties to use to initialize
* the Velocity runtime
+ * @throws Exception When an error during initialization occurs.
*/
public static void init( String propsFilename )
throws Exception
@@ -95,6 +98,7 @@
* plus the properties in the passed in java.util.Properties object
*
* @param p Properties object containing initialization properties
+ * @throws Exception When an error during initialization occurs.
*
*/
public static void init( Properties p )
@@ -106,8 +110,8 @@
/**
* Set a Velocity Runtime property.
*
- * @param String key
- * @param Object value
+ * @param key The property key.
+ * @param value The property value.
*/
public static void setProperty(String key, Object value)
{
@@ -117,8 +121,8 @@
/**
* Add a Velocity Runtime property.
*
- * @param String key
- * @param Object value
+ * @param key The property key.
+ * @param value The property value.
*/
public static void addProperty(String key, Object value)
{
@@ -141,7 +145,7 @@
* the ExtendedProperties class and the velocity configuration
* is a subset of the parent application's configuration.
*
- * @param ExtendedProperties configuration
+ * @param configuration A configuration object.
*
*/
public static void setExtendedProperties( ExtendedProperties configuration)
@@ -174,6 +178,10 @@
*
* @return true if successful, false otherwise. If false, see
* Velocity runtime log
+ * @throws ParseErrorException The template could not be parsed.
+ * @throws MethodInvocationException A method on a context object could not be invoked.
+ * @throws ResourceNotFoundException A referenced resource could not be loaded.
+ * @throws IOException While loading a reference, an I/O problem occured.
*/
public static boolean evaluate( Context context, Writer out,
String logTag, String instring )
@@ -189,7 +197,7 @@
* use Velocity as a token replacer.
*
* @param context context to use in rendering input string
- * @param out Writer in which to render the output
+ * @param writer Writer in which to render the output
* @param logTag string to be used as the template name for log messages
* in case of error
* @param instream input stream containing the VTL to be rendered
@@ -199,6 +207,10 @@
* @deprecated Use
* {@link #evaluate( Context context, Writer writer,
* String logTag, Reader reader ) }
+ * @throws ParseErrorException The template could not be parsed.
+ * @throws MethodInvocationException A method on a context object could not be invoked.
+ * @throws ResourceNotFoundException A referenced resource could not be loaded.
+ * @throws IOException While loading a reference, an I/O problem occured.
*/
public static boolean evaluate( Context context, Writer writer,
String logTag, InputStream instream )
@@ -232,13 +244,17 @@
* use Velocity as a token replacer.
*
* @param context context to use in rendering input string
- * @param out Writer in which to render the output
+ * @param writer Writer in which to render the output
* @param logTag string to be used as the template name for log messages
* in case of error
* @param reader Reader containing the VTL to be rendered
*
* @return true if successful, false otherwise. If false, see
* Velocity runtime log
+ * @throws ParseErrorException The template could not be parsed.
+ * @throws MethodInvocationException A method on a context object could not be invoked.
+ * @throws ResourceNotFoundException A referenced resource could not be loaded.
+ * @throws IOException While loading a reference, an I/O problem occured.
*
* @since Velocity v1.1
*/
@@ -305,7 +321,7 @@
*
* @param vmName name of Velocimacro to call
* @param logTag string to be used for template name in case of error
- * @param params[] args used to invoke Velocimacro. In context key format :
+ * @param params args used to invoke Velocimacro. In context key format :
* eg "foo","bar" (rather than "$foo","$bar")
* @param context Context object containing data/objects used for rendering.
* @param writer Writer for output stream
@@ -402,6 +418,10 @@
* @deprecated Use
* {@link #mergeTemplate( String templateName, String encoding,
* Context context, Writer writer )}
+ * @throws ParseErrorException The template could not be parsed.
+ * @throws MethodInvocationException A method on a context object could not be invoked.
+ * @throws ResourceNotFoundException A referenced resource could not be loaded.
+ * @throws Exception Any other exception.
*/
public static boolean mergeTemplate( String templateName,
Context context, Writer writer )
@@ -422,7 +442,12 @@
* @return true if successful, false otherwise. Errors
* logged to velocity log
*
- * @since Velocity v1.1
+ * @throws ParseErrorException The template could not be parsed.
+ * @throws MethodInvocationException A method on a context object could not be invoked.
+ * @throws ResourceNotFoundException A referenced resource could not be loaded.
+ * @throws Exception Any other exception.
+ *
+ * @since Velocity v1.1
*/
public static boolean mergeTemplate( String templateName, String encoding,
Context context, Writer writer )
@@ -504,6 +529,8 @@
/**
* Returns a convenient Log instance that wraps the current LogChute.
* Use this to log error messages. It has the usual methods.
+ *
+ * @return A convenience Log instance that wraps the current LogChute.
*/
public static Log getLog()
{
@@ -512,6 +539,8 @@
/**
* @deprecated Use getLog() and call warn() on it.
+ * @see Log#warn(Object)
+ * @param message The message to log.
*/
public static void warn(Object message)
{
@@ -520,6 +549,8 @@
/**
* @deprecated Use getLog() and call info() on it.
+ * @see Log#info(Object)
+ * @param message The message to log.
*/
public static void info(Object message)
{
@@ -528,6 +559,8 @@
/**
* @deprecated Use getLog() and call error() on it.
+ * @see Log#error(Object)
+ * @param message The message to log.
*/
public static void error(Object message)
{
@@ -536,6 +569,8 @@
/**
* @deprecated Use getLog() and call debug() on it.
+ * @see Log#debug(Object)
+ * @param message The message to log.
*/
public static void debug(Object message)
{
@@ -569,6 +604,8 @@
}
/**
+ * @param resourceName Name of the Template to check.
+ * @return True if the template exists.
* @see #resourceExists(String)
* @deprecated Use resourceExists(String) instead.
*/
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerUtil.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerUtil.java?view=diff&rev=447102&r1=447101&r2=447102
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerUtil.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerUtil.java Sun Sep 17 10:40:57 2006
@@ -39,6 +39,8 @@
*
* @param reference reference from template about to be inserted
* @param value value about to be inserted (after toString() )
+ * @param rsvc The RuntimeServices Object.
+ * @param context The internal context adapter.
* @return Object on which toString() should be called for output.
*/
public static Object referenceInsert(RuntimeServices rsvc,
@@ -92,8 +94,10 @@
* called in sequence until a false is returned. The default implementation
* always returns true.
*
- * @param reference
- * reference from template about to be inserted
+ * @param lhs Left hand side of the expression.
+ * @param rhs Right hand side of the expression.
+ * @param rsvc The RuntimeServices Object.
+ * @param context The internal context adapter.
* @return true if to be logged, false otherwise
*/
public static boolean shouldLogOnNullSet(RuntimeServices rsvc,
@@ -155,8 +159,10 @@
* method called that causes the exception
* @param e
* Exception thrown by the method
+ * @param rsvc The RuntimeServices Object.
+ * @param context The internal context adapter.
* @return Object to return as method result
- * @throws exception
+ * @throws Exception
* to be wrapped and propogated to app
*/
public static Object methodException(RuntimeServices rsvc,
@@ -221,6 +227,8 @@
* @param directiveName
* name of the directive used to include the resource. (With the
* standard directives this is either "parse" or "include").
+ * @param rsvc The RuntimeServices Object.
+ * @param context The internal context adapter.
*
* @return a new resource path for the directive, or null to block the
* include from occurring.
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/Runtime.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/Runtime.java?view=diff&rev=447102&r1=447101&r2=447102
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/Runtime.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/Runtime.java Sun Sep 17 10:40:57 2006
@@ -90,7 +90,7 @@
public class Runtime implements RuntimeConstants
{
- /*
+ /**
* This is the primary initialization method in the Velocity
* Runtime. The systems that are setup/initialized here are
* as follows:
@@ -103,6 +103,8 @@
* <li>Static Content Include System</li>
* <li>Velocimacro System</li>
* </ul>
+ *
+ * @throws Exception When init fails for any reason.
*/
public synchronized static void init()
throws Exception
@@ -114,8 +116,8 @@
* Allows an external system to set a property in
* the Velocity Runtime.
*
- * @param String property key
- * @param String property value
+ * @param key The property key.
+ * @param value The property value.
*/
public static void setProperty(String key, Object value)
{
@@ -130,7 +132,7 @@
* parent application's configuration. This is
* the case with Turbine.
*
- * @param ExtendedProperties configuration
+ * @param configuration A configuration object.
*/
public static void setConfiguration( ExtendedProperties configuration)
{
@@ -153,8 +155,8 @@
*
* ["file", "classpath"]
*
- * @param String key
- * @param String value
+ * @param key A property key.
+ * @param value The property value.
*/
public static void addProperty(String key, Object value)
{
@@ -165,7 +167,7 @@
* Clear the values pertaining to a particular
* property.
*
- * @param String key of property to clear
+ * @param key Name of the property to clear.
*/
public static void clearProperty(String key)
{
@@ -178,6 +180,7 @@
* will return an Object, as that is what properties can be.
*
* @param key property to return
+ * @return The property value or null.
*/
public static Object getProperty( String key )
{
@@ -188,7 +191,8 @@
* Initialize the Velocity Runtime with a Properties
* object.
*
- * @param Properties
+ * @param p The properties used for initializiation.
+ * @throws Exception When a problem occurs during init.
*/
public static void init(Properties p) throws Exception
{
@@ -198,8 +202,9 @@
/**
* Initialize the Velocity Runtime with the name of
* ExtendedProperties object.
- *
- * @param Properties
+ * *
+ * @param configurationFile The name of a properties file.
+ * @throws Exception When a problem occurs during init.
*/
public static void init(String configurationFile)
throws Exception
@@ -220,8 +225,10 @@
* PARSER_POOL_SIZE property appropriately for their
* application. We will revisit this.
*
- * @param InputStream inputstream retrieved by a resource loader
- * @param String name of the template being parsed
+ * @param reader A reader returning the template input stream.
+ * @param templateName name of the template being parsed
+ * @return The root node of an AST structure for the template input stream.
+ * @throws ParseException When the input stream is not parsable.
*/
public static SimpleNode parse( Reader reader, String templateName )
throws ParseException
@@ -230,11 +237,15 @@
}
/**
- * Parse the input and return the root of the AST node structure.
+ * Parse the input and return the root of the AST node structure.
+ *
+ * @see #parse(Reader, String)
*
- * @param InputStream inputstream retrieved by a resource loader
- * @param String name of the template being parsed
- * @param dumpNamespace flag to dump the Velocimacro namespace for this template
+ * @param reader A reader returning the template input stream.
+ * @param templateName name of the template being parsed
+ * @param dumpNamespace flag to dump the Velocimacro namespace for this template.
+ * @return The root node of an AST structure for the template input stream.
+ * @throws ParseException When the input stream is not parsable.
*/
public static SimpleNode parse( Reader reader, String templateName, boolean dumpNamespace )
throws ParseException
@@ -255,7 +266,7 @@
* from any available source.
* @throws ParseErrorException if template cannot be parsed due
* to syntax (or other) error.
- * @throws Exception if an error occurs in template initialization
+ * @throws Exception if an error occurs in template initialization.
*/
public static Template getTemplate(String name)
throws ResourceNotFoundException, ParseErrorException, Exception
@@ -290,6 +301,9 @@
* @return parsed ContentResource object ready for use
* @throws ResourceNotFoundException if template not found
* from any available source.
+ * @throws ParseErrorException if template cannot be parsed due
+ * to syntax (or other) error.
+ * @throws Exception if an error occurs in template initialization
*/
public static ContentResource getContent(String name)
throws ResourceNotFoundException, ParseErrorException, Exception
@@ -306,6 +320,9 @@
* @return parsed ContentResource object ready for use
* @throws ResourceNotFoundException if template not found
* from any available source.
+ * @throws ParseErrorException if template cannot be parsed due
+ * to syntax (or other) error.
+ * @throws Exception if an error occurs in template initialization
*/
public static ContentResource getContent( String name, String encoding )
throws ResourceNotFoundException, ParseErrorException, Exception
@@ -332,7 +349,7 @@
/**
* Log a warning message.
*
- * @param Object message to log
+ * @param message message to log
*/
public static void warn(Object message)
{
@@ -342,7 +359,7 @@
/**
* Log an info message.
*
- * @param Object message to log
+ * @param message message to log
*/
public static void info(Object message)
{
@@ -352,7 +369,7 @@
/**
* Log an error message.
*
- * @param Object message to log
+ * @param message message to log
*/
public static void error(Object message)
{
@@ -362,7 +379,7 @@
/**
* Log a debug message.
*
- * @param Object message to log
+ * @param message message to log
*/
public static void debug(Object message)
{
@@ -373,10 +390,10 @@
* String property accessor method with default to hide the
* configuration implementation.
*
- * @param String key property key
- * @param String defaultValue default value to return if key not
+ * @param key A property key.
+ * @param defaultValue default value to return if key not
* found in resource manager.
- * @return String value of key or default
+ * @return The property value of of key or default.
*/
public static String getString( String key, String defaultValue)
{
@@ -387,8 +404,9 @@
* Returns the appropriate VelocimacroProxy object if strVMname
* is a valid current Velocimacro.
*
- * @param String vmName Name of velocimacro requested
- * @return String VelocimacroProxy
+ * @param vmName Name of velocimacro requested
+ * @param templateName The template from which the macro is requested.
+ * @return A VelocimacroProxy object for the macro.
*/
public static Directive getVelocimacro( String vmName, String templateName )
{
@@ -398,10 +416,11 @@
/**
* Adds a new Velocimacro. Usually called by Macro only while parsing.
*
- * @param String name Name of velocimacro
- * @param String macro String form of macro body
- * @param String argArray Array of strings, containing the
- * #macro() arguments. the 0th is the name.
+ * @param name Name of a new velocimacro.
+ * @param macro String form of the macro body.
+ * @param argArray Array of strings, containing the
+ * #macro() arguments. the 0th argument is the name.
+ * @param sourceTemplate The template from which the macro is requested.
* @return boolean True if added, false if rejected for some
* reason (either parameters or permission settings)
*/
@@ -416,7 +435,8 @@
/**
* Checks to see if a VM exists
*
- * @param name Name of velocimacro
+ * @param vmName The name of velocimacro.
+ * @param templateName The template from which the macro is requested.
* @return boolean True if VM by that name exists, false if not
*/
public static boolean isVelocimacro( String vmName, String templateName )
@@ -427,6 +447,9 @@
/**
* tells the vmFactory to dump the specified namespace. This is to support
* clearing the VM list when in inline-VM-local-scope mode
+ *
+ * @param namespace The namespace to dump.
+ * @return True if the namespace has been dumped.
*/
public static boolean dumpVMNamespace( String namespace )
{
@@ -458,8 +481,8 @@
/**
* Int property accessor method to hide the configuration implementation.
*
- * @param String key property key
- * @return int value
+ * @param key A property key.
+ * @return Integer value for this key.
*/
public static int getInt( String key )
{
@@ -470,8 +493,8 @@
* Int property accessor method to hide the configuration implementation.
*
* @param key property key
- * @param int default value
- * @return int value
+ * @param defaultValue default value
+ * @return The integer value.
*/
public static int getInt( String key, int defaultValue )
{
@@ -481,8 +504,8 @@
/**
* Boolean property accessor method to hide the configuration implementation.
*
- * @param String key property key
- * @param boolean default default value if property not found
+ * @param key property key
+ * @param def default default value if property not found
* @return boolean value of key or default value
*/
public static boolean getBoolean( String key, boolean def )
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeInstance.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeInstance.java?view=diff&rev=447102&r1=447101&r2=447102
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeInstance.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeInstance.java Sun Sep 17 10:40:57 2006
@@ -184,6 +184,9 @@
private Uberspect uberSpect;
+ /**
+ * Creates a new RuntimeInstance object.
+ */
public RuntimeInstance()
{
/*
@@ -202,7 +205,7 @@
applicationAttributes = new HashMap();
}
- /*
+ /**
* This is the primary initialization method in the Velocity
* Runtime. The systems that are setup/initialized here are
* as follows:
@@ -216,6 +219,7 @@
* <li>Static Content Include System</li>
* <li>Velocimacro System</li>
* </ul>
+ * @throws Exception When an error occured during initialization.
*/
public synchronized void init()
throws Exception
@@ -251,7 +255,7 @@
/**
* Returns true if the RuntimeInstance has been successfully initialized.
- * @return
+ * @return True if the RuntimeInstance has been successfully initialized.
*/
public boolean isInitialized()
{
@@ -452,6 +456,7 @@
* will return an Object, as that is what properties can be.
*
* @param key property to return
+ * @return Value of the property or null if it does not exist.
*/
public Object getProperty(String key)
{
@@ -496,6 +501,7 @@
* object.
*
* @param p
+ * @throws Exception When an error occurs during initialization.
*/
public void init(Properties p) throws Exception
{
@@ -508,6 +514,7 @@
* ExtendedProperties object.
*
* @param configurationFile
+ * @throws Exception When an error occurs during initialization.
*/
public void init(String configurationFile)
throws Exception
@@ -914,6 +921,8 @@
*
* @param reader Reader retrieved by a resource loader
* @param templateName name of the template being parsed
+ * @return A root node representing the template as an AST tree.
+ * @throws ParseException When the template could not be parsed.
*/
public SimpleNode parse(Reader reader, String templateName)
throws ParseException
@@ -930,6 +939,8 @@
* @param reader Reader retrieved by a resource loader
* @param templateName name of the template being parsed
* @param dumpNamespace flag to dump the Velocimacro namespace for this template
+ * @return A root node representing the template as an AST tree.
+ * @throws ParseException When the template could not be parsed.
*/
public SimpleNode parse(Reader reader, String templateName, boolean dumpNamespace)
throws ParseException
@@ -951,7 +962,6 @@
SimpleNode ast = null;
Parser parser = (Parser) parserPool.get();
- boolean madeNew = false;
if (parser == null)
{
@@ -969,10 +979,6 @@
parser = createNewParser();
- if (parser != null)
- {
- madeNew = true;
- }
}
/*
@@ -1068,6 +1074,8 @@
* @return parsed ContentResource object ready for use
* @throws ResourceNotFoundException if template not found
* from any available source.
+ * @throws ParseErrorException When the template could not be parsed.
+ * @throws Exception Any other error.
*/
public ContentResource getContent(String name)
throws ResourceNotFoundException, ParseErrorException, Exception
@@ -1089,6 +1097,8 @@
* @return parsed ContentResource object ready for use
* @throws ResourceNotFoundException if template not found
* from any available source.
+ * @throws ParseErrorException When the template could not be parsed.
+ * @throws Exception Any other error.
*/
public ContentResource getContent(String name, String encoding)
throws ResourceNotFoundException, ParseErrorException, Exception
@@ -1137,6 +1147,9 @@
/**
* Returns a convenient Log instance that wraps the current LogChute.
+ * Use this to log error messages. It has the usual methods.
+ *
+ * @return A convenience Log instance that wraps the current LogChute.
*/
public Log getLog()
{
@@ -1145,6 +1158,8 @@
/**
* @deprecated Use getLog() and call warn() on it.
+ * @see Log#warn(Object)
+ * @param message The message to log.
*/
public void warn(Object message)
{
@@ -1153,6 +1168,8 @@
/**
* @deprecated Use getLog() and call info() on it.
+ * @see Log#info(Object)
+ * @param message The message to log.
*/
public void info(Object message)
{
@@ -1161,6 +1178,8 @@
/**
* @deprecated Use getLog() and call error() on it.
+ * @see Log#error(Object)
+ * @param message The message to log.
*/
public void error(Object message)
{
@@ -1169,6 +1188,8 @@
/**
* @deprecated Use getLog() and call debug() on it.
+ * @see Log#debug(Object)
+ * @param message The message to log.
*/
public void debug(Object message)
{
@@ -1194,6 +1215,7 @@
* is a valid current Velocimacro.
*
* @param vmName Name of velocimacro requested
+ * @param templateName Name of the template that contains the velocimacro.
* @return The requested VelocimacroProxy.
*/
public Directive getVelocimacro(String vmName, String templateName)
@@ -1202,15 +1224,16 @@
}
/**
- * Adds a new Velocimacro. Usually called by Macro only while parsing.
- *
- * @param name Name of velocimacro
- * @param macro String form of macro body
- * @param argArray Array of strings, containing the
- * #macro() arguments. the 0th is the name.
- * @return True if added, false if rejected for some
- * reason (either parameters or permission settings)
- */
+ * Adds a new Velocimacro. Usually called by Macro only while parsing.
+ *
+ * @param name Name of velocimacro
+ * @param macro String form of macro body
+ * @param argArray Array of strings, containing the
+ * #macro() arguments. the 0th is the name.
+ * @param sourceTemplate Name of the template that contains the velocimacro.
+ * @return True if added, false if rejected for some
+ * reason (either parameters or permission settings)
+ */
public boolean addVelocimacro( String name,
String macro,
String argArray[],
@@ -1222,7 +1245,8 @@
/**
* Checks to see if a VM exists
*
- * @param name Name of the Velocimacro.
+ * @param vmName Name of the Velocimacro.
+ * @param templateName Template on which to look for the Macro.
* @return True if VM by that name exists, false if not
*/
public boolean isVelocimacro( String vmName, String templateName )
@@ -1231,8 +1255,10 @@
}
/**
- * tells the vmFactory to dump the specified namespace. This is to support
- * clearing the VM list when in inline-VM-local-scope mode
+ * tells the vmFactory to dump the specified namespace. This is to support
+ * clearing the VM list when in inline-VM-local-scope mode
+ * @param namespace Namespace to dump.
+ * @return True if namespace was dumped successfully.
*/
public boolean dumpVMNamespace(String namespace)
{
@@ -1276,8 +1302,8 @@
* Int property accessor method to hide the configuration implementation.
*
* @param key property key
- * @param int default value
- * @return int value
+ * @param defaultValue The default value.
+ * @return value
*/
public int getInt(String key, int defaultValue)
{
@@ -1288,7 +1314,7 @@
* Boolean property accessor method to hide the configuration implementation.
*
* @param key property key
- * @param default default value if property not found
+ * @param def The default value if property not found.
* @return value of key or default value
*/
public boolean getBoolean(String key, boolean def)
@@ -1309,6 +1335,7 @@
/**
* Return the Introspector for this instance
+ * @return The Introspector for this instance
*/
public Introspector getIntrospector()
{
@@ -1317,6 +1344,7 @@
/**
* Returns the event handlers for the application.
+ * @return The event handlers for the application.
*/
public EventCartridge getApplicationEventCartridge()
{
@@ -1328,7 +1356,7 @@
* Gets the application attribute for the given key
*
* @param key
- * @return
+ * @return The application attribute for the given key.
*/
public Object getApplicationAttribute(Object key)
{
@@ -1339,14 +1367,19 @@
* Sets the application attribute for the given key
*
* @param key
- * @param o
- * @return
+ * @param o The new application attribute.
+ * @return The old value of this attribute or null if it hasn't been set before.
*/
public Object setApplicationAttribute(Object key, Object o)
{
return applicationAttributes.put(key, o);
}
+ /**
+ * Returns the Uberspect object for this Instance.
+ *
+ * @return The Uberspect object for this Instance.
+ */
public Uberspect getUberspect()
{
return uberSpect;
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeSingleton.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeSingleton.java?view=diff&rev=447102&r1=447101&r2=447102
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeSingleton.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeSingleton.java Sun Sep 17 10:40:57 2006
@@ -101,6 +101,8 @@
* <li>Static Content Include System</li>
* <li>Velocimacro System</li>
* </ul>
+ * @throws Exception When an error occured during initialization.
+ * @see RuntimeInstance#init()
*/
public synchronized static void init()
throws Exception
@@ -109,8 +111,9 @@
}
/**
- * Returns true if the RuntimeSingleton has been successfully initialized.
- * @return
+ * Returns true if the RuntimeInstance has been successfully initialized.
+ * @return True if the RuntimeInstance has been successfully initialized.
+ * @see RuntimeInstance#isInitialized()
*/
public static boolean isInitialized()
{
@@ -118,7 +121,9 @@
}
/**
- * @return The RuntimeInstance used by this wrapper.
+ * Returns the RuntimeServices Instance used by this wrapper.
+ *
+ * @return The RuntimeServices Instance used by this wrapper.
*/
public static RuntimeServices getRuntimeServices()
{
@@ -130,8 +135,9 @@
* Allows an external system to set a property in
* the Velocity Runtime.
*
- * @param String property key
- * @param String property value
+ * @param key property key
+ * @param value property value
+ * @see RuntimeInstance#setProperty(String, Object)
*/
public static void setProperty(String key, Object value)
{
@@ -146,7 +152,8 @@
* parent application's configuration. This is
* the case with Turbine.
*
- * @param ExtendedProperties configuration
+ * @param configuration
+ * @see RuntimeInstance#setConfiguration(ExtendedProperties)
*/
public static void setConfiguration( ExtendedProperties configuration)
{
@@ -169,8 +176,9 @@
*
* ["file", "classpath"]
*
- * @param String key
- * @param String value
+ * @param key
+ * @param value
+ * @see RuntimeInstance#addProperty(String, Object)
*/
public static void addProperty(String key, Object value)
{
@@ -181,7 +189,8 @@
* Clear the values pertaining to a particular
* property.
*
- * @param String key of property to clear
+ * @param key of property to clear
+ * @see RuntimeInstance#clearProperty(String)
*/
public static void clearProperty(String key)
{
@@ -194,6 +203,8 @@
* will return an Object, as that is what properties can be.
*
* @param key property to return
+ * @return Value of the property or null if it does not exist.
+ * @see RuntimeInstance#getProperty(String)
*/
public static Object getProperty( String key )
{
@@ -204,7 +215,9 @@
* Initialize the Velocity Runtime with a Properties
* object.
*
- * @param Properties
+ * @param p
+ * @throws Exception When an error occurs during initialization.
+ * @see RuntimeInstance#init(Properties)
*/
public static void init(Properties p) throws Exception
{
@@ -215,7 +228,9 @@
* Initialize the Velocity Runtime with the name of
* ExtendedProperties object.
*
- * @param Properties
+ * @param configurationFile
+ * @throws Exception When an error occurs during initialization.
+ * @see RuntimeInstance#init(String)
*/
public static void init(String configurationFile)
throws Exception
@@ -235,8 +250,11 @@
* PARSER_POOL_SIZE property appropriately for their
* application. We will revisit this.
*
- * @param InputStream inputstream retrieved by a resource loader
- * @param String name of the template being parsed
+ * @param reader Reader retrieved by a resource loader
+ * @param templateName name of the template being parsed
+ * @return A root node representing the template as an AST tree.
+ * @throws ParseException When the template could not be parsed.
+ * @see RuntimeInstance#parse(Reader, String)
*/
public static SimpleNode parse( Reader reader, String templateName )
throws ParseException
@@ -247,9 +265,12 @@
/**
* Parse the input and return the root of the AST node structure.
*
- * @param InputStream inputstream retrieved by a resource loader
- * @param String name of the template being parsed
+ * @param reader Reader retrieved by a resource loader
+ * @param templateName name of the template being parsed
* @param dumpNamespace flag to dump the Velocimacro namespace for this template
+ * @return A root node representing the template as an AST tree.
+ * @throws ParseException When the template could not be parsed.
+ * @see RuntimeInstance#parse(Reader, String, boolean)
*/
public static SimpleNode parse( Reader reader, String templateName, boolean dumpNamespace )
throws ParseException
@@ -271,6 +292,7 @@
* @throws ParseErrorException if template cannot be parsed due
* to syntax (or other) error.
* @throws Exception if an error occurs in template initialization
+ * @see RuntimeInstance#getTemplate(String)
*/
public static Template getTemplate(String name)
throws ResourceNotFoundException, ParseErrorException, Exception
@@ -289,6 +311,9 @@
* @throws ParseErrorException if template cannot be parsed due
* to syntax (or other) error.
* @throws Exception if an error occurs in template initialization
+ * @throws ParseErrorException When the template could not be parsed.
+ * @throws Exception Any other error.
+ * @see RuntimeInstance#getTemplate(String, String)
*/
public static Template getTemplate(String name, String encoding)
throws ResourceNotFoundException, ParseErrorException, Exception
@@ -305,6 +330,9 @@
* @return parsed ContentResource object ready for use
* @throws ResourceNotFoundException if template not found
* from any available source.
+ * @throws ParseErrorException When the template could not be parsed.
+ * @throws Exception Any other error.
+ * @see RuntimeInstance#getContent(String)
*/
public static ContentResource getContent(String name)
throws ResourceNotFoundException, ParseErrorException, Exception
@@ -321,6 +349,9 @@
* @return parsed ContentResource object ready for use
* @throws ResourceNotFoundException if template not found
* from any available source.
+ * @throws ParseErrorException When the template could not be parsed.
+ * @throws Exception Any other error.
+ * @see RuntimeInstance#getContent(String, String)
*/
public static ContentResource getContent( String name, String encoding )
throws ResourceNotFoundException, ParseErrorException, Exception
@@ -337,6 +368,7 @@
*
* @param resourceName Name of template or content resource
* @return class name of loader than can provide it
+ * @see RuntimeInstance#getLoaderNameForResource(String)
*/
public static String getLoaderNameForResource( String resourceName )
{
@@ -346,6 +378,9 @@
/**
* Returns a convenient Log instance that wraps the current LogChute.
+ *
+ * @return A convenience Log instance that wraps the current LogChute.
+ * @see RuntimeInstance#getLog()
*/
public static Log getLog()
{
@@ -354,30 +389,38 @@
/**
* @deprecated Use getLog() and call warn() on it.
+ * @see Log#warn(Object)
+ * @param message The message to log.
*/
public static void warn(Object message)
{
getLog().warn(message);
}
-
- /**
+
+ /**
* @deprecated Use getLog() and call info() on it.
+ * @see Log#info(Object)
+ * @param message The message to log.
*/
public static void info(Object message)
{
getLog().info(message);
}
-
+
/**
* @deprecated Use getLog() and call error() on it.
+ * @see Log#error(Object)
+ * @param message The message to log.
*/
public static void error(Object message)
{
getLog().error(message);
}
-
+
/**
* @deprecated Use getLog() and call debug() on it.
+ * @see Log#debug(Object)
+ * @param message The message to log.
*/
public static void debug(Object message)
{
@@ -388,10 +431,11 @@
* String property accessor method with default to hide the
* configuration implementation.
*
- * @param String key property key
- * @param String defaultValue default value to return if key not
+ * @param key property key
+ * @param defaultValue default value to return if key not
* found in resource manager.
- * @return String value of key or default
+ * @return value of key or default
+ * @see RuntimeInstance#getString(String, String)
*/
public static String getString( String key, String defaultValue)
{
@@ -402,8 +446,10 @@
* Returns the appropriate VelocimacroProxy object if strVMname
* is a valid current Velocimacro.
*
- * @param String vmName Name of velocimacro requested
- * @return String VelocimacroProxy
+ * @param vmName Name of velocimacro requested
+ * @param templateName Name of the template that contains the velocimacro.
+ * @return The requested VelocimacroProxy.
+ * @see RuntimeInstance#getVelocimacro(String, String)
*/
public static Directive getVelocimacro( String vmName, String templateName )
{
@@ -411,15 +457,17 @@
}
/**
- * Adds a new Velocimacro. Usually called by Macro only while parsing.
- *
- * @param String name Name of velocimacro
- * @param String macro String form of macro body
- * @param String argArray Array of strings, containing the
- * #macro() arguments. the 0th is the name.
- * @return boolean True if added, false if rejected for some
- * reason (either parameters or permission settings)
- */
+ * Adds a new Velocimacro. Usually called by Macro only while parsing.
+ *
+ * @param name Name of velocimacro
+ * @param macro String form of macro body
+ * @param argArray Array of strings, containing the
+ * #macro() arguments. the 0th is the name.
+ * @param sourceTemplate Name of the template that contains the velocimacro.
+ * @return True if added, false if rejected for some
+ * reason (either parameters or permission settings)
+ * @see RuntimeInstance#addVelocimacro(String, String, String[], String)
+ */
public static boolean addVelocimacro( String name,
String macro,
String argArray[],
@@ -431,8 +479,10 @@
/**
* Checks to see if a VM exists
*
- * @param name Name of velocimacro
- * @return boolean True if VM by that name exists, false if not
+ * @param vmName Name of the Velocimacro.
+ * @param templateName Template on which to look for the Macro.
+ * @return True if VM by that name exists, false if not
+ * @see RuntimeInstance#isVelocimacro(String, String)
*/
public static boolean isVelocimacro( String vmName, String templateName )
{
@@ -440,8 +490,11 @@
}
/**
- * tells the vmFactory to dump the specified namespace. This is to support
- * clearing the VM list when in inline-VM-local-scope mode
+ * tells the vmFactory to dump the specified namespace. This is to support
+ * clearing the VM list when in inline-VM-local-scope mode
+ * @param namespace Namespace to dump.
+ * @return True if namespace was dumped successfully.
+ * @see RuntimeInstance#dumpVMNamespace(String)
*/
public static boolean dumpVMNamespace( String namespace )
{
@@ -464,6 +517,7 @@
* String property accessor method to hide the configuration implementation
* @param key property key
* @return value of key or null
+ * @see RuntimeInstance#getString(String)
*/
public static String getString(String key)
{
@@ -473,8 +527,9 @@
/**
* Int property accessor method to hide the configuration implementation.
*
- * @param String key property key
- * @return int value
+ * @param key Property key
+ * @return value
+ * @see RuntimeInstance#getInt(String)
*/
public static int getInt( String key )
{
@@ -485,8 +540,9 @@
* Int property accessor method to hide the configuration implementation.
*
* @param key property key
- * @param int default value
- * @return int value
+ * @param defaultValue The default value.
+ * @return value
+ * @see RuntimeInstance#getInt(String, int)
*/
public static int getInt( String key, int defaultValue )
{
@@ -495,10 +551,11 @@
/**
* Boolean property accessor method to hide the configuration implementation.
- *
- * @param String key property key
- * @param boolean default default value if property not found
- * @return boolean value of key or default value
+ *
+ * @param key property key
+ * @param def The default value if property not found.
+ * @return value of key or default value
+ * @see RuntimeInstance#getBoolean(String, boolean)
*/
public static boolean getBoolean( String key, boolean def )
{
@@ -510,6 +567,7 @@
*
* @return ExtendedProperties configuration object which houses
* the velocity runtime properties.
+ * @see RuntimeInstance#getConfiguration()
*/
public static ExtendedProperties getConfiguration()
{
@@ -520,6 +578,7 @@
* Return the Introspector for this RuntimeInstance
*
* @return Introspector object for this runtime instance
+ * @see RuntimeInstance#getIntrospector()
*/
public static Introspector getIntrospector()
{
@@ -527,15 +586,22 @@
}
/**
- * Returns the event handlers for the application.
- */
+ * Returns the event handlers for the application.
+ * @return The event handlers for the application.
+ * @see RuntimeInstance#getApplicationEventCartridge()
+ */
public EventCartridge getEventCartridge()
{
return ri.getApplicationEventCartridge();
}
/**
+ * Gets the application attribute for the given key
+ *
* @see org.apache.velocity.runtime.RuntimeServices#getApplicationAttribute(Object)
+ * @param key
+ * @return The application attribute for the given key.
+ * @see RuntimeInstance#getApplicationAttribute(Object)
*/
public static Object getApplicationAttribute(Object key)
{
@@ -543,7 +609,11 @@
}
/**
+ * Returns the Uberspect object for this Instance.
+ *
+ * @return The Uberspect object for this Instance.
* @see org.apache.velocity.runtime.RuntimeServices#getUberspect()
+ * @see RuntimeInstance#getUberspect()
*/
public static Uberspect getUberspect()
{
@@ -552,6 +622,7 @@
/**
* @deprecated Use getRuntimeServices() instead.
+ * @return The RuntimeInstance used by this Singleton.
*/
public static RuntimeInstance getRuntimeInstance()
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/VelocimacroFactory.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/VelocimacroFactory.java?view=diff&rev=447102&r1=447101&r2=447102
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/VelocimacroFactory.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/VelocimacroFactory.java Sun Sep 17 10:40:57 2006
@@ -94,8 +94,9 @@
private Map libModMap;
/**
- * CTOR : requires a runtime services from now
- * on
+ * C'tor for the VelociMacro factory.
+ *
+ * @param rs Reference to a runtime services object.
*/
public VelocimacroFactory( RuntimeServices rs )
{
@@ -316,7 +317,13 @@
}
/**
- * adds a macro to the factory.
+ * adds a macro to the factory.
+ *
+ * @param name Name of the Macro to add.
+ * @param macroBody String representation of the macro.
+ * @param argArray Macro arguments. First element is the macro name.
+ * @param sourceTemplate Source template from which the macro gets registered.
+ * @return True if Macro was registered successfully.
*/
public boolean addVelocimacro( String name, String macroBody,
String argArray[], String sourceTemplate )
@@ -475,6 +482,9 @@
/**
* Tells the world if a given directive string is a Velocimacro
+ * @param vm Name of the Macro.
+ * @param sourceTemplate Source template from which the macro should be loaded.
+ * @return True if the given name is a macro.
*/
public boolean isVelocimacro( String vm , String sourceTemplate )
{
@@ -494,6 +504,9 @@
* actual factory : creates a Directive that will
* behave correctly wrt getting the framework to
* dig out the correct # of args
+ * @param vmName Name of the Macro.
+ * @param sourceTemplate Source template from which the macro should be loaded.
+ * @return A directive representing the Macro.
*/
public Directive getVelocimacro( String vmName, String sourceTemplate )
{
@@ -595,6 +608,8 @@
/**
* tells the vmManager to dump the specified namespace
+ * @param namespace Namespace to dump.
+ * @return True if namespace has been dumped successfully.
*/
public boolean dumpVMNamespace( String namespace )
{
@@ -667,7 +682,10 @@
*/
private static class Twonk
{
+ /** Template kept in this container. */
public Template template;
+
+ /** modification time of the template. */
public long modificationTime;
}
}
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/VelocimacroManager.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/VelocimacroManager.java?view=diff&rev=447102&r1=447101&r2=447102
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/VelocimacroManager.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/VelocimacroManager.java Sun Sep 17 10:40:57 2006
@@ -75,6 +75,10 @@
/**
* Adds a VM definition to the cache.
+ * @param vmName Name of the new VelociMacro.
+ * @param macroBody String representation of the macro body.
+ * @param argArray Array of macro parameters, first parameter is the macro name.
+ * @param namespace The namespace/template from which this macro has been loaded.
* @return Whether everything went okay.
*/
public boolean addVM(final String vmName, final String macroBody, final String argArray[],
@@ -150,6 +154,9 @@
/**
* gets a new living VelocimacroProxy object by the
* name / source template duple
+ * @param vmName Name of the VelocityMacro to look up.
+ * @param namespace Namespace in which to look up the macro.
+ * @return A proxy representing the Macro.
*/
public VelocimacroProxy get(final String vmName, final String namespace)
{
@@ -191,7 +198,7 @@
/**
* Removes the VMs and the namespace from the manager.
* Used when a template is reloaded to avoid
- * accumulating drek
+ * losing memory.
*
* @param namespace namespace to dump
* @return boolean representing success
@@ -222,17 +229,28 @@
* public switch to let external user of manager to control namespace
* usage indep of properties. That way, for example, at startup the
* library files are loaded into global namespace
+ *
+ * @param namespaceOn True if namespaces should be used.
*/
- public void setNamespaceUsage(final boolean namespaceUsage)
+ public void setNamespaceUsage(final boolean namespaceOn)
{
- this.namespacesOn = namespaceUsage;
+ this.namespacesOn = namespaceOn;
}
+ /**
+ * Should macros registered from Libraries be marked special?
+ * @param registerFromLib True if macros from Libs should be marked.
+ */
public void setRegisterFromLib(final boolean registerFromLib)
{
this.registerFromLib = registerFromLib;
}
+ /**
+ * Should macros from the same template be inlined?
+ *
+ * @param inlineLocalMode True if macros should be inlined on the same template.
+ */
public void setTemplateLocalInlineVM(final boolean inlineLocalMode)
{
this.inlineLocalMode = inlineLocalMode;
@@ -330,6 +348,12 @@
return false;
}
+ /**
+ * Return the library name for a given macro.
+ * @param vmName Name of the Macro to look up.
+ * @param namespace Namespace to look the macro up.
+ * @return The name of the library which registered this macro in a namespace.
+ */
public String getLibraryName(final String vmName, final String namespace)
{
if (usingNamespaces(namespace))
@@ -391,21 +415,37 @@
this.sourceTemplate = sourceTemplate;
}
+ /**
+ * Has the macro been registered from a library.
+ * @param fromLibrary True if the macro was registered from a Library.
+ */
public void setFromLibrary(final boolean fromLibrary)
{
this.fromLibrary = fromLibrary;
}
+ /**
+ * Returns true if the macro was registered from a library.
+ * @return True if the macro was registered from a library.
+ */
public boolean getFromLibrary()
{
return fromLibrary;
}
+ /**
+ * Returns the node tree for this macro.
+ * @return The node tree for this macro.
+ */
public SimpleNode getNodeTree()
{
return nodeTree;
}
+ /**
+ * Returns the source template name for this macro.
+ * @return The source template name for this macro.
+ */
public String getSourceTemplate()
{
return sourceTemplate;
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org