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 20:02:29 UTC
svn commit: r447105 - in
/jakarta/velocity/engine/trunk/src/java/org/apache/velocity: runtime/ util/
util/introspection/
Author: henning
Date: Sun Sep 17 11:02:28 2006
New Revision: 447105
URL: http://svn.apache.org/viewvc?view=rev&rev=447105
Log:
More Javadoc fixes.
Modified:
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeServices.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/ClassUtils.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/EnumerationIterator.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/ExceptionUtils.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/SimplePool.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/StringUtils.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/TemplateNumber.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/ClassMap.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Info.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/IntrospectionCacheData.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Introspector.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/IntrospectorBase.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/MethodMap.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Uberspect.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/UberspectImpl.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/UberspectLoggable.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelMethod.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelPropertyGet.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelPropertySet.java
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeServices.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeServices.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeServices.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeServices.java Sun Sep 17 11:02:28 2006
@@ -46,7 +46,7 @@
public interface RuntimeServices extends RuntimeLogger
{
- /*
+ /**
* This is the primary initialization method in the Velocity
* Runtime. The systems that are setup/initialized here are
* as follows:
@@ -59,6 +59,7 @@
* <li>Static Content Include System</li>
* <li>Velocimacro System</li>
* </ul>
+ * @throws Exception
*/
public void init() throws Exception;
@@ -66,8 +67,8 @@
* 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
*/
public void setProperty(String key, Object value);
@@ -79,7 +80,7 @@
* parent application's configuration. This is
* the case with Turbine.
*
- * @param ExtendedProperties configuration
+ * @param configuration
*/
public void setConfiguration( ExtendedProperties configuration);
@@ -99,8 +100,8 @@
*
* ["file", "classpath"]
*
- * @param String key
- * @param String value
+ * @param key
+ * @param value
*/
public void addProperty(String key, Object value);
@@ -108,7 +109,7 @@
* Clear the values pertaining to a particular
* property.
*
- * @param String key of property to clear
+ * @param key of property to clear
*/
public void clearProperty(String key);
@@ -118,6 +119,7 @@
* will return an Object, as that is what properties can be.
*
* @param key property to return
+ * @return The value.
*/
public Object getProperty( String key );
@@ -125,7 +127,8 @@
* Initialize the Velocity Runtime with a Properties
* object.
*
- * @param Properties
+ * @param p
+ * @throws Exception
*/
public void init(Properties p) throws Exception;
@@ -133,7 +136,8 @@
* Initialize the Velocity Runtime with the name of
* ExtendedProperties object.
*
- * @param Properties
+ * @param configurationFile
+ * @throws Exception
*/
public void init(String configurationFile) throws Exception;
@@ -149,8 +153,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 inputstream retrieved by a resource loader
+ * @param templateName name of the template being parsed
+ * @return The AST representing the template.
+ * @throws ParseException
*/
public SimpleNode parse( Reader reader, String templateName )
throws ParseException;
@@ -158,9 +164,11 @@
/**
* 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 inputstream 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 The AST representing the template.
+ * @throws ParseException
*/
public SimpleNode parse( Reader reader, String templateName, boolean dumpNamespace )
throws ParseException;
@@ -206,6 +214,8 @@
* @return parsed ContentResource object ready for use
* @throws ResourceNotFoundException if template not found
* from any available source.
+ * @throws ParseErrorException
+ * @throws Exception
*/
public ContentResource getContent(String name)
throws ResourceNotFoundException, ParseErrorException, Exception;
@@ -219,6 +229,8 @@
* @return parsed ContentResource object ready for use
* @throws ResourceNotFoundException if template not found
* from any available source.
+ * @throws ParseErrorException
+ * @throws Exception
*/
public ContentResource getContent( String name, String encoding )
throws ResourceNotFoundException, ParseErrorException, Exception;
@@ -238,8 +250,8 @@
* 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
*/
@@ -249,18 +261,20 @@
* 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 namespace.
+ * @return VelocimacroProxy
*/
public Directive getVelocimacro( String vmName, String templateName );
/**
* 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
+ * @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
* @return boolean True if added, false if rejected for some
* reason (either parameters or permission settings)
*/
@@ -272,7 +286,8 @@
/**
* Checks to see if a VM exists
*
- * @param name Name of velocimacro
+ * @param vmName Name of velocimacro
+ * @param templateName
* @return boolean True if VM by that name exists, false if not
*/
public boolean isVelocimacro( String vmName, String templateName );
@@ -280,6 +295,8 @@
/**
* 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
+ * @return True if the Namespace was dumped.
*/
public boolean dumpVMNamespace( String namespace );
@@ -293,7 +310,7 @@
/**
* Int property accessor method to hide the configuration implementation.
*
- * @param String key property key
+ * @param key property key
* @return int value
*/
public int getInt( String key );
@@ -302,7 +319,7 @@
* Int property accessor method to hide the configuration implementation.
*
* @param key property key
- * @param int default value
+ * @param defaultValue default value
* @return int value
*/
public int getInt( String key, int defaultValue );
@@ -310,8 +327,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 boolean getBoolean( String key, boolean def );
@@ -328,6 +345,7 @@
* Return the specified application attribute.
*
* @param key The name of the attribute to retrieve.
+ * @return The value of the attribute.
*/
public Object getApplicationAttribute( Object key );
@@ -343,34 +361,40 @@
/**
* Returns the configured class introspection/reflection
* implemenation.
+ * @return The current Uberspect object.
*/
public Uberspect getUberspect();
/**
* Returns a convenient Log instance that wraps the current LogChute.
+ * @return A log object.
*/
public Log getLog();
/**
* Returns the event handlers for the application.
+ * @return The event handlers for the application.
*/
public EventCartridge getApplicationEventCartridge();
/**
* Returns the configured method introspection/reflection
- * implemenation.
+ * implementation.
+ * @return The configured method introspection/reflection
+ * implementation.
*/
public Introspector getIntrospector();
/**
* Returns true if the RuntimeInstance has been successfully initialized.
- * @return
+ * @return True if the RuntimeInstance has been successfully initialized.
*/
public boolean isInitialized();
/**
* Create a new parser instance.
+ * @return A new parser instance.
*/
public Parser createNewParser();
}
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/ClassUtils.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/ClassUtils.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/ClassUtils.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/ClassUtils.java Sun Sep 17 11:02:28 2006
@@ -44,6 +44,7 @@
*
* @param clazz the name of the class to instantiate
* @return the requested Class object
+ * @throws ClassNotFoundException
*/
public static Class getClass(String clazz) throws ClassNotFoundException
{
@@ -78,8 +79,11 @@
* calls the System class loader) when the class might be in a different
* classloader (e.g. in a webapp).
*
- * @param classname the name of the class to instantiate
+ * @param clazz the name of the class to instantiate
* @return an instance of the specified class
+ * @throws ClassNotFoundException
+ * @throws IllegalAccessException
+ * @throws InstantiationException
*/
public static Object getNewInstance(String clazz)
throws ClassNotFoundException,IllegalAccessException,InstantiationException
@@ -95,7 +99,7 @@
* @param claz Class to use when getting the System classloader (used if no Thread
* Context classloader available or fails to get resource).
* @param name name of the resource
- * @return
+ * @return InputStream for the resource.
*/
public static InputStream getResourceAsStream(Class claz, String name)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/EnumerationIterator.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/EnumerationIterator.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/EnumerationIterator.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/EnumerationIterator.java Sun Sep 17 11:02:28 2006
@@ -36,7 +36,7 @@
* Creates a new iteratorwrapper instance for the specified
* Enumeration.
*
- * @param enum The Enumeration to wrap.
+ * @param enumeration The Enumeration to wrap.
*/
public EnumerationIterator(Enumeration enumeration)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/ExceptionUtils.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/ExceptionUtils.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/ExceptionUtils.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/ExceptionUtils.java Sun Sep 17 11:02:28 2006
@@ -31,6 +31,9 @@
/**
* Create a new RuntimeException, setting the cause if possible.
+ * @param message
+ * @param cause
+ * @return A runtime exception object.
*/
public static RuntimeException createRuntimeException(
String message, Throwable cause)
@@ -41,6 +44,10 @@
/**
* Create a new Exception, setting the cause if possible.
+ * @param clazz
+ * @param message
+ * @param cause
+ * @return A Throwable.
*/
public static Throwable createWithCause(Class clazz,
String message, Throwable cause)
@@ -89,6 +96,8 @@
/**
* Set the cause of the Exception. Will detect if this is not allowed.
+ * @param onObject
+ * @param cause
*/
public static void setCause(Throwable onObject, Throwable cause)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/SimplePool.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/SimplePool.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/SimplePool.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/SimplePool.java Sun Sep 17 11:02:28 2006
@@ -46,6 +46,9 @@
*/
private int current=-1;
+ /**
+ * @param max
+ */
public SimplePool(int max)
{
this.max = max;
@@ -54,6 +57,7 @@
/**
* Add the object to the pool, silent nothing if the pool is full
+ * @param o
*/
public void put(Object o)
{
@@ -83,6 +87,7 @@
/**
* Get an object from the pool, null if the pool is empty.
+ * @return The object from the pool.
*/
public Object get()
{
@@ -109,7 +114,9 @@
return null;
}
- /** Return the size of the pool
+ /**
+ * Return the size of the pool
+ * @return The pool size.
*/
public int getMax()
{
@@ -119,7 +126,7 @@
/**
* for testing purposes, so we can examine the pool
*
- * @return
+ * @return Array of Objects in the pool.
*/
Object[] getPool()
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/StringUtils.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/StringUtils.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/StringUtils.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/StringUtils.java Sun Sep 17 11:02:28 2006
@@ -66,7 +66,7 @@
/**
* Return a package name as a relative path name
*
- * @param String package name to convert to a directory.
+ * @param pckge package name to convert to a directory.
* @return String directory path.
*/
static public String getPackageAsPath(String pckge)
@@ -227,7 +227,7 @@
* and the platform EOL will be the same.
* A 2 character EOL will count as 1 character.
*
- * @param string String to chop.
+ * @param s String to chop.
* @param i Number of characters to chop.
* @return String with processed answer.
*/
@@ -240,7 +240,7 @@
* Chop i characters off the end of a string.
* A 2 character EOL will count as 1 character.
*
- * @param string String to chop.
+ * @param s String to chop.
* @param i Number of characters to chop.
* @param eol A String representing the EOL (end of line).
* @return String with processed answer.
@@ -277,6 +277,11 @@
return s.substring( 0, length);
}
+ /**
+ * @param argStr
+ * @param vars
+ * @return Substituted String.
+ */
public static StringBuffer stringSubstitution( String argStr,
Hashtable vars )
{
@@ -289,8 +294,8 @@
* string with the value of provided by the key "variable"
* in the provided hashtable.
*
- * @param String target string
- * @param Hashtable name/value pairs used for substitution
+ * @param argStr target string
+ * @param vars name/value pairs used for substitution
* @return String target string with replacements.
*/
public static StringBuffer stringSubstitution(String argStr,
@@ -341,7 +346,7 @@
* Read the contents of a file and place them in
* a string object.
*
- * @param String path to file.
+ * @param file path to file.
* @return String contents of the file.
*/
public static String fileContentsToString(String file)
@@ -386,7 +391,7 @@
/**
* Remove/collapse multiple newline characters.
*
- * @param String string to collapse newlines in.
+ * @param argStr string to collapse newlines in.
* @return String
*/
public static String collapseNewlines(String argStr)
@@ -410,7 +415,7 @@
/**
* Remove/collapse multiple spaces.
*
- * @param String string to remove multiple spaces from.
+ * @param argStr string to remove multiple spaces from.
* @return String
*/
public static String collapseSpaces(String argStr)
@@ -435,9 +440,9 @@
* Replaces all instances of oldString with newString in line.
* Taken from the Jive forum package.
*
- * @param String original string.
- * @param String string in line to replace.
- * @param String replace oldString with this.
+ * @param line original string.
+ * @param oldString string in line to replace.
+ * @param newString replace oldString with this.
* @return String string with replacements.
*/
public static final String sub(String line, String oldString,
@@ -563,9 +568,10 @@
* If state is true then return the trueString, else
* return the falseString.
*
- * @param boolean
- * @param String trueString
- * @param String falseString
+ * @param state
+ * @param trueString
+ * @param falseString
+ * @return Selected result.
*/
public String select(boolean state, String trueString, String falseString)
{
@@ -603,7 +609,7 @@
/**
* Trim all strings in a List. Changes the strings in the existing list.
* @param list
- * @return
+ * @return List of trimmed strings.
*/
public static List trimStrings(List list)
{
@@ -619,7 +625,7 @@
/**
* Trim the string, but pass a null through.
* @param s
- * @return
+ * @return List of trimmed Strings.
*/
public static String nullTrim(String s)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/TemplateNumber.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/TemplateNumber.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/TemplateNumber.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/TemplateNumber.java Sun Sep 17 11:02:28 2006
@@ -28,6 +28,7 @@
/**
* Returns a Number that can be used in a template.
+ * @return A Number that can be used in a template.
*/
public Number getAsNumber();
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/ClassMap.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/ClassMap.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/ClassMap.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/ClassMap.java Sun Sep 17 11:02:28 2006
@@ -23,7 +23,7 @@
/**
* A cache of introspection information for a specific class instance.
- * Keys {@link java.lang.Method} objects by a concatenation of the
+ * Keys {@link java.lang.reflect.Method} objects by a concatenation of the
* method name and the names of classes that make up the parameters.
*
* @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
@@ -55,6 +55,7 @@
/**
* Standard constructor
+ * @param clazz
*/
public ClassMap( Class clazz)
{
@@ -85,6 +86,10 @@
*
* If nothing is found, then we must actually go
* and introspect the method from the MethodMap.
+ * @param name
+ * @param params
+ * @return Method object.
+ * @throws MethodMap.AmbiguousException
*/
public Method findMethod(String name, Object[] params)
throws MethodMap.AmbiguousException
@@ -425,7 +430,7 @@
* Looks up the method with specified name and signature in the first public
* superclass or implemented interface of the class.
*
- * @param class the class whose method is sought
+ * @param clazz the class whose method is sought
* @param name the name of the method
* @param paramTypes the classes of method parameters
*/
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Info.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Info.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Info.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Info.java Sun Sep 17 11:02:28 2006
@@ -47,16 +47,25 @@
{
}
+ /**
+ * @return The template name.
+ */
public String getTemplateName()
{
return templateName;
}
+ /**
+ * @return The line number.
+ */
public int getLine()
{
return line;
}
+ /**
+ * @return The column number.
+ */
public int getColumn()
{
return column;
@@ -65,6 +74,8 @@
/**
* Formats a textual representation of this object as <code>SOURCE
* [line X, column Y]</code>.
+ *
+ * @return String representing this object.
*/
public String toString()
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/IntrospectionCacheData.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/IntrospectionCacheData.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/IntrospectionCacheData.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/IntrospectionCacheData.java Sun Sep 17 11:02:28 2006
@@ -32,7 +32,7 @@
*/
public Object thingy;
- /*
+ /**
* Class of context data object associated with the introspection
* information
*/
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Introspector.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Introspector.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Introspector.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Introspector.java Sun Sep 17 11:02:28 2006
@@ -64,12 +64,16 @@
*/
private Log log = null;
+ /**
+ * @param log
+ */
public Introspector(Log log)
{
this.log = log;
}
/**
+ * @param logger
* @deprecated RuntimeLogger is deprecated. Use Introspector(Log log).
*/
public Introspector(RuntimeLogger logger)
@@ -87,6 +91,7 @@
* the parameters
*
* @return The desired Method object.
+ * @throws Exception
*/
public Method getMethod(Class c, String name, Object[] params)
throws Exception
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/IntrospectorBase.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/IntrospectorBase.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/IntrospectorBase.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/IntrospectorBase.java Sun Sep 17 11:02:28 2006
@@ -75,6 +75,7 @@
* the parameters
*
* @return The desired Method object.
+ * @throws Exception
*/
public Method getMethod(Class c, String name, Object[] params)
throws Exception
@@ -120,6 +121,8 @@
* Creates a class map for specific class and registers it in the
* cache. Also adds the qualified name to the name->class map
* for later Classloader change detection.
+ * @param c
+ * @return A ClassMap object.
*/
protected ClassMap createClassMap(Class c)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/MethodMap.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/MethodMap.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/MethodMap.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/MethodMap.java Sun Sep 17 11:02:28 2006
@@ -48,6 +48,7 @@
* Add a method to a list of methods by name.
* For a particular class we are keeping track
* of all the methods with the same name.
+ * @param method
*/
public void add(Method method)
{
@@ -69,7 +70,7 @@
/**
* Return a list of methods with the same name.
*
- * @param String key
+ * @param key
* @return List list of methods
*/
public List get(String key)
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Uberspect.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Uberspect.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Uberspect.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/Uberspect.java Sun Sep 17 11:02:28 2006
@@ -29,26 +29,48 @@
{
/**
* Initializer - will be called before use
+ * @throws Exception
*/
public void init() throws Exception;
/**
* To support iteratives - #foreach()
+ * @param obj
+ * @param info
+ * @return An Iterator.
+ * @throws Exception
*/
public Iterator getIterator(Object obj, Info info) throws Exception;
/**
* Returns a general method, corresponding to $foo.bar( $woogie )
+ * @param obj
+ * @param method
+ * @param args
+ * @param info
+ * @return A Velocity Method.
+ * @throws Exception
*/
public VelMethod getMethod(Object obj, String method, Object[] args, Info info) throws Exception;
/**
* Property getter - returns VelPropertyGet appropos for #set($foo = $bar.woogie)
+ * @param obj
+ * @param identifier
+ * @param info
+ * @return A Velocity Getter.
+ * @throws Exception
*/
public VelPropertyGet getPropertyGet(Object obj, String identifier, Info info) throws Exception;
/**
* Property setter - returns VelPropertySet appropos for #set($foo.bar = "geir")
+ * @param obj
+ * @param identifier
+ * @param arg
+ * @param info
+ * @return A Velocity Setter.
+ * @throws Exception
*/
public VelPropertySet getPropertySet(Object obj, String identifier, Object arg, Info info) throws Exception;
}
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/UberspectImpl.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/UberspectImpl.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/UberspectImpl.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/UberspectImpl.java Sun Sep 17 11:02:28 2006
@@ -77,6 +77,7 @@
}
/**
+ * @param runtimeLogger
* @deprecated Use setLog(Log log) instead.
*/
public void setRuntimeLogger(RuntimeLogger runtimeLogger)
@@ -92,6 +93,8 @@
*
* @param obj The iterative object.
* @param i Info about the object's location.
+ * @return An {@link Iterator} object.
+ * @throws Exception
*/
public Iterator getIterator(Object obj, Info i)
throws Exception
@@ -139,6 +142,12 @@
/**
* Method
+ * @param obj
+ * @param methodName
+ * @param args
+ * @param i
+ * @return A Velocity Method.
+ * @throws Exception
*/
public VelMethod getMethod(Object obj, String methodName, Object[] args, Info i)
throws Exception
@@ -155,6 +164,11 @@
/**
* Property getter
+ * @param obj
+ * @param identifier
+ * @param i
+ * @return A Velocity Getter Method.
+ * @throws Exception
*/
public VelPropertyGet getPropertyGet(Object obj, String identifier, Info i)
throws Exception
@@ -196,6 +210,12 @@
/**
* Property setter
+ * @param obj
+ * @param identifier
+ * @param arg
+ * @param i
+ * @return A Velocity Setter method.
+ * @throws Exception
*/
public VelPropertySet getPropertySet(Object obj, String identifier,
Object arg, Info i)
@@ -233,6 +253,9 @@
{
final Method method;
+ /**
+ * @param m
+ */
public VelMethodImpl(Method m)
{
method = m;
@@ -243,32 +266,51 @@
method = null;
}
+ /**
+ * @see VelMethod#invoke(java.lang.Object, java.lang.Object[])
+ */
public Object invoke(Object o, Object[] params)
throws Exception
{
return method.invoke(o, params);
}
+ /**
+ * @see org.apache.velocity.util.introspection.VelMethod#isCacheable()
+ */
public boolean isCacheable()
{
return true;
}
+ /**
+ * @see org.apache.velocity.util.introspection.VelMethod#getMethodName()
+ */
public String getMethodName()
{
return method.getName();
}
+ /**
+ * @see org.apache.velocity.util.introspection.VelMethod#getReturnType()
+ */
public Class getReturnType()
{
return method.getReturnType();
}
}
+ /**
+ *
+ *
+ */
public static class VelGetterImpl implements VelPropertyGet
{
final AbstractExecutor getExecutor;
+ /**
+ * @param exec
+ */
public VelGetterImpl(AbstractExecutor exec)
{
getExecutor = exec;
@@ -279,27 +321,42 @@
getExecutor = null;
}
+ /**
+ * @see org.apache.velocity.util.introspection.VelPropertyGet#invoke(java.lang.Object)
+ */
public Object invoke(Object o)
throws Exception
{
return getExecutor.execute(o);
}
+ /**
+ * @see org.apache.velocity.util.introspection.VelPropertyGet#isCacheable()
+ */
public boolean isCacheable()
{
return true;
}
+ /**
+ * @see org.apache.velocity.util.introspection.VelPropertyGet#getMethodName()
+ */
public String getMethodName()
{
return getExecutor.isAlive() ? getExecutor.getMethod().getName() : null;
}
}
+ /**
+ *
+ */
public static class VelSetterImpl implements VelPropertySet
{
private final SetExecutor setExecutor;
+ /**
+ * @param setExecutor
+ */
public VelSetterImpl(final SetExecutor setExecutor)
{
this.setExecutor = setExecutor;
@@ -315,6 +372,8 @@
*
* @param o is the Object to invoke it on.
* @param value in the Value to set.
+ * @return The resulting Object.
+ * @throws Exception
*/
public Object invoke(final Object o, final Object value)
throws Exception
@@ -322,11 +381,17 @@
return setExecutor.execute(o, value);
}
+ /**
+ * @see org.apache.velocity.util.introspection.VelPropertySet#isCacheable()
+ */
public boolean isCacheable()
{
return true;
}
+ /**
+ * @see org.apache.velocity.util.introspection.VelPropertySet#getMethodName()
+ */
public String getMethodName()
{
return setExecutor.isAlive() ? setExecutor.getMethod().getName() : null;
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/UberspectLoggable.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/UberspectLoggable.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/UberspectLoggable.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/UberspectLoggable.java Sun Sep 17 11:02:28 2006
@@ -36,10 +36,12 @@
/**
* Sets the logger. This will be called before any calls to the
* uberspector
+ * @param log
*/
public void setLog(Log log);
/**
+ * @param logger
* @deprecated Use setLog(Log log) instead.
*/
public void setRuntimeLogger(RuntimeLogger logger);
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelMethod.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelMethod.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelMethod.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelMethod.java Sun Sep 17 11:02:28 2006
@@ -30,6 +30,10 @@
/**
* invocation method - called when the method invocationshould be
* preformed and a value returned
+ * @param o
+ * @param params
+ * @return The resulting object.
+ * @throws Exception
*/
public Object invoke(Object o, Object[] params)
throws Exception;
@@ -44,11 +48,13 @@
/**
* returns the method name used
+ * @return The method name used
*/
public String getMethodName();
/**
* returns the return type of the method invoked
+ * @return The return type of the method invoked
*/
public Class getReturnType();
}
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelPropertyGet.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelPropertyGet.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelPropertyGet.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelPropertyGet.java Sun Sep 17 11:02:28 2006
@@ -30,6 +30,9 @@
/**
* invocation method - called when the 'get action' should be
* preformed and a value returned
+ * @param o
+ * @return The resulting Object.
+ * @throws Exception
*/
public Object invoke(Object o) throws Exception;
@@ -43,6 +46,7 @@
/**
* returns the method name used to return this 'property'
+ * @return The method name used to return this 'property'
*/
public String getMethodName();
}
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelPropertySet.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelPropertySet.java?view=diff&rev=447105&r1=447104&r2=447105
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelPropertySet.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/util/introspection/VelPropertySet.java Sun Sep 17 11:02:28 2006
@@ -33,6 +33,7 @@
* @param o Object on which the method will be called with the arg
* @param arg value to be set
* @return the value returned from the set operation (impl specific)
+ * @throws Exception
*/
public Object invoke(Object o, Object arg) throws Exception;
@@ -46,6 +47,7 @@
/**
* returns the method name used to set this 'property'
+ * @return The method name used to set this 'property'
*/
public String getMethodName();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org