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 22:07:32 UTC
svn commit: r447133 [1/2] - in
/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime: log/
parser/ parser/node/ resource/ resource/loader/ visitor/
Author: henning
Date: Sun Sep 17 13:07:29 2006
New Revision: 447133
URL: http://svn.apache.org/viewvc?view=rev&rev=447133
Log:
More Javadoc fixes.
Modified:
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/AvalonLogChute.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/AvalonLogSystem.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/HoldingLogChute.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/JdkLogChute.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log4JLogChute.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log4JLogSystem.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogChute.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogChuteSystem.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogManager.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogSystem.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/NullLogChute.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/NullLogSystem.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/PrimordialLogSystem.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/RuntimeLoggerLog.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/SimpleLog4JLogSystem.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/StandardOutLogChute.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/VelocityFormatter.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/ParserVisitor.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/TemplateParseException.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/VelocityCharStream.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAddNode.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAndNode.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAssignment.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTBlock.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTComment.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTDirective.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTDivNode.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTElseIfStatement.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/AbstractExecutor.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/BooleanPropertyExecutor.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/GetExecutor.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/MathUtils.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/Node.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/NodeUtils.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/PropertyExecutor.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/PutExecutor.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SetExecutor.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SetPropertyExecutor.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SimpleNode.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ContentResource.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/Resource.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceCache.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceCacheImpl.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceFactory.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceManager.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceManagerImpl.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ClasspathResourceLoader.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/FileResourceLoader.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/JarHolder.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/JarResourceLoader.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ResourceLoader.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ResourceLoaderFactory.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/URLResourceLoader.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/BaseVisitor.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/NodeViewMode.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/VMReferenceMungeVisitor.java
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/AvalonLogChute.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/AvalonLogChute.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/AvalonLogChute.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/AvalonLogChute.java Sun Sep 17 13:07:29 2006
@@ -39,6 +39,9 @@
private Logger logger = null;
private RuntimeServices rsvc = null;
+ /**
+ * @see org.apache.velocity.runtime.log.LogChute#init(org.apache.velocity.runtime.RuntimeServices)
+ */
public void init(RuntimeServices rs) throws Exception
{
this.rsvc = rs;
@@ -86,6 +89,8 @@
}
/**
+ * @param file
+ * @throws Exception
* @deprecated This method should not be used. It is here only to provide
* backwards compatibility for the deprecated AvalonLogSystem
* class, in case anyone used it and this method directly.
@@ -138,6 +143,7 @@
*
* @param level severity level
* @param message complete error message
+ * @param t
*/
public void log(int level, String message, Throwable t)
{
@@ -166,6 +172,8 @@
/**
* Checks to see whether the specified level is enabled.
+ * @param level
+ * @return True if the specified level is enabled.
*/
public boolean isLevelEnabled(int level)
{
@@ -188,6 +196,7 @@
/**
* Also do a shutdown if the object is destroy()'d.
+ * @throws Throwable
*/
protected void finalize() throws Throwable
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/AvalonLogSystem.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/AvalonLogSystem.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/AvalonLogSystem.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/AvalonLogSystem.java Sun Sep 17 13:07:29 2006
@@ -26,7 +26,9 @@
public class AvalonLogSystem extends AvalonLogChute implements LogSystem
{
/**
- * @deprecated Use log(level, message).
+ * @param level
+ * @param message
+ * @deprecated Use log(level, message).
*/
public void logVelocityMessage(int level, String message)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/HoldingLogChute.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/HoldingLogChute.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/HoldingLogChute.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/HoldingLogChute.java Sun Sep 17 13:07:29 2006
@@ -34,6 +34,9 @@
{
private Vector pendingMessages = new Vector();
+ /**
+ * @see org.apache.velocity.runtime.log.LogChute#init(org.apache.velocity.runtime.RuntimeServices)
+ */
public void init(RuntimeServices rs) throws Exception
{
}
@@ -77,7 +80,7 @@
}
/**
- * This will always return true.
+ * @see org.apache.velocity.runtime.log.LogChute#isLevelEnabled(int)
*/
public boolean isLevelEnabled(int level)
{
@@ -86,6 +89,7 @@
/**
* Dumps the log messages this chute is holding into a new chute
+ * @param newChute
*/
public void transferTo(LogChute newChute)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/JdkLogChute.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/JdkLogChute.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/JdkLogChute.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/JdkLogChute.java Sun Sep 17 13:07:29 2006
@@ -37,8 +37,14 @@
/** Default name for the JDK logger instance */
public static final String DEFAULT_LOG_NAME = "org.apache.velocity";
+ /**
+ *
+ */
protected Logger logger = null;
+ /**
+ * @see org.apache.velocity.runtime.log.LogChute#init(org.apache.velocity.runtime.RuntimeServices)
+ */
public void init(RuntimeServices rs)
{
String name = (String)rs.getProperty(RUNTIME_LOG_JDK_LOGGER);
@@ -53,6 +59,8 @@
/**
* Returns the java.util.logging.Level that matches
* to the specified LogChute level.
+ * @param level
+ * @return The current log level of the JDK Logger.
*/
protected Level getJdkLevel(int level)
{
@@ -86,6 +94,9 @@
/**
* Send a log message from Velocity along with an exception or error
+ * @param level
+ * @param message
+ * @param t
*/
public void log(int level, String message, Throwable t)
{
@@ -101,7 +112,7 @@
}
/**
- * Checks whether the logger is enabled for the specified level
+ * @see org.apache.velocity.runtime.log.LogChute#isLevelEnabled(int)
*/
public boolean isLevelEnabled(int level)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log.java Sun Sep 17 13:07:29 2006
@@ -40,6 +40,7 @@
/**
* Creates a new Log that wraps the specified LogChute.
+ * @param chute
*/
public Log(LogChute chute)
{
@@ -52,6 +53,7 @@
/**
* Updates the LogChute wrapped by this Log instance.
+ * @param newLogChute
*/
protected void setLogChute(LogChute newLogChute)
{
@@ -60,6 +62,7 @@
/**
* Returns the LogChute wrapped by this Log instance.
+ * @return The LogChute wrapped by this Log instance.
*/
protected LogChute getLogChute()
{
@@ -78,6 +81,7 @@
/**
* Returns true if trace level messages will be printed by the LogChute.
+ * @return If trace level messages will be printed by the LogChute.
*/
public boolean isTraceEnabled()
{
@@ -86,6 +90,7 @@
/**
* Log a trace message.
+ * @param message
*/
public void trace(Object message)
{
@@ -94,6 +99,8 @@
/**
* Log a trace message and accompanying Throwable.
+ * @param message
+ * @param t
*/
public void trace(Object message, Throwable t)
{
@@ -102,6 +109,7 @@
/**
* Returns true if debug level messages will be printed by the LogChute.
+ * @return True if debug level messages will be printed by the LogChute.
*/
public boolean isDebugEnabled()
{
@@ -110,6 +118,7 @@
/**
* Log a debug message.
+ * @param message
*/
public void debug(Object message)
{
@@ -118,6 +127,8 @@
/**
* Log a debug message and accompanying Throwable.
+ * @param message
+ * @param t
*/
public void debug(Object message, Throwable t)
{
@@ -126,6 +137,7 @@
/**
* Returns true if info level messages will be printed by the LogChute.
+ * @return True if info level messages will be printed by the LogChute.
*/
public boolean isInfoEnabled()
{
@@ -134,6 +146,7 @@
/**
* Log an info message.
+ * @param message
*/
public void info(Object message)
{
@@ -142,6 +155,8 @@
/**
* Log an info message and accompanying Throwable.
+ * @param message
+ * @param t
*/
public void info(Object message, Throwable t)
{
@@ -150,6 +165,7 @@
/**
* Returns true if warn level messages will be printed by the LogChute.
+ * @return True if warn level messages will be printed by the LogChute.
*/
public boolean isWarnEnabled()
{
@@ -158,6 +174,7 @@
/**
* Log a warning message.
+ * @param message
*/
public void warn(Object message)
{
@@ -166,6 +183,8 @@
/**
* Log a warning message and accompanying Throwable.
+ * @param message
+ * @param t
*/
public void warn(Object message, Throwable t)
{
@@ -174,6 +193,7 @@
/**
* Returns true if error level messages will be printed by the LogChute.
+ * @return True if error level messages will be printed by the LogChute.
*/
public boolean isErrorEnabled()
{
@@ -182,6 +202,7 @@
/**
* Log an error message.
+ * @param message
*/
public void error(Object message)
{
@@ -190,6 +211,8 @@
/**
* Log an error message and accompanying Throwable.
+ * @param message
+ * @param t
*/
public void error(Object message, Throwable t)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log4JLogChute.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log4JLogChute.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log4JLogChute.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log4JLogChute.java Sun Sep 17 13:07:29 2006
@@ -30,10 +30,6 @@
* Implementation of a simple log4j system that will either latch onto
* an existing category, or just do a simple rolling file log.
*
- * Use this one rather than {@link SimpleLog4JLogSystem}; it uses the
- * modern <code>Logger</code> concept of Log4J, rather than the
- * deprecated <code>Category</code> concept.
- *
* @author <a href="mailto:geirm@apache.org>Geir Magnusson Jr.</a>
* @author <a href="mailto:dlr@finemaltcoding.com>Daniel L. Rall</a>
* @author <a href="mailto:nbubna@apache.org>Nathan Bubna</a>
@@ -42,6 +38,9 @@
*/
public class Log4JLogChute implements LogChute
{
+ /**
+ *
+ */
public static final String RUNTIME_LOG_LOG4J_LOGGER =
"runtime.log.logsystem.log4j.logger";
@@ -54,6 +53,9 @@
*/
protected Logger logger = null;
+ /**
+ * @see org.apache.velocity.runtime.log.LogChute#init(org.apache.velocity.runtime.RuntimeServices)
+ */
public void init(RuntimeServices rs) throws Exception
{
rsvc = rs;
@@ -162,7 +164,7 @@
}
/**
- * Send a log message from Velocity along with an exception or error
+ * @see org.apache.velocity.runtime.log.LogChute#log(int, java.lang.String, java.lang.Throwable)
*/
public void log(int level, String message, Throwable t)
{
@@ -197,7 +199,7 @@
}
/**
- * Checks whether the logger is enabled for the specified level
+ * @see org.apache.velocity.runtime.log.LogChute#isLevelEnabled(int)
*/
public boolean isLevelEnabled(int level)
{
@@ -228,6 +230,7 @@
/**
* Also do a shutdown if the object is destroy()'d.
+ * @throws Throwable
*/
protected void finalize() throws Throwable
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log4JLogSystem.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log4JLogSystem.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log4JLogSystem.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/Log4JLogSystem.java Sun Sep 17 13:07:29 2006
@@ -34,7 +34,9 @@
public class Log4JLogSystem extends Log4JLogChute implements LogSystem
{
/**
- * @deprecated Use log(level, message).
+ * @param level
+ * @param message
+ * @deprecated Use log(level, message).
*/
public void logVelocityMessage(int level, String message)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogChute.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogChute.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogChute.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogChute.java Sun Sep 17 13:07:29 2006
@@ -61,21 +61,30 @@
/**
* Initializes this LogChute.
+ * @param rs
+ * @throws Exception
*/
public void init(RuntimeServices rs) throws Exception;
/**
* Send a log message from Velocity.
+ * @param level
+ * @param message
*/
public void log(int level, String message);
/**
* Send a log message from Velocity along with an exception or error
+ * @param level
+ * @param message
+ * @param t
*/
public void log(int level, String message, Throwable t);
/**
* Tell whether or not a log level is enabled.
+ * @param level
+ * @return True if a level is enabled.
*/
public boolean isLevelEnabled(int level);
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogChuteSystem.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogChuteSystem.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogChuteSystem.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogChuteSystem.java Sun Sep 17 13:07:29 2006
@@ -34,17 +34,24 @@
/**
* Only classes in this package should be creating this.
* Users should not have to mess with this class.
+ * @param wrapMe
*/
protected LogChuteSystem(LogSystem wrapMe)
{
this.logSystem = wrapMe;
}
+ /**
+ * @see org.apache.velocity.runtime.log.LogChute#init(org.apache.velocity.runtime.RuntimeServices)
+ */
public void init(RuntimeServices rs) throws Exception
{
logSystem.init(rs);
}
+ /**
+ * @see org.apache.velocity.runtime.log.LogChute#log(int, java.lang.String)
+ */
public void log(int level, String message)
{
logSystem.logVelocityMessage(level, message);
@@ -54,6 +61,9 @@
* First passes off the message at the specified level,
* then passes off stack trace of the Throwable as a
* 2nd message at the same level.
+ * @param level
+ * @param message
+ * @param t
*/
public void log(int level, String message, Throwable t)
{
@@ -62,7 +72,7 @@
}
/**
- * Always returns true.
+ * @see org.apache.velocity.runtime.log.LogChute#isLevelEnabled(int)
*/
public boolean isLevelEnabled(int level)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogManager.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogManager.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogManager.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogManager.java Sun Sep 17 13:07:29 2006
@@ -195,6 +195,9 @@
/**
* Update the Log instance with the appropriate LogChute and other
* settings determined by the RuntimeServices.
+ * @param log
+ * @param rsvc
+ * @throws Exception
*/
public static void updateLog(Log log, RuntimeServices rsvc) throws Exception
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogSystem.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogSystem.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogSystem.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/LogSystem.java Sun Sep 17 13:07:29 2006
@@ -55,10 +55,14 @@
/**
* Initializes this LogSystem.
+ * @param rs
+ * @throws Exception
*/
public void init( RuntimeServices rs ) throws Exception;
/**
+ * @param level
+ * @param message
* @deprecated Use log(level, message).
*/
public void logVelocityMessage(int level, String message);
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/NullLogChute.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/NullLogChute.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/NullLogChute.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/NullLogChute.java Sun Sep 17 13:07:29 2006
@@ -28,6 +28,9 @@
public class NullLogChute implements LogChute
{
+ /**
+ * @see org.apache.velocity.runtime.log.LogChute#init(org.apache.velocity.runtime.RuntimeServices)
+ */
public void init(RuntimeServices rs) throws Exception
{
}
@@ -55,7 +58,7 @@
}
/**
- * This will always return false.
+ * @see org.apache.velocity.runtime.log.LogChute#isLevelEnabled(int)
*/
public boolean isLevelEnabled(int level)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/NullLogSystem.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/NullLogSystem.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/NullLogSystem.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/NullLogSystem.java Sun Sep 17 13:07:29 2006
@@ -27,7 +27,9 @@
public class NullLogSystem extends NullLogChute implements LogSystem
{
/**
- * @deprecated Use log(level, message).
+ * @param level
+ * @param message
+ * @deprecated Use log(level, message).
*/
public void logVelocityMessage(int level, String message)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/PrimordialLogSystem.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/PrimordialLogSystem.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/PrimordialLogSystem.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/PrimordialLogSystem.java Sun Sep 17 13:07:29 2006
@@ -29,6 +29,8 @@
public class PrimordialLogSystem extends HoldingLogChute implements LogSystem
{
/**
+ * @param level
+ * @param message
* @deprecated Use log(level, message).
*/
public void logVelocityMessage(int level, String message)
@@ -37,6 +39,7 @@
}
/**
+ * @param newLogger
* @deprecated use transferTo(LogChute newChute)
*/
public void dumpLogMessages( LogSystem newLogger )
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/RuntimeLoggerLog.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/RuntimeLoggerLog.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/RuntimeLoggerLog.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/RuntimeLoggerLog.java Sun Sep 17 13:07:29 2006
@@ -40,6 +40,7 @@
/**
* Creates a new Log that wraps a PrimordialLogChute.
+ * @param rlog
*/
public RuntimeLoggerLog(RuntimeLogger rlog)
{
@@ -50,102 +51,156 @@
this.rlog = rlog;
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#setLogChute(org.apache.velocity.runtime.log.LogChute)
+ */
protected void setLogChute(LogChute newLogChute)
{
throw new UnsupportedOperationException("RuntimeLoggerLog does not support this method.");
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#getLogChute()
+ */
protected LogChute getLogChute()
{
throw new UnsupportedOperationException("RuntimeLoggerLog does not support this method.");
}
+ /**
+ * @param showStacks
+ */
protected void setShowStackTraces(boolean showStacks)
{
throw new UnsupportedOperationException("RuntimeLoggerLog does not support this method.");
}
+ /**
+ * @return True if Stack traces should be shown.
+ */
public boolean getShowStackTraces()
{
throw new UnsupportedOperationException("RuntimeLoggerLog does not support this method.");
}
/**
- * Returns true.
+ * @see org.apache.velocity.runtime.log.Log#isTraceEnabled()
*/
public boolean isTraceEnabled()
{
return true;
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#trace(java.lang.Object)
+ */
public void trace(Object message)
{
debug(message);
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#trace(java.lang.Object, java.lang.Throwable)
+ */
public void trace(Object message, Throwable t)
{
debug(message, t);
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#isDebugEnabled()
+ */
public boolean isDebugEnabled()
{
return true;
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#debug(java.lang.Object)
+ */
public void debug(Object message)
{
rlog.debug(message);
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#debug(java.lang.Object, java.lang.Throwable)
+ */
public void debug(Object message, Throwable t)
{
rlog.debug(message);
rlog.debug(t);
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#isInfoEnabled()
+ */
public boolean isInfoEnabled()
{
return true;
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#info(java.lang.Object)
+ */
public void info(Object message)
{
rlog.info(message);
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#info(java.lang.Object, java.lang.Throwable)
+ */
public void info(Object message, Throwable t)
{
rlog.info(message);
rlog.info(t);
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#isWarnEnabled()
+ */
public boolean isWarnEnabled()
{
return true;
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#warn(java.lang.Object)
+ */
public void warn(Object message)
{
rlog.warn(message);
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#warn(java.lang.Object, java.lang.Throwable)
+ */
public void warn(Object message, Throwable t)
{
rlog.warn(message);
rlog.warn(t);
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#isErrorEnabled()
+ */
public boolean isErrorEnabled()
{
return true;
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#error(java.lang.Object)
+ */
public void error(Object message)
{
rlog.error(message);
}
+ /**
+ * @see org.apache.velocity.runtime.log.Log#error(java.lang.Object, java.lang.Throwable)
+ */
public void error(Object message, Throwable t)
{
rlog.error(message);
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/SimpleLog4JLogSystem.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/SimpleLog4JLogSystem.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/SimpleLog4JLogSystem.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/SimpleLog4JLogSystem.java Sun Sep 17 13:07:29 2006
@@ -45,10 +45,16 @@
/** log4java logging interface */
protected Category logger = null;
+ /**
+ *
+ */
public SimpleLog4JLogSystem()
{
}
+ /**
+ * @see org.apache.velocity.runtime.log.LogSystem#init(org.apache.velocity.runtime.RuntimeServices)
+ */
public void init( RuntimeServices rs )
{
rsvc = rs;
@@ -152,6 +158,7 @@
/**
* Also do a shutdown if the object is destroy()'d.
+ * @throws Throwable
*/
protected void finalize() throws Throwable
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/StandardOutLogChute.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/StandardOutLogChute.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/StandardOutLogChute.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/StandardOutLogChute.java Sun Sep 17 13:07:29 2006
@@ -26,11 +26,15 @@
*/
public class StandardOutLogChute implements LogChute
{
+ /** */
public static final String RUNTIME_LOG_LEVEL_KEY =
"runtime.log.logsystem.stdout.level";
private int enabled = TRACE_ID;
+ /**
+ * @see org.apache.velocity.runtime.log.LogChute#init(org.apache.velocity.runtime.RuntimeServices)
+ */
public void init(RuntimeServices rs) throws Exception
{
// look for a level config property
@@ -57,6 +61,10 @@
}
}
+ /**
+ * @param level
+ * @return The prefix for the given level.
+ */
protected String getPrefix(int level)
{
switch (level)
@@ -134,6 +142,7 @@
/**
* Set the minimum level at which messages will be printed.
+ * @param level
*/
public void setEnabledLevel(int level)
{
@@ -142,6 +151,7 @@
/**
* Returns the current minimum level at which messages will be printed.
+ * @return The current minimum level at which messages will be printed.
*/
public int getEnabledLevel()
{
@@ -152,6 +162,8 @@
* This will return true if the specified level
* is equal to or higher than the level this
* LogChute is enabled for.
+ * @param level
+ * @return True if logging is enabled for this level.
*/
public boolean isLevelEnabled(int level)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/VelocityFormatter.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/VelocityFormatter.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/VelocityFormatter.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/log/VelocityFormatter.java Sun Sep 17 13:07:29 2006
@@ -19,8 +19,14 @@
import java.util.Date;
import org.apache.log.format.PatternFormatter;
+/**
+ *
+ */
public class VelocityFormatter extends PatternFormatter
{
+ /**
+ * @param format
+ */
public VelocityFormatter( String format )
{
super( format );
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/ParserVisitor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/ParserVisitor.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/ParserVisitor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/ParserVisitor.java Sun Sep 17 13:07:29 2006
@@ -58,47 +58,301 @@
import org.apache.velocity.runtime.parser.node.ASTprocess;
import org.apache.velocity.runtime.parser.node.SimpleNode;
+/**
+ *
+ */
public interface ParserVisitor
{
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(SimpleNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTprocess node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTEscapedDirective node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTEscape node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTComment node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTFloatingPointLiteral node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTIntegerLiteral node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTStringLiteral node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTIdentifier node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTWord node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTDirective node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTBlock node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTMap node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTObjectArray node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTIntegerRange node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTMethod node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTReference node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTTrue node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTFalse node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTText node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTIfStatement node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTElseStatement node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTElseIfStatement node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTSetDirective node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTStop node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTExpression node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTAssignment node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTOrNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTAndNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTEQNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTNENode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTLTNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTGTNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTLENode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTGENode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTAddNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTSubtractNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTMulNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTDivNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTModNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
public Object visit(ASTNotNode node, Object data);
+
+ /**
+ * @param node
+ * @param data
+ * @return The object rendered by this node.
+ */
}
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/TemplateParseException.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/TemplateParseException.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/TemplateParseException.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/TemplateParseException.java Sun Sep 17 13:07:29 2006
@@ -42,6 +42,10 @@
/**
* This constructor is used to add a template name
* to info cribbed from a ParseException generated in the parser.
+ * @param currentTokenVal
+ * @param expectedTokenSequencesVal
+ * @param tokenImageVal
+ * @param templateNameVal
*/
public TemplateParseException(Token currentTokenVal, int [][] expectedTokenSequencesVal, String [] tokenImageVal,
String templateNameVal)
@@ -61,6 +65,9 @@
* to force the "toString" method of parent class "Throwable" to
* print the error message in the form:
* ParseException: <result of getMessage>
+ * @param currentTokenVal
+ * @param expectedTokenSequencesVal
+ * @param tokenImageVal
*/
public TemplateParseException(Token currentTokenVal, int [][] expectedTokenSequencesVal, String [] tokenImageVal)
{
@@ -96,6 +103,7 @@
/**
* returns the Template name where this exception occured.
+ * @return The Template name where this exception occured.
*/
public String getTemplateName()
{
@@ -104,6 +112,7 @@
/**
* returns the line number where this exception occured.
+ * @return The line number where this exception occured.
*/
public int getLineNumber()
{
@@ -119,6 +128,7 @@
/**
* returns the column number where this exception occured.
+ * @return The column number where this exception occured.
*/
public int getColumnNumber()
{
@@ -141,6 +151,7 @@
* from the parser), then this method is called during the printing
* of the final stack trace, and hence the correct error message
* gets displayed.
+ * @return The error message.
*/
public String getMessage()
{
@@ -212,6 +223,9 @@
return retval.toString();
}
+ /**
+ * @param sb
+ */
protected void appendTemplateInfo(final StringBuffer sb)
{
sb.append(" at line ").append(getLineNumber())
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/VelocityCharStream.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/VelocityCharStream.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/VelocityCharStream.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/VelocityCharStream.java Sun Sep 17 13:07:29 2006
@@ -19,10 +19,12 @@
public final class VelocityCharStream
implements CharStream
{
- public static final boolean staticFlag = false;
+ /** */
+ public static final boolean staticFlag = false;
int bufsize;
int available;
int tokenBegin;
+ /** */
public int bufpos = -1;
private int bufline[];
private int bufcolumn[];
@@ -134,7 +136,10 @@
}
}
- public final char BeginToken() throws java.io.IOException
+ /**
+ * @see org.apache.velocity.runtime.parser.CharStream#BeginToken()
+ */
+public final char BeginToken() throws java.io.IOException
{
tokenBegin = -1;
char c = readChar();
@@ -183,7 +188,10 @@
bufcolumn[bufpos] = column;
}
- public final char readChar() throws java.io.IOException
+ /**
+ * @see org.apache.velocity.runtime.parser.CharStream#readChar()
+ */
+public final char readChar() throws java.io.IOException
{
if (inBuf > 0)
{
@@ -208,47 +216,66 @@
}
/**
- * @deprecated
- * @see #getEndColumn
- */
-
- public final int getColumn() {
+ * @see org.apache.velocity.runtime.parser.CharStream#getColumn()
+ * @deprecated
+ */
+public final int getColumn() {
return bufcolumn[bufpos];
}
- /**
- * @deprecated
- * @see #getEndLine
- */
-
+/**
+ * @see org.apache.velocity.runtime.parser.CharStream#getLine()
+ * @deprecated
+ */
public final int getLine() {
return bufline[bufpos];
}
- public final int getEndColumn() {
+ /**
+ * @see org.apache.velocity.runtime.parser.CharStream#getEndColumn()
+ */
+public final int getEndColumn() {
return bufcolumn[bufpos];
}
- public final int getEndLine() {
+ /**
+ * @see org.apache.velocity.runtime.parser.CharStream#getEndLine()
+ */
+public final int getEndLine() {
return bufline[bufpos];
}
- public final int getBeginColumn() {
+ /**
+ * @see org.apache.velocity.runtime.parser.CharStream#getBeginColumn()
+ */
+public final int getBeginColumn() {
return bufcolumn[tokenBegin];
}
- public final int getBeginLine() {
+ /**
+ * @see org.apache.velocity.runtime.parser.CharStream#getBeginLine()
+ */
+public final int getBeginLine() {
return bufline[tokenBegin];
}
- public final void backup(int amount) {
+ /**
+ * @see org.apache.velocity.runtime.parser.CharStream#backup(int)
+ */
+public final void backup(int amount) {
inBuf += amount;
if ((bufpos -= amount) < 0)
bufpos += bufsize;
}
- public VelocityCharStream(java.io.Reader dstream, int startline,
+ /**
+ * @param dstream
+ * @param startline
+ * @param startcolumn
+ * @param buffersize
+ */
+public VelocityCharStream(java.io.Reader dstream, int startline,
int startcolumn, int buffersize)
{
inputStream = dstream;
@@ -261,12 +288,23 @@
bufcolumn = new int[buffersize];
}
- public VelocityCharStream(java.io.Reader dstream, int startline,
+ /**
+ * @param dstream
+ * @param startline
+ * @param startcolumn
+ */
+public VelocityCharStream(java.io.Reader dstream, int startline,
int startcolumn)
{
this(dstream, startline, startcolumn, 4096);
}
- public void ReInit(java.io.Reader dstream, int startline,
+ /**
+ * @param dstream
+ * @param startline
+ * @param startcolumn
+ * @param buffersize
+ */
+public void ReInit(java.io.Reader dstream, int startline,
int startcolumn, int buffersize)
{
inputStream = dstream;
@@ -285,34 +323,64 @@
bufpos = -1;
}
- public void ReInit(java.io.Reader dstream, int startline,
+ /**
+ * @param dstream
+ * @param startline
+ * @param startcolumn
+ */
+public void ReInit(java.io.Reader dstream, int startline,
int startcolumn)
{
ReInit(dstream, startline, startcolumn, 4096);
}
- public VelocityCharStream(java.io.InputStream dstream, int startline,
+ /**
+ * @param dstream
+ * @param startline
+ * @param startcolumn
+ * @param buffersize
+ */
+public VelocityCharStream(java.io.InputStream dstream, int startline,
int startcolumn, int buffersize)
{
this(new java.io.InputStreamReader(dstream), startline, startcolumn, 4096);
}
- public VelocityCharStream(java.io.InputStream dstream, int startline,
+ /**
+ * @param dstream
+ * @param startline
+ * @param startcolumn
+ */
+public VelocityCharStream(java.io.InputStream dstream, int startline,
int startcolumn)
{
this(dstream, startline, startcolumn, 4096);
}
- public void ReInit(java.io.InputStream dstream, int startline,
+ /**
+ * @param dstream
+ * @param startline
+ * @param startcolumn
+ * @param buffersize
+ */
+public void ReInit(java.io.InputStream dstream, int startline,
int startcolumn, int buffersize)
{
ReInit(new java.io.InputStreamReader(dstream), startline, startcolumn, 4096);
}
- public void ReInit(java.io.InputStream dstream, int startline,
+ /**
+ * @param dstream
+ * @param startline
+ * @param startcolumn
+ */
+public void ReInit(java.io.InputStream dstream, int startline,
int startcolumn)
{
ReInit(dstream, startline, startcolumn, 4096);
}
- public final String GetImage()
+ /**
+ * @see org.apache.velocity.runtime.parser.CharStream#GetImage()
+ */
+public final String GetImage()
{
if (bufpos >= tokenBegin)
return new String(buffer, tokenBegin, bufpos - tokenBegin + 1);
@@ -321,7 +389,10 @@
new String(buffer, 0, bufpos + 1);
}
- public final char[] GetSuffix(int len)
+ /**
+ * @see org.apache.velocity.runtime.parser.CharStream#GetSuffix(int)
+ */
+public final char[] GetSuffix(int len)
{
char[] ret = new char[len];
@@ -337,7 +408,10 @@
return ret;
}
- public void Done()
+ /**
+ * @see org.apache.velocity.runtime.parser.CharStream#Done()
+ */
+public void Done()
{
buffer = null;
bufline = null;
@@ -346,6 +420,8 @@
/**
* Method to adjust line and column numbers for the start of a token.<BR>
+ * @param newLine
+ * @param newCol
*/
public void adjustBeginLineColumn(int newLine, int newCol)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAddNode.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAddNode.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAddNode.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAddNode.java Sun Sep 17 13:07:29 2006
@@ -37,19 +37,31 @@
import org.apache.velocity.util.TemplateNumber;
+/**
+ *
+ */
public class ASTAddNode extends SimpleNode
{
+ /**
+ * @param id
+ */
public ASTAddNode(int id)
{
super(id);
}
+ /**
+ * @param p
+ * @param id
+ */
public ASTAddNode(Parser p, int id)
{
super(p, id);
}
- /** Accept the visitor. **/
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
+ */
public Object jjtAccept(ParserVisitor visitor, Object data)
{
return visitor.visit(this, data);
@@ -57,7 +69,9 @@
/**
* computes the sum of the two nodes.
+ * @param context
* @return result or null
+ * @throws MethodInvocationException
*/
public Object value( InternalContextAdapter context)
throws MethodInvocationException
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAndNode.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAndNode.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAndNode.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAndNode.java Sun Sep 17 13:07:29 2006
@@ -32,17 +32,26 @@
*/
public class ASTAndNode extends SimpleNode
{
+ /**
+ * @param id
+ */
public ASTAndNode(int id)
{
super(id);
}
+ /**
+ * @param p
+ * @param id
+ */
public ASTAndNode(Parser p, int id)
{
super(p, id);
}
- /** Accept the visitor. **/
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
+ */
public Object jjtAccept(ParserVisitor visitor, Object data)
{
return visitor.visit(this, data);
@@ -52,6 +61,9 @@
* Returns the value of the expression.
* Since the value of the expression is simply the boolean
* result of evaluate(), lets return that.
+ * @param context
+ * @return The value of the expression.
+ * @throws MethodInvocationException
*/
public Object value(InternalContextAdapter context)
throws MethodInvocationException
@@ -65,6 +77,9 @@
* null && right = false
* left && null = false
* null && null = false
+ * @param context
+ * @return True if both sides are true.
+ * @throws MethodInvocationException
*/
public boolean evaluate( InternalContextAdapter context)
throws MethodInvocationException
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAssignment.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAssignment.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAssignment.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTAssignment.java Sun Sep 17 13:07:29 2006
@@ -20,19 +20,31 @@
import org.apache.velocity.runtime.parser.Parser;
import org.apache.velocity.runtime.parser.ParserVisitor;
+/**
+ *
+ */
public class ASTAssignment extends SimpleNode
{
+ /**
+ * @param id
+ */
public ASTAssignment(int id)
{
super(id);
}
+ /**
+ * @param p
+ * @param id
+ */
public ASTAssignment(Parser p, int id)
{
super(p, id);
}
- /** Accept the visitor. **/
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
+ */
public Object jjtAccept(ParserVisitor visitor, Object data)
{
return visitor.visit(this, data);
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTBlock.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTBlock.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTBlock.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTBlock.java Sun Sep 17 13:07:29 2006
@@ -29,24 +29,39 @@
import org.apache.velocity.exception.ResourceNotFoundException;
+/**
+ *
+ */
public class ASTBlock extends SimpleNode
{
+ /**
+ * @param id
+ */
public ASTBlock(int id)
{
super(id);
}
+ /**
+ * @param p
+ * @param id
+ */
public ASTBlock(Parser p, int id)
{
super(p, id);
}
- /** Accept the visitor. **/
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
+ */
public Object jjtAccept(ParserVisitor visitor, Object data)
{
return visitor.visit(this, data);
}
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#render(org.apache.velocity.context.InternalContextAdapter, java.io.Writer)
+ */
public boolean render( InternalContextAdapter context, Writer writer)
throws IOException, MethodInvocationException,
ResourceNotFoundException, ParseErrorException
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTComment.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTComment.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTComment.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTComment.java Sun Sep 17 13:07:29 2006
@@ -39,17 +39,26 @@
private char[] carr;
+ /**
+ * @param id
+ */
public ASTComment(int id)
{
super(id);
}
+ /**
+ * @param p
+ * @param id
+ */
public ASTComment(Parser p, int id)
{
super(p, id);
}
- /** Accept the visitor. **/
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
+ */
public Object jjtAccept(ParserVisitor visitor, Object data)
{
return visitor.visit(this, data);
@@ -57,6 +66,10 @@
/**
* We need to make sure we catch any of the dreaded MORE tokens.
+ * @param context
+ * @param data
+ * @return The data object.
+ * @throws Exception
*/
public Object init(InternalContextAdapter context, Object data)
throws Exception
@@ -78,6 +91,9 @@
return data;
}
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#render(org.apache.velocity.context.InternalContextAdapter, java.io.Writer)
+ */
public boolean render( InternalContextAdapter context, Writer writer)
throws IOException, MethodInvocationException, ParseErrorException, ResourceNotFoundException
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTDirective.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTDirective.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTDirective.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTDirective.java Sun Sep 17 13:07:29 2006
@@ -48,23 +48,35 @@
private String directiveName = "";
private boolean isDirective;
+ /**
+ * @param id
+ */
public ASTDirective(int id)
{
super(id);
}
+ /**
+ * @param p
+ * @param id
+ */
public ASTDirective(Parser p, int id)
{
super(p, id);
}
- /** Accept the visitor. **/
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
+ */
public Object jjtAccept(ParserVisitor visitor, Object data)
{
return visitor.visit(this, data);
}
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#init(org.apache.velocity.context.InternalContextAdapter, java.lang.Object)
+ */
public Object init( InternalContextAdapter context, Object data)
throws Exception
{
@@ -105,6 +117,9 @@
return data;
}
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#render(org.apache.velocity.context.InternalContextAdapter, java.io.Writer)
+ */
public boolean render( InternalContextAdapter context, Writer writer)
throws IOException,MethodInvocationException, ResourceNotFoundException, ParseErrorException
{
@@ -131,6 +146,7 @@
/**
* Sets the directive name. Used by the parser. This keeps us from having to
* dig it out of the token stream and gives the parse the change to override.
+ * @param str
*/
public void setDirectiveName( String str )
{
@@ -140,6 +156,7 @@
/**
* Gets the name of this directive.
+ * @return The name of this directive.
*/
public String getDirectiveName()
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTDivNode.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTDivNode.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTDivNode.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTDivNode.java Sun Sep 17 13:07:29 2006
@@ -36,17 +36,26 @@
*/
public class ASTDivNode extends SimpleNode
{
+ /**
+ * @param id
+ */
public ASTDivNode(int id)
{
super(id);
}
+ /**
+ * @param p
+ * @param id
+ */
public ASTDivNode(Parser p, int id)
{
super(p, id);
}
- /** Accept the visitor. **/
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
+ */
public Object jjtAccept(ParserVisitor visitor, Object data)
{
return visitor.visit(this, data);
@@ -54,7 +63,9 @@
/**
* computes the result of the division.
+ * @param context
* @return result or null
+ * @throws MethodInvocationException
*/
public Object value( InternalContextAdapter context)
throws MethodInvocationException
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTElseIfStatement.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTElseIfStatement.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTElseIfStatement.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/ASTElseIfStatement.java Sun Sep 17 13:07:29 2006
@@ -40,17 +40,26 @@
*/
public class ASTElseIfStatement extends SimpleNode
{
+ /**
+ * @param id
+ */
public ASTElseIfStatement(int id)
{
super(id);
}
+ /**
+ * @param p
+ * @param id
+ */
public ASTElseIfStatement(Parser p, int id)
{
super(p, id);
}
- /** Accept the visitor. **/
+ /**
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
+ */
public Object jjtAccept(ParserVisitor visitor, Object data)
{
return visitor.visit(this, data);
@@ -63,6 +72,9 @@
* here and return the value back to ASTIfStatement
* where this node was originally asked to evaluate
* itself.
+ * @param context
+ * @return True if all childs are true.
+ * @throws MethodInvocationException
*/
public boolean evaluate ( InternalContextAdapter context)
throws MethodInvocationException
@@ -71,7 +83,7 @@
}
/**
- * renders the block
+ * @see org.apache.velocity.runtime.parser.node.SimpleNode#render(org.apache.velocity.context.InternalContextAdapter, java.io.Writer)
*/
public boolean render( InternalContextAdapter context, Writer writer)
throws IOException,MethodInvocationException,
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/AbstractExecutor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/AbstractExecutor.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/AbstractExecutor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/AbstractExecutor.java Sun Sep 17 13:07:29 2006
@@ -33,6 +33,7 @@
*/
public abstract class AbstractExecutor
{
+ /** */
protected Log log = null;
/**
@@ -42,6 +43,10 @@
/**
* Execute method against context.
+ * @param o
+ * @return The resulting object.
+ * @throws IllegalAccessException
+ * @throws InvocationTargetException
*/
public abstract Object execute(Object o)
throws IllegalAccessException, InvocationTargetException;
@@ -49,17 +54,25 @@
/**
* Tell whether the executor is alive by looking
* at the value of the method.
+ *
+ * @return True if executor is alive.
*/
public boolean isAlive()
{
return (method != null);
}
+ /**
+ * @return The current method.
+ */
public Method getMethod()
{
return method;
}
+ /**
+ * @param method
+ */
protected void setMethod(final Method method)
{
this.method = method;
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/BooleanPropertyExecutor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/BooleanPropertyExecutor.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/BooleanPropertyExecutor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/BooleanPropertyExecutor.java Sun Sep 17 13:07:29 2006
@@ -35,6 +35,12 @@
*/
public class BooleanPropertyExecutor extends PropertyExecutor
{
+ /**
+ * @param log
+ * @param introspector
+ * @param clazz
+ * @param property
+ */
public BooleanPropertyExecutor(final Log log, final Introspector introspector,
final Class clazz, final String property)
{
@@ -42,6 +48,10 @@
}
/**
+ * @param rlog
+ * @param introspector
+ * @param clazz
+ * @param property
* @deprecated RuntimeLogger is deprecated. Use the other constructor.
*/
public BooleanPropertyExecutor(final RuntimeLogger rlog, final Introspector introspector,
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/GetExecutor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/GetExecutor.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/GetExecutor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/GetExecutor.java Sun Sep 17 13:07:29 2006
@@ -40,6 +40,12 @@
// This is still threadsafe because this object is only read except in the C'tor.
private Object [] params = {};
+ /**
+ * @param log
+ * @param introspector
+ * @param clazz
+ * @param property
+ */
public GetExecutor(final Log log, final Introspector introspector,
final Class clazz, final String property)
{
@@ -61,6 +67,10 @@
}
/**
+ * @param rlog
+ * @param introspector
+ * @param clazz
+ * @param property
* @deprecated RuntimeLogger is deprecated. Use the other constructor.
*/
public GetExecutor(final RuntimeLogger rlog, final Introspector introspector,
@@ -89,7 +99,7 @@
}
/**
- * Execute method against context.
+ * @see org.apache.velocity.runtime.parser.node.AbstractExecutor#execute(java.lang.Object)
*/
public Object execute(final Object o)
throws IllegalAccessException, InvocationTargetException
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/MathUtils.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/MathUtils.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/MathUtils.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/MathUtils.java Sun Sep 17 13:07:29 2006
@@ -90,6 +90,8 @@
/**
* Convert the given Number to a BigDecimal
+ * @param n
+ * @return The number as BigDecimal
*/
public static BigDecimal toBigDecimal (Number n)
{
@@ -110,6 +112,8 @@
/**
* Convert the given Number to a BigInteger
+ * @param n
+ * @return The number as BigInteger
*/
public static BigInteger toBigInteger (Number n)
{
@@ -125,6 +129,8 @@
/**
* Compare the given Number to 0.
+ * @param n
+ * @return True if number is 0.
*/
public static boolean isZero (Number n)
{
@@ -150,6 +156,8 @@
/**
* Test, whether the given object is an integer value
* (Byte, Short, Integer, Long, BigInteger)
+ * @param n
+ * @return True if n is an integer.
*/
public static boolean isInteger (Number n)
{
@@ -159,6 +167,9 @@
/**
* Wrap the given primitive into the given class if the value is in the
* range of the destination type. If not the next bigger type will be chosen.
+ * @param value
+ * @param type
+ * @return Number object representing the primitive.
*/
public static Number wrapPrimitive (long value, Class type)
{
@@ -251,6 +262,9 @@
/**
* Add two numbers and return the correct value / type.
* Overflow detection is done for integer values (byte, short, int, long) only!
+ * @param op1
+ * @param op2
+ * @return Addition result.
*/
public static Number add (Number op1, Number op2)
{
@@ -285,6 +299,9 @@
/**
* Subtract two numbers and return the correct value / type.
* Overflow detection is done for integer values (byte, short, int, long) only!
+ * @param op1
+ * @param op2
+ * @return Subtraction result.
*/
public static Number subtract (Number op1, Number op2) {
@@ -316,6 +333,9 @@
/**
* Multiply two numbers and return the correct value / type.
* Overflow detection is done for integer values (byte, short, int, long) only!
+ * @param op1
+ * @param op2
+ * @return Multiplication result.
*/
public static Number multiply (Number op1, Number op2) {
@@ -348,6 +368,9 @@
* Divide two numbers. The result will be returned as Integer-type if and only if
* both sides of the division operator are Integer-types. Otherwise a Float, Double,
* or BigDecimal will be returned.
+ * @param op1
+ * @param op2
+ * @return Division result.
*/
public static Number divide (Number op1, Number op2) {
@@ -376,6 +399,9 @@
/**
* Modulo two numbers.
+ * @param op1
+ * @param op2
+ * @return Modulo result.
*
* @throws ArithmeticException If at least one parameter is a BigDecimal
*/
@@ -400,6 +426,8 @@
/**
* Compare two numbers.
+ * @param op1
+ * @param op2
* @return 1 if n1 > n2, -1 if n1 < n2 and 0 if equal.
*/
public static int compare (Number op1, Number op2) {
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/Node.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/Node.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/Node.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/Node.java Sun Sep 17 13:07:29 2006
@@ -45,24 +45,45 @@
added. */
public void jjtClose();
- /** This pair of methods are used to inform the node of its
- parent. */
+ /**
+ * This pair of methods are used to inform the node of its
+ * parent.
+ * @param n
+ * */
public void jjtSetParent(Node n);
+ /**
+ * @return The node parent.
+ */
public Node jjtGetParent();
- /** This method tells the node to add its argument to the node's
- list of children. */
+ /**
+ * This method tells the node to add its argument to the node's
+ * list of children.
+ * @param n
+ * @param i
+ */
public void jjtAddChild(Node n, int i);
- /** This method returns a child node. The children are numbered
- from zero, left to right. */
+ /**
+ * This method returns a child node. The children are numbered
+ * from zero, left to right.
+ * @param i
+ * @return A child node.
+ */
public Node jjtGetChild(int i);
- /** Return the number of children the node has. */
+ /**
+ * Return the number of children the node has.
+ * @return The number of children of this node.
+ */
public int jjtGetNumChildren();
- /** Accept the visitor. **/
+ /**
+ * @param visitor
+ * @param data
+ * @return The Node execution result object.
+ */
public Object jjtAccept(ParserVisitor visitor, Object data);
/*
@@ -74,33 +95,104 @@
* ========================================================================
*/
+ /**
+ * @see #jjtAccept(ParserVisitor, Object)
+ * @param visitor
+ * @param data
+ * @return The node execution result.
+ */
public Object childrenAccept(ParserVisitor visitor, Object data);
- // added
+ /**
+ * @return The first token.
+ */
public Token getFirstToken();
+ /**
+ * @return The last token.
+ */
public Token getLastToken();
+ /**
+ * @return The NodeType.
+ */
public int getType();
+ /**
+ * @param context
+ * @param data
+ * @return The init result.
+ * @throws Exception
+ */
public Object init( InternalContextAdapter context, Object data) throws Exception;
+ /**
+ * @param context
+ * @return The evaluation result.
+ * @throws MethodInvocationException
+ */
public boolean evaluate( InternalContextAdapter context)
throws MethodInvocationException;
+ /**
+ * @param context
+ * @return The node value.
+ * @throws MethodInvocationException
+ */
public Object value( InternalContextAdapter context)
throws MethodInvocationException;
+ /**
+ * @param context
+ * @param writer
+ * @return True if the node rendered successfully.
+ * @throws IOException
+ * @throws MethodInvocationException
+ * @throws ParseErrorException
+ * @throws ResourceNotFoundException
+ */
public boolean render( InternalContextAdapter context, Writer writer)
throws IOException,MethodInvocationException, ParseErrorException, ResourceNotFoundException;
+ /**
+ * @param o
+ * @param context
+ * @return The execution result.
+ * @throws MethodInvocationException
+ */
public Object execute(Object o, InternalContextAdapter context)
throws MethodInvocationException;
+ /**
+ * @param info
+ */
public void setInfo(int info);
+
+ /**
+ * @return The current node info.
+ */
public int getInfo();
+ /**
+ * @return A literal.
+ */
public String literal();
+
+ /**
+ * Mark the node as invalid.
+ */
public void setInvalid();
+
+ /**
+ * @return True if the node is invalid.
+ */
public boolean isInvalid();
+
+ /**
+ * @return The current line position.
+ */
public int getLine();
+
+ /**
+ * @return The current column position.
+ */
public int getColumn();
}
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/NodeUtils.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/NodeUtils.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/NodeUtils.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/NodeUtils.java Sun Sep 17 13:07:29 2006
@@ -36,6 +36,8 @@
* In some cases you may want to retrieve these
* special tokens, this is simply a way to
* extract them.
+ * @param t
+ * @return String with the special tokens.
*/
public static String specialText(Token t)
{
@@ -136,6 +138,8 @@
/**
* complete node literal
+ * @param t
+ * @return A node literal.
*
*/
public static String tokenLiteral( Token t )
@@ -154,6 +158,10 @@
* And the string literal argument will
* be transformed into "candy.jpg" before
* the method is executed.
+ * @param argStr
+ * @param vars
+ * @return Interpoliation result.
+ * @throws MethodInvocationException
*/
public static String interpolate(String argStr, Context vars) throws MethodInvocationException
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/PropertyExecutor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/PropertyExecutor.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/PropertyExecutor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/PropertyExecutor.java Sun Sep 17 13:07:29 2006
@@ -30,6 +30,12 @@
{
private final Introspector introspector;
+ /**
+ * @param log
+ * @param introspector
+ * @param clazz
+ * @param property
+ */
public PropertyExecutor(final Log log, final Introspector introspector,
final Class clazz, final String property)
{
@@ -46,6 +52,10 @@
}
/**
+ * @param r
+ * @param introspector
+ * @param clazz
+ * @param property
* @deprecated RuntimeLogger is deprecated. Use the other constructor.
*/
public PropertyExecutor(final RuntimeLogger r, final Introspector introspector,
@@ -54,11 +64,18 @@
this(new RuntimeLoggerLog(r), introspector, clazz, property);
}
+ /**
+ * @return The current introspector.
+ */
protected Introspector getIntrospector()
{
return this.introspector;
}
+ /**
+ * @param clazz
+ * @param property
+ */
protected void discover(final Class clazz, final String property)
{
/*
@@ -108,7 +125,7 @@
}
/**
- * Execute method against context.
+ * @see org.apache.velocity.runtime.parser.node.AbstractExecutor#execute(java.lang.Object)
*/
public Object execute(Object o)
throws IllegalAccessException, InvocationTargetException
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/PutExecutor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/PutExecutor.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/PutExecutor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/PutExecutor.java Sun Sep 17 13:07:29 2006
@@ -37,6 +37,13 @@
private final Introspector introspector;
private final String property;
+ /**
+ * @param log
+ * @param introspector
+ * @param clazz
+ * @param arg
+ * @param property
+ */
public PutExecutor(final Log log, final Introspector introspector,
final Class clazz, final Object arg, final String property)
{
@@ -47,6 +54,10 @@
discover(clazz, arg);
}
+ /**
+ * @param clazz
+ * @param arg
+ */
protected void discover(final Class clazz, final Object arg)
{
Object [] params;
@@ -86,7 +97,7 @@
}
/**
- * Execute method against context.
+ * @see org.apache.velocity.runtime.parser.node.SetExecutor#execute(java.lang.Object, java.lang.Object)
*/
public Object execute(final Object o, final Object value)
throws IllegalAccessException, InvocationTargetException
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SetExecutor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SetExecutor.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SetExecutor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SetExecutor.java Sun Sep 17 13:07:29 2006
@@ -37,6 +37,7 @@
*/
public abstract class SetExecutor
{
+ /** Class logger */
protected Log log = null;
/**
@@ -46,6 +47,11 @@
/**
* Execute method against context.
+ * @param o
+ * @param value
+ * @return The result of the invocation.
+ * @throws IllegalAccessException
+ * @throws InvocationTargetException
*/
public abstract Object execute(Object o, Object value)
throws IllegalAccessException, InvocationTargetException;
@@ -53,17 +59,24 @@
/**
* Tell whether the executor is alive by looking
* at the value of the method.
+ * @return True if the executor is alive.
*/
public boolean isAlive()
{
return (method != null);
}
+ /**
+ * @return The method to invoke.
+ */
public Method getMethod()
{
return method;
}
+ /**
+ * @param method
+ */
protected void setMethod(final Method method)
{
this.method = method;
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SetPropertyExecutor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SetPropertyExecutor.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SetPropertyExecutor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SetPropertyExecutor.java Sun Sep 17 13:07:29 2006
@@ -33,6 +33,13 @@
{
private final Introspector introspector;
+ /**
+ * @param log
+ * @param introspector
+ * @param clazz
+ * @param property
+ * @param arg
+ */
public SetPropertyExecutor(final Log log, final Introspector introspector,
final Class clazz, final String property, final Object arg)
{
@@ -48,11 +55,19 @@
}
}
+ /**
+ * @return The current introspector.
+ */
protected Introspector getIntrospector()
{
return this.introspector;
}
+ /**
+ * @param clazz
+ * @param property
+ * @param arg
+ */
protected void discover(final Class clazz, final String property, final Object arg)
{
Object [] params = new Object [] { arg };
@@ -99,6 +114,11 @@
/**
* Execute method against context.
+ * @param o
+ * @param value
+ * @return The value of the invocation.
+ * @throws IllegalAccessException
+ * @throws InvocationTargetException
*/
public Object execute(final Object o, final Object value)
throws IllegalAccessException, InvocationTargetException
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org