Author: cbrisson
Date: Mon Mar 11 11:09:53 2019
New Revision: 1855206
URL: http://svn.apache.org/viewvc?rev=1855206&view=rev
Log:
[engine] javadoc and indentation fixes
Modified:
velocity/engine/trunk/pom.xml
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/Template.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/VelocityEngine.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/EventCartridge.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/EventHandlerUtil.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/implement/IncludeNotFound.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/context/InternalWrapperContext.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/MethodInvocationException.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/ParseErrorException.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/ResourceNotFoundException.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/io/UnicodeInputStream.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/io/VelocityWriter.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeInstance.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeServices.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeSingleton.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/VelocimacroManager.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Block.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/BlockMacro.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Directive.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Foreach.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/RuntimeMacro.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Scope.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/VelocimacroProxy.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/CharStream.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/ParseException.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/TemplateParseException.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTAndNode.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTComparisonNode.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTIndex.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTMathNode.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTOrNode.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTReference.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTStringLiteral.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/BooleanPropertyExecutor.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/GetExecutor.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/MathUtils.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/NodeUtils.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/SimpleNode.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/Resource.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/ResourceManagerImpl.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/JarHolder.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/JarResourceLoader.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/ResourceLoader.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/StringResourceLoader.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/URLResourceLoader.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/util/StringResource.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/DeprecationAwareExtProperties.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/DuckType.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/ExtProperties.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/StringUtils.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ClassFieldMap.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ClassMap.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ConversionHandler.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/IntrospectorBase.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/IntrospectorCache.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/LinkingUberspector.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/SecureIntrospectorControl.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/TypeConversionHandler.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/UberspectImpl.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/UberspectPublicFields.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/VelMethod.java
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/VelPropertySet.java
Modified: velocity/engine/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/pom.xml?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
--- velocity/engine/trunk/pom.xml (original)
+++ velocity/engine/trunk/pom.xml Mon Mar 11 11:09:53 2019
@@ -49,19 +49,6 @@
<maven.compiler.target>1.8</maven.compiler.target>
</properties>
- <!-- java 8 doclint checks are too strict for our current javadoc state...
-->
- <profiles>
- <profile>
- <id>doclint-java8-disable</id>
- <activation>
- <jdk>[1.8,)</jdk>
- </activation>
- <properties>
- <javadoc.opts>-Xdoclint:none</javadoc.opts>
- </properties>
- </profile>
- </profiles>
-
<build>
<defaultGoal>install</defaultGoal>
<pluginManagement>
@@ -117,7 +104,10 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.0</version>
<configuration>
- <additionalparam>${javadoc.opts}</additionalparam>
+ <!-- full checking is left disabled
+ <doclint>html,missing,reference,syntax</doclint>
+ -->
+ <doclint>none</doclint>
</configuration>
<executions>
<execution>
@@ -125,8 +115,6 @@
<goals>
<goal>aggregate</goal>
</goals>
- <configuration>
- </configuration>
</execution>
</executions>
</plugin>
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/Template.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/Template.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/Template.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/Template.java
Mon Mar 11 11:09:53 2019
@@ -103,7 +103,6 @@ public class Template extends Resource
* from any available source.
* @throws ParseErrorException if template cannot be parsed due
* to syntax (or other) error.
- * @throws IOException problem reading input stream
*/
public boolean process()
throws ResourceNotFoundException, ParseErrorException
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/VelocityEngine.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/VelocityEngine.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/VelocityEngine.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/VelocityEngine.java
Mon Mar 11 11:09:53 2019
@@ -65,6 +65,7 @@ public class VelocityEngine implements R
/**
* Construct a VelocityEngine with the initial properties defined in the
file
* propsFilename
+ * @param propsFilename properties filename
*/
public VelocityEngine(String propsFilename)
{
@@ -73,6 +74,7 @@ public class VelocityEngine implements R
/**
* Construct a VelocityEngine instance with the specified initial
properties.
+ * @param p properties
*/
public VelocityEngine(Properties p)
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/EventCartridge.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/EventCartridge.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/EventCartridge.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/EventCartridge.java
Mon Mar 11 11:09:53 2019
@@ -269,7 +269,9 @@ public class EventCartridge
/**
* Call reference insertion handlers
- *
+ * @param context
+ * @param reference
+ * @param value
* @return value returned by handlers
* @since 2.0
*/
@@ -295,7 +297,11 @@ public class EventCartridge
/**
* Call method exception event handler
- *
+ * @param context
+ * @param claz
+ * @param method
+ * @param e exception
+ * @param info template name, line and column infos
* @return value returned by handler
* @since 2.0
*/
@@ -311,6 +317,10 @@ public class EventCartridge
/**
* Call include event handlers
*
+ * @param context
+ * @param includeResourcePath
+ * @param currentResourcePath
+ * @param directiveName
* @return include path
* @since 2.0
*/
@@ -331,6 +341,11 @@ public class EventCartridge
/**
* Call invalid reference handlers for an invalid getter
*
+ * @param context
+ * @param reference
+ * @param object
+ * @param property
+ * @param info
* @return value returned by handlers
* @since 2.0
*/
@@ -352,6 +367,10 @@ public class EventCartridge
/**
* Call invalid reference handlers for an invalid setter
*
+ * @param context
+ * @param leftreference
+ * @param rightreference
+ * @param info
* @return whether to stop further chaining in the next cartridge
* @since 2.0
*/
@@ -370,6 +389,11 @@ public class EventCartridge
/**
* Call invalid reference handlers for an invalid method call
*
+ * @param context
+ * @param reference
+ * @param object
+ * @param method
+ * @param info
* @return value returned by handlers
* @since 2.0
*/
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/EventHandlerUtil.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/EventHandlerUtil.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/EventHandlerUtil.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/EventHandlerUtil.java
Mon Mar 11 11:09:53 2019
@@ -88,6 +88,7 @@ public class EventHandlerUtil {
* Exception thrown by the method
* @param rsvc current instance of RuntimeServices
* @param context The internal context adapter.
+ * @param info exception location informations
* @return Object to return as method result
* @throws Exception
* to be wrapped and propagated to app
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/implement/IncludeNotFound.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/implement/IncludeNotFound.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/implement/IncludeNotFound.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/event/implement/IncludeNotFound.java
Mon Mar 11 11:09:53 2019
@@ -35,14 +35,11 @@ import org.slf4j.Logger;
*
* <P>By default, the name of the replacement page is "notfound.vm", however
this
* page name can be changed by setting the Velocity property
- * <code>eventhandler.include.notfound</code>, for example:
- * <code>
- * <PRE>
+ * <code>eventhandler.include.notfound</code>, for example:</p>
+ * <pre><code>
* eventhandler.include.notfound = error.vm
- * </PRE>
- * </code>
- * </p><p>
- * The name of the missing resource is put into the Velocity context, under the
+ * </code></pre>
+ * <p>The name of the missing resource is put into the Velocity context, under
the
* key "missingResource", so that the "notfound" template can report the
missing
* resource with a Velocity reference, like:
* <code>$missingResource</code>
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/context/InternalWrapperContext.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/context/InternalWrapperContext.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/context/InternalWrapperContext.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/context/InternalWrapperContext.java
Mon Mar 11 11:09:53 2019
@@ -42,17 +42,24 @@ public interface InternalWrapperContext
InternalContextAdapter getBaseContext();
/**
- * Retrieve the specified key value pair from the given scope.
+ * Place a key value pair into the context.
+ * @param key
+ * @param value
+ * @return previous value
*/
Object put(String key, Object value);
/**
- * Place key value pair into the context of the specified scope.
+ * Retrieve the specified valuefrom the given key.
+ * @param key
+ * @return found value
*/
Object get(String key);
/**
* Tests if the key exists in the specified scope
+ * @param key
+ * @return true if key exists
*/
boolean containsKey(String key);
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/MethodInvocationException.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/MethodInvocationException.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/MethodInvocationException.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/MethodInvocationException.java
Mon Mar 11 11:09:53 2019
@@ -51,10 +51,12 @@ public class MethodInvocationException e
* CTOR - wraps the passed in exception for
* examination later
*
- * @param message
- * @param e Throwable that we are wrapping
- * @param methodName name of method that threw the exception
- * @param templateName The name of the template where the exception
occurred.
+ * @param message
+ * @param e Throwable that we are wrapping
+ * @param methodName name of method that threw the exception
+ * @param templateName The name of the template where the exception
occurred
+ * @param lineNumber line number
+ * @param columnNumber column number
*/
public MethodInvocationException(final String message, final Throwable e,
final String methodName, final String templateName, final int lineNumber, final
int columnNumber)
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/ParseErrorException.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/ParseErrorException.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/ParseErrorException.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/ParseErrorException.java
Mon Mar 11 11:09:53 2019
@@ -86,6 +86,7 @@ public class ParseErrorException extends
* Create a ParseErrorException with the given ParseException.
*
* @param pex the parsing exception
+ * @param templName
* @since 1.5
*/
public ParseErrorException(ParseException pex, String templName)
@@ -133,6 +134,7 @@ public class ParseErrorException extends
* Create a ParseErrorException with the given ParseException.
*
* @param pex the parsing exception
+ * @param templName
* @since 1.5
*/
public ParseErrorException(VelocityException pex, String templName)
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/ResourceNotFoundException.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/ResourceNotFoundException.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/ResourceNotFoundException.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/exception/ResourceNotFoundException.java
Mon Mar 11 11:09:53 2019
@@ -39,6 +39,7 @@ public class ResourceNotFoundException e
private static final long serialVersionUID = -4287732191458420347L;
/**
+ * @param exceptionMessage
* @see VelocityException#VelocityException(String)
*/
public ResourceNotFoundException(final String exceptionMessage)
@@ -47,6 +48,8 @@ public class ResourceNotFoundException e
}
/**
+ * @param exceptionMessage
+ * @param t
* @see VelocityException#VelocityException(String, Throwable)
* @since 1.5
*/
@@ -56,6 +59,7 @@ public class ResourceNotFoundException e
}
/**
+ * @param t
* @see VelocityException#VelocityException(Throwable)
* @since 1.5
*/
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/io/UnicodeInputStream.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/io/UnicodeInputStream.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/io/UnicodeInputStream.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/io/UnicodeInputStream.java
Mon Mar 11 11:09:53 2019
@@ -87,6 +87,8 @@ public class UnicodeInputStream
* Creates a new UnicodeInputStream object. Skips a BOM which defines the
file encoding.
*
* @param inputStream The input stream to use for reading.
+ * @throws IllegalStateException
+ * @throws IOException
*/
public UnicodeInputStream(final InputStream inputStream)
throws IllegalStateException, IOException
@@ -99,6 +101,8 @@ public class UnicodeInputStream
*
* @param inputStream The input stream to use for reading.
* @param skipBOM If this is set to true, a BOM read from the stream is
discarded. This parameter should normally be true.
+ * @throws IllegalStateException
+ * @throws IOException
*/
public UnicodeInputStream(final InputStream inputStream, boolean skipBOM)
throws IllegalStateException, IOException
@@ -145,6 +149,7 @@ public class UnicodeInputStream
* is undefined.
*
* @return The encoding of this streams contents as decided by the BOM or
null if no BOM was found.
+ * @throws IOException
*/
protected String readEncoding()
throws IOException
@@ -261,6 +266,7 @@ public class UnicodeInputStream
}
/**
+ * @throws IOException
* @see java.io.InputStream#close()
*/
public void close()
@@ -270,6 +276,7 @@ public class UnicodeInputStream
}
/**
+ * @throws IOException
* @see java.io.InputStream#available()
*/
public int available()
@@ -279,6 +286,7 @@ public class UnicodeInputStream
}
/**
+ * @param readlimit
* @see java.io.InputStream#mark(int)
*/
public void mark(final int readlimit)
@@ -287,6 +295,7 @@ public class UnicodeInputStream
}
/**
+ * @return mark supported
* @see java.io.InputStream#markSupported()
*/
public boolean markSupported()
@@ -295,6 +304,7 @@ public class UnicodeInputStream
}
/**
+ * @return read char
* @see java.io.InputStream#read()
*/
public int read()
@@ -304,6 +314,8 @@ public class UnicodeInputStream
}
/**
+ * @param b buffer
+ * @return read chars count
* @see java.io.InputStream#read(byte[])
*/
public int read(final byte [] b)
@@ -313,6 +325,10 @@ public class UnicodeInputStream
}
/**
+ * @param b buffer
+ * @param off offset
+ * @param len length
+ * @return reac char
* @see java.io.InputStream#read(byte[], int, int)
*/
public int read(final byte [] b, final int off, final int len)
@@ -331,6 +347,8 @@ public class UnicodeInputStream
}
/**
+ * @param n
+ * @return skipped count
* @see java.io.InputStream#skip(long)
*/
public long skip(final long n)
@@ -342,6 +360,9 @@ public class UnicodeInputStream
/**
* Helper function to compare encodings
+ * @param left
+ * @param right
+ * @return true for same encoding
*/
public static boolean sameEncoding(String left, String right)
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/io/VelocityWriter.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/io/VelocityWriter.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/io/VelocityWriter.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/io/VelocityWriter.java
Mon Mar 11 11:09:53 2019
@@ -103,7 +103,7 @@ public final class VelocityWriter extend
* @param sz Output-buffer size, a positive integer
* @param autoFlush
*
- * @exception IllegalArgumentException If sz is <= 0
+ * @exception IllegalArgumentException If sz is <= 0
*/
public VelocityWriter(Writer writer, int sz, boolean autoFlush)
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeInstance.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeInstance.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeInstance.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeInstance.java
Mon Mar 11 11:09:53 2019
@@ -73,16 +73,16 @@ import java.util.Properties;
import java.util.Set;
/**
- * This is the Runtime system for Velocity. It is the
+ * <p>This is the Runtime system for Velocity. It is the
* single access point for all functionality in Velocity.
* It adheres to the mediator pattern and is the only
* structure that developers need to be familiar with
- * in order to get Velocity to perform.
+ * in order to get Velocity to perform.</p>
*
- * The Runtime will also cooperate with external
+ * <p>The Runtime will also cooperate with external
* systems, which can make all needed setProperty() calls
- * before calling init().
- *
+ * before calling init().</p>
+ * <pre>
* -----------------------------------------------------------------------
* N O T E S O N R U N T I M E I N I T I A L I Z A T I O N
* -----------------------------------------------------------------------
@@ -528,6 +528,7 @@ public class RuntimeInstance implements
/**
* Add all properties contained in the file fileName to the
RuntimeInstance properties
+ * @param fileName
*/
public void setProperties(String fileName)
{
@@ -553,6 +554,7 @@ public class RuntimeInstance implements
/**
* Add all the properties in props to the RuntimeInstance properties
+ * @param props
*/
public void setProperties(Properties props)
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeServices.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeServices.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeServices.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeServices.java
Mon Mar 11 11:09:53 2019
@@ -182,7 +182,6 @@ public interface RuntimeServices
* @throws ParseErrorException The template could not be parsed.
* @throws MethodInvocationException A method on a context object could
not be invoked.
* @throws ResourceNotFoundException A referenced resource could not be
loaded.
- * @throws IOException While rendering to the writer, an I/O problem
occurred.
* @since Velocity 1.6
*/
boolean evaluate(Context context, Writer out,
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeSingleton.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeSingleton.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeSingleton.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeSingleton.java
Mon Mar 11 11:09:53 2019
@@ -38,16 +38,16 @@ import java.util.List;
import java.util.Properties;
/**
- * This is the Runtime system for Velocity. It is the
+ * <p>This is the Runtime system for Velocity. It is the
* single access point for all functionality in Velocity.
* It adheres to the mediator pattern and is the only
* structure that developers need to be familiar with
- * in order to get Velocity to perform.
+ * in order to get Velocity to perform.</p>
*
- * The Runtime will also cooperate with external
+ * <p>The Runtime will also cooperate with external
* systems, which can make all needed setProperty() calls
- * before calling init().
- *
+ * before calling init().</p>
+ * <pre>
* -----------------------------------------------------------------------
* N O T E S O N R U N T I M E I N I T I A L I Z A T I O N
* -----------------------------------------------------------------------
@@ -419,6 +419,7 @@ public class RuntimeSingleton implements
* @param macroArgs Array of macro arguments, containing the
* #macro() arguments and default values. the 0th is the name.
* @param definingTemplate Template containing the definition of the macro.
+ * @return true for success
*/
public static boolean addVelocimacro(String name, Node macro,
List<Macro.MacroArg> macroArgs,
Template definingTemplate)
@@ -501,7 +502,7 @@ public class RuntimeSingleton implements
/**
* Directly set the ExtProperties configuration object
- *
+ * @param configuration
* @see RuntimeInstance#setConfiguration(ExtProperties)
*/
public static void setConfiguration(ExtProperties configuration)
@@ -509,7 +510,6 @@ public class RuntimeSingleton implements
ri.setConfiguration(configuration);
}
-
/**
* Return the velocity runtime configuration object.
*
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/VelocimacroManager.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/VelocimacroManager.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/VelocimacroManager.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/VelocimacroManager.java
Mon Mar 11 11:09:53 2019
@@ -293,6 +293,7 @@ public class VelocimacroManager
}
/**
+ * @param is
* @since 1.6
*/
public void setInlineReplacesGlobal(boolean is)
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Block.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Block.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Block.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Block.java
Mon Mar 11 11:09:53 2019
@@ -51,6 +51,7 @@ public abstract class Block extends Dire
/**
* Return type of this directive.
+ * @return type, DirectiveConstants.BLOCK or DirectiveConstants.LINE
*/
public int getType()
{
@@ -59,6 +60,9 @@ public abstract class Block extends Dire
/**
* simple init - get the key
+ * @param rs
+ * @param context
+ * @param node
*/
public void init(RuntimeServices rs, InternalContextAdapter context, Node
node)
throws TemplateInitException
@@ -74,6 +78,12 @@ public abstract class Block extends Dire
block = node.jjtGetChild(node.jjtGetNumChildren() - 1);
}
+ /**
+ * renders block directive
+ * @param context
+ * @param writer
+ * @return success status
+ */
public boolean render(InternalContextAdapter context, Writer writer)
{
preRender(context);
@@ -106,6 +116,8 @@ public abstract class Block extends Dire
* Creates a string identifying the source and location of the block
* definition, and the current template being rendered if that is
* different.
+ * @param context
+ * @return id string
*/
protected String id(InternalContextAdapter context)
{
@@ -129,6 +141,10 @@ public abstract class Block extends Dire
private Block parent;
private int depth;
+ /**
+ * @param context
+ * @param parent
+ */
public Reference(InternalContextAdapter context, Block parent)
{
this.context = context;
@@ -137,6 +153,9 @@ public abstract class Block extends Dire
/**
* Render the AST of this block into the writer using the context.
+ * @param context
+ * @param writer
+ * @return success status
*/
public boolean render(InternalContextAdapter context, Writer writer)
{
@@ -164,12 +183,16 @@ public abstract class Block extends Dire
/**
* Makes #if( $blockRef ) true without rendering, so long as we aren't
beyond max depth.
+ * @return reference value as boolean
*/
public boolean getAsBoolean()
{
return depth <= parent.maxDepth;
}
+ /**
+ * @return rendered string
+ */
public String toString()
{
Writer writer = new StringBuilderWriter();
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/BlockMacro.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/BlockMacro.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/BlockMacro.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/BlockMacro.java
Mon Mar 11 11:09:53 2019
@@ -81,6 +81,7 @@ public class BlockMacro extends Block
* Initializes the directive.
*
* @param rs
+ * @param macroName
* @param context
* @param node
* @throws TemplateInitException
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Directive.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Directive.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Directive.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Directive.java
Mon Mar 11 11:09:53 2019
@@ -85,6 +85,7 @@ public abstract class Directive implemen
* Allows the template location to be set.
* @param line
* @param column
+ * @param template
*/
public void setLocation(int line, int column, Template template)
{
@@ -173,6 +174,7 @@ public abstract class Directive implemen
* for example ParserTreeConstants.JJTWORD
* @param t token of directive
* @param templateName the name of the template this directive is
referenced in.
+ * @throws ParseException
*/
public void checkArgs(ArrayList<Integer> argtypes, Token t, String
templateName)
throws ParseException
@@ -199,6 +201,7 @@ public abstract class Directive implemen
/**
* This creates and places the scope control for this directive
* into the context (if scope provision is turned on).
+ * @param context
*/
protected void preRender(InternalContextAdapter context)
{
@@ -210,6 +213,10 @@ public abstract class Directive implemen
}
}
+ /**
+ * @param prev
+ * @return scope
+ */
protected Scope makeScope(Object prev)
{
return new Scope(this, prev);
@@ -218,6 +225,7 @@ public abstract class Directive implemen
/**
* This cleans up any scope control for this directive after rendering,
* assuming the scope control was turned on.
+ * @param context
*/
protected void postRender(InternalContextAdapter context)
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Foreach.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Foreach.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Foreach.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Foreach.java
Mon Mar 11 11:09:53 2019
@@ -153,6 +153,9 @@ public class Foreach extends Directive
* are set locally or not. So, those in favor of VELOCITY-285, can
* make that happen easily by overriding this and having it use
* context.localPut(k,v). See VELOCITY-630 for more on this.
+ * @param context
+ * @param key
+ * @param value
*/
protected void put(InternalContextAdapter context, String key, Object
value)
{
@@ -161,6 +164,9 @@ public class Foreach extends Directive
/**
* Retrieve the contextual iterator.
+ * @param iterable
+ * @param node
+ * @return iterator
*/
protected Iterator getIterator(Object iterable, Node node)
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/RuntimeMacro.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/RuntimeMacro.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/RuntimeMacro.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/RuntimeMacro.java
Mon Mar 11 11:09:53 2019
@@ -118,6 +118,7 @@ public class RuntimeMacro extends Direct
* just save the values to use at the render time.
*
* @param rs runtime services
+ * @param name macro name
* @param context InternalContextAdapter
* @param node node containing the macro call
*/
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Scope.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Scope.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Scope.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Scope.java
Mon Mar 11 11:09:53 2019
@@ -41,6 +41,10 @@ public class Scope extends AbstractMap
private Info info;
protected final Object owner;
+ /**
+ * @param owner
+ * @param previous
+ */
public Scope(Object owner, Object previous)
{
this.owner = owner;
@@ -66,11 +70,19 @@ public class Scope extends AbstractMap
return storage;
}
+ /**
+ * @return entry set
+ */
public Set entrySet()
{
return getStorage().entrySet();
}
+ /**
+ * getter
+ * @param key
+ * @return found value
+ */
@Override
public Object get(Object key)
{
@@ -82,6 +94,12 @@ public class Scope extends AbstractMap
return o;
}
+ /**
+ * setter
+ * @param key
+ * @param value
+ * @return previous value
+ */
@Override
public Object put(Object key, Object value)
{
@@ -92,6 +110,9 @@ public class Scope extends AbstractMap
* Convenience method to call put(key,val) in a template
* without worrying about what is returned/rendered by the call.
* This should ALWAYS return an empty string.
+ * @param key
+ * @param value
+ * @return empty string
*/
public String set(Object key, Object value)
{
@@ -112,6 +133,7 @@ public class Scope extends AbstractMap
* that are stacked up. This is the distance between this
* instance and the topmost instance, plus one. This value
* will never be negative or zero.
+ * @return depth
*/
protected int getDepth()
{
@@ -125,6 +147,7 @@ public class Scope extends AbstractMap
/**
* Returns the topmost parent control reference, retrieved
* by simple recursion on {@link #getParent}.
+ * @return top-most scope
*/
public Scope getTopmost()
{
@@ -138,6 +161,7 @@ public class Scope extends AbstractMap
/**
* Returns the parent control reference overridden by the placement
* of this instance in the context.
+ * @return parent scope
*/
public Scope getParent()
{
@@ -149,6 +173,7 @@ public class Scope extends AbstractMap
* of this instance in the context. If there was none (as is hoped),
* then this will return null. This never returns parent controls;
* those are returned by {@link #getParent}.
+ * @return replaced reference value, or null
*/
public Object getReplaced()
{
@@ -161,6 +186,7 @@ public class Scope extends AbstractMap
/**
* Returns info about the current scope for debugging purposes.
+ * @return template debugging infos
*/
public Info getInfo()
{
@@ -181,6 +207,11 @@ public class Scope extends AbstractMap
private Directive directive;
private Template template;
+ /**
+ * c'tor
+ * @param scope
+ * @param owner
+ */
public Info(Scope scope, Object owner)
{
if (owner instanceof Directive)
@@ -194,6 +225,10 @@ public class Scope extends AbstractMap
this.scope = scope;
}
+ /**
+ * name getter
+ * @return name
+ */
public String getName()
{
if (directive != null)
@@ -207,6 +242,10 @@ public class Scope extends AbstractMap
return null;
}
+ /**
+ * type getter
+ * @return scope type
+ */
public String getType()
{
if (directive != null)
@@ -226,11 +265,19 @@ public class Scope extends AbstractMap
return null;
}
+ /**
+ * current depth
+ * @return depth
+ */
public int getDepth()
{
return scope.getDepth();
}
+ /**
+ * template name getter
+ * @return template name
+ */
public String getTemplate()
{
if (directive != null)
@@ -244,6 +291,10 @@ public class Scope extends AbstractMap
return null;
}
+ /**
+ * line getter
+ * @return line number
+ */
public int getLine()
{
if (directive != null)
@@ -253,6 +304,10 @@ public class Scope extends AbstractMap
return 0;
}
+ /**
+ * column getter
+ * @return column number
+ */
public int getColumn()
{
if (directive != null)
@@ -262,6 +317,10 @@ public class Scope extends AbstractMap
return 0;
}
+ /**
+ * string representation getter
+ * @return string representation
+ */
public String toString()
{
StringBuilder sb = new StringBuilder();
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/VelocimacroProxy.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/VelocimacroProxy.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/VelocimacroProxy.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/VelocimacroProxy.java
Mon Mar 11 11:09:53 2019
@@ -112,6 +112,7 @@ public class VelocimacroProxy extends Di
/**
* Return the list of macro arguments associated with this macro
+ * @return macro arguments
*/
public List<Macro.MacroArg> getMacroArgs()
{
@@ -128,7 +129,6 @@ public class VelocimacroProxy extends Di
/**
* returns the number of ars needed for this VM
- *
* @return The number of ars needed for this VM
*/
public int getNumArgs()
@@ -138,6 +138,7 @@ public class VelocimacroProxy extends Di
/**
* Initialize members of VelocimacroProxy. called from MacroEntry
+ * @param rs runtime services
*/
public void init(RuntimeServices rs)
{
@@ -156,6 +157,14 @@ public class VelocimacroProxy extends Di
preserveArgumentsLiterals =
rsvc.getBoolean(RuntimeConstants.VM_PRESERVE_ARGUMENTS_LITERALS, false);
}
+ /**
+ * Render the macro AST node
+ * @param context
+ * @param writer
+ * @param node
+ * @return success status
+ * @throws IOException
+ */
public boolean render(InternalContextAdapter context, Writer writer, Node
node)
throws IOException
{
@@ -259,6 +268,8 @@ public class VelocimacroProxy extends Di
/**
* Check whether the number of arguments given matches the number defined.
+ * @param node
+ * @param callArgNum
*/
protected void checkArgumentCount(Node node, int callArgNum)
{
@@ -280,6 +291,7 @@ public class VelocimacroProxy extends Di
/**
* check that we aren't already at the max call depth and throws
* a MacroOverflowException if we are there.
+ * @param context
*/
protected void checkDepth(InternalContextAdapter context)
{
@@ -316,6 +328,10 @@ public class VelocimacroProxy extends Di
* the argument names. Store and return an array of old and new values
* paired for each argument name, for later cleanup. Also, put literal
* representations of arguments which evaluate to null in the context.
+ * @param context
+ * @param node
+ * @param callArgNum
+ * @return macro arguments values
*/
protected Object[] handleArgValues(InternalContextAdapter context,
Node node, int callArgNum)
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/CharStream.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/CharStream.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/CharStream.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/CharStream.java
Mon Mar 11 11:09:53 2019
@@ -34,81 +34,94 @@ package org.apache.velocity.runtime.pars
* operation.
*/
-public interface CharStream {
-
- /**
- * Returns the next character from the selected input. The method
- * of selecting the input is the responsibility of the class
- * implementing this interface. Can throw any java.io.IOException.
- */
- char readChar() throws java.io.IOException;
-
- /**
- * Returns the column number of the last character for current token (being
- * matched after the last call to BeginTOken).
- */
- int getEndColumn();
-
- /**
- * Returns the line number of the last character for current token (being
- * matched after the last call to BeginTOken).
- */
- int getEndLine();
-
- /**
- * Returns the column number of the first character for current token (being
- * matched after the last call to BeginTOken).
- */
- int getBeginColumn();
-
- /**
- * Returns the line number of the first character for current token (being
- * matched after the last call to BeginTOken).
- */
- int getBeginLine();
-
- /**
- * Backs up the input stream by amount steps. Lexer calls this method if it
- * had already read some characters, but could not use them to match a
- * (longer) token. So, they will be used again as the prefix of the next
- * token and it is the implemetation's responsibility to do this right.
- */
- void backup(int amount);
-
- /**
- * Returns the next character that marks the beginning of the next token.
- * All characters must remain in the buffer between two successive calls
- * to this method to implement backup correctly.
- */
- char BeginToken() throws java.io.IOException;
-
- /**
- * Returns a string made up of characters from the marked token beginning
- * to the current buffer position. Implementations have the choice of
returning
- * anything that they want to. For example, for efficiency, one might decide
- * to just return null, which is a valid implementation.
- */
- String GetImage();
-
- /**
- * Returns an array of characters that make up the suffix of length 'len' for
- * the currently matched token. This is used to build up the matched string
- * for use in actions in the case of MORE. A simple and inefficient
- * implementation of this is as follows :
- *
- * {
- * String t = GetImage();
- * return t.substring(t.length() - len, t.length()).toCharArray();
- * }
- */
- char[] GetSuffix(int len);
-
- /**
- * The lexer calls this function to indicate that it is done with the stream
- * and hence implementations can free any resources held by this class.
- * Again, the body of this function can be just empty and it will not
- * affect the lexer's operation.
- */
- void Done();
+public interface CharStream
+{
+ /**
+ * Returns the next character from the selected input. The method
+ * of selecting the input is the responsibility of the class
+ * implementing this interface. Can throw any java.io.IOException.
+ * @return read char
+ * @throws java.io.IOException
+ */
+ char readChar() throws java.io.IOException;
+
+ /**
+ * Returns the column number of the last character for current token (being
+ * matched after the last call to BeginTOken).
+ * @return ending column number
+ */
+ int getEndColumn();
+
+ /**
+ * Returns the line number of the last character for current token (being
+ * matched after the last call to BeginTOken).
+ * @return ending line number
+ */
+ int getEndLine();
+
+ /**
+ * Returns the column number of the first character for current token (being
+ * matched after the last call to BeginTOken).
+ * @return starting column number
+ */
+ int getBeginColumn();
+
+ /**
+ * Returns the line number of the first character for current token (being
+ * matched after the last call to BeginTOken).
+ * @return starting line number
+ */
+ int getBeginLine();
+
+ /**
+ * Backs up the input stream by amount steps. Lexer calls this method if it
+ * had already read some characters, but could not use them to match a
+ * (longer) token. So, they will be used again as the prefix of the next
+ * token and it is the implemetation's responsibility to do this right.
+ * @param amount
+ */
+ void backup(int amount);
+
+ /**
+ * Returns the next character that marks the beginning of the next token.
+ * All characters must remain in the buffer between two successive calls
+ * to this method to implement backup correctly.
+ * @return next token start char
+ * @throws java.io.IOException
+ */
+ char BeginToken() throws java.io.IOException;
+
+ /**
+ * Returns a string made up of characters from the marked token beginning
+ * to the current buffer position. Implementations have the choice of
returning
+ * anything that they want to. For example, for efficiency, one might decide
+ * to just return null, which is a valid implementation.
+ * @return token image
+ */
+ String GetImage();
+
+ /**
+ * <p>Returns an array of characters that make up the suffix of length
'len' for
+ * the currently matched token. This is used to build up the matched string
+ * for use in actions in the case of MORE. A simple and inefficient
+ * implementation of this is as follows :</p>
+ * <pre><code>
+ * {
+ * String t = GetImage();
+ * return t.substring(t.length() - len, t.length()).toCharArray();
+ * }
+ * </code></pre>
+ * @param len suffix len
+ * @return suffix
+ */
+ char[] GetSuffix(int len);
+
+ /**
+ * The lexer calls this function to indicate that it is done with the stream
+ * and hence implementations can free any resources held by this class.
+ * Again, the body of this function can be just empty and it will not
+ * affect the lexer's operation.
+ */
+ void Done();
}
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/ParseException.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/ParseException.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/ParseException.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/ParseException.java
Mon Mar 11 11:09:53 2019
@@ -36,7 +36,7 @@ public class ParseException extends Exce
private static final long serialVersionUID = -309603325673449381L;
/**
- * This constructor is used by the method "generateParseException"
+ * <p>This constructor is used by the method "generateParseException"
* in the generated parser. Calling this constructor generates
* a new object of this type with the fields "currentToken",
* "expectedTokenSequences", and "tokenImage" set. The boolean
@@ -44,8 +44,13 @@ public class ParseException extends Exce
* this constructor was used to create this object.
* This constructor calls its super class with the empty string
* to force the "toString" method of parent class "Throwable" to
- * print the error message in the form:
- * ParseException: <result of getMessage>
+ * print the error message in the form:</p>
+ * <pre>
+ * ParseException: <result of getMessage>
+ * </pre>
+ * @param currentTokenVal
+ * @param expectedTokenSequencesVal
+ * @param tokenImageVal
*/
public ParseException(Token currentTokenVal,
int[][] expectedTokenSequencesVal,
@@ -68,12 +73,21 @@ public class ParseException extends Exce
* relevant information. The JavaCC generated code does not use
* these constructors.
*/
-
public ParseException() {
super();
specialConstructor = false;
}
+ /**
+ * The following constructors are for use by you for whatever
+ * purpose you can think of. Constructing the exception in this
+ * manner makes the exception behave in the normal way - i.e., as
+ * documented in the class "Throwable". The fields "errorToken",
+ * "expectedTokenSequences", and "tokenImage" do not contain
+ * relevant information. The JavaCC generated code does not use
+ * these constructors.
+ * @param message
+ */
public ParseException(String message) {
super(message);
specialConstructor = false;
@@ -116,6 +130,7 @@ public class ParseException extends Exce
* 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 message
*/
public String getMessage() {
if (!specialConstructor) {
@@ -170,6 +185,8 @@ public class ParseException extends Exce
* Used to convert raw characters to their escaped version
* when these raw version cannot be used as part of an ASCII
* string literal.
+ * @param str raw characters
+ * @return escaped string
*/
protected String add_escapes(String str) {
StringBuilder retval = new StringBuilder();
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/TemplateParseException.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/TemplateParseException.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/TemplateParseException.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/TemplateParseException.java
Mon Mar 11 11:09:53 2019
@@ -60,7 +60,7 @@ public class TemplateParseException
}
/**
- * This constructor is used by the method "generateParseException"
+ * <p>This constructor is used by the method "generateParseException"
* in the generated parser. Calling this constructor generates
* a new object of this type with the fields "currentToken",
* "expectedTokenSequences", and "tokenImage" set. The boolean
@@ -68,8 +68,10 @@ public class TemplateParseException
* this constructor was used to create this object.
* This constructor calls its super class with the empty string
* to force the "toString" method of parent class "Throwable" to
- * print the error message in the form:
- * ParseException: <result of getMessage>
+ * print the error message in the form:</p>
+ * <pre>
+ * ParseException: <result of getMessage>
+ * </pre>
* @param currentTokenVal
* @param expectedTokenSequencesVal
* @param tokenImageVal
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTAndNode.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTAndNode.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTAndNode.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTAndNode.java
Mon Mar 11 11:09:53 2019
@@ -80,9 +80,11 @@ public class ASTAndNode extends ASTLogic
/**
* logical and :
- * null && right = false
- * left && null = false
- * null && null = false
+ * <pre>
+ * null && right = false
+ * left && null = false
+ * null && null = false
+ * </pre>
* @param context
* @return True if both sides are true.
* @throws MethodInvocationException
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTComparisonNode.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTComparisonNode.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTComparisonNode.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTComparisonNode.java
Mon Mar 11 11:09:53 2019
@@ -84,6 +84,9 @@ public abstract class ASTComparisonNode
/**
* Always false by default, != and == subclasses must override this.
+ * @param left
+ * @param right
+ * @return comparison result
*/
public boolean compareNull(Object left, Object right)
{
@@ -101,6 +104,12 @@ public abstract class ASTComparisonNode
return false;
}
+ /**
+ * compare numbers
+ * @param left
+ * @param right
+ * @return comparison result
+ */
public Boolean compareNumbers(Object left, Object right)
{
try
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTIndex.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTIndex.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTIndex.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTIndex.java
Mon Mar 11 11:09:53 2019
@@ -61,16 +61,29 @@ public class ASTIndex extends SimpleNode
*/
protected boolean strictRef = false;
+ /**
+ * @param i
+ */
public ASTIndex(int i)
{
super(i);
}
+ /**
+ * @param p
+ * @param i
+ */
public ASTIndex(Parser p, int i)
{
super(p, i);
}
+ /**
+ * @param context
+ * @param data
+ * @return data
+ * @throws TemplateInitException
+ */
public Object init(InternalContextAdapter context, Object data)
throws TemplateInitException
{
@@ -80,17 +93,19 @@ public class ASTIndex extends SimpleNode
return data;
}
-
-
private final static Object[] noParams = {};
private final static Class[] noTypes = {};
+
/**
* If argument is an Integer and negative, then return (o.size() -
argument).
* Otherwise return the original argument. We use this to calculate the
true
* index of a negative index e.g., $foo[-1]. If no size() method is found
on the
* 'o' object, then we throw an VelocityException.
+ * @param argument
+ * @param o
* @param context Used to access the method cache.
* @param node ASTNode used for error reporting.
+ * @return found object
*/
public static Object adjMinusIndexArg(Object argument, Object o,
InternalContextAdapter context, SimpleNode node)
@@ -141,6 +156,12 @@ public class ASTIndex extends SimpleNode
return argument;
}
+ /**
+ * @param o
+ * @param context
+ * @return object value
+ * @throws MethodInvocationException
+ */
public Object execute(Object o, InternalContextAdapter context)
throws MethodInvocationException
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTMathNode.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTMathNode.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTMathNode.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTMathNode.java
Mon Mar 11 11:09:53 2019
@@ -137,6 +137,10 @@ public abstract class ASTMathNode extend
* Extension hook to allow special behavior by subclasses
* If this method returns a non-null value, that is returned,
* rather than the result of the math operation.
+ * @param left
+ * @param right
+ * @param context
+ * @return special value
* @see ASTAddNode#handleSpecial
*/
protected Object handleSpecial(Object left, Object right,
InternalContextAdapter context)
@@ -147,6 +151,11 @@ public abstract class ASTMathNode extend
/**
* Performs the math operation represented by this node.
+ * @param left
+ * @param right
+ * @param context
+ * @return computed value
+ * @see ASTAddNode#perform(Number, Number, InternalContextAdapter)
*/
public abstract Number perform(Number left, Number right,
InternalContextAdapter context);
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTOrNode.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTOrNode.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTOrNode.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTOrNode.java
Mon Mar 11 11:09:53 2019
@@ -80,11 +80,12 @@ public class ASTOrNode extends ASTLogica
/**
* the logical or :
- * the rule :
- * left || null -> left
- * null || right -> right
- * null || null -> false
- * left || right -> left || right
+ * <pre>
+ * left || null -> left
+ * null || right -> right
+ * null || null -> false
+ * left || right -> left || right
+ * </pre>
* @param context
* @return The evaluation result.
* @throws MethodInvocationException
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTReference.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTReference.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTReference.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTReference.java
Mon Mar 11 11:09:53 2019
@@ -95,7 +95,7 @@ public class ASTReference extends Simple
/**
* Indicates if we are using modified escape behavior in strict mode.
- * mainly we allow \$abc -> to render as $abc
+ * mainly we allow \$abc -> to render as $abc
*/
public boolean strictEscape = false;
@@ -640,6 +640,8 @@ public class ASTReference extends Simple
/**
* Utility class to handle nulls when printing a class type
+ * @param clazz
+ * @return class name, or the string "null"
*/
public static String printClass(Class clazz)
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTStringLiteral.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTStringLiteral.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTStringLiteral.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/ASTStringLiteral.java
Mon Mar 11 11:09:53 2019
@@ -178,6 +178,7 @@ public class ASTStringLiteral extends Si
* that the line and column position reported reflects the error position
* within the template and not just relative to the error position within
* the string literal.
+ * @param node
*/
public void adjTokenLineNums(Node node)
{
@@ -238,6 +239,8 @@ public class ASTStringLiteral extends Si
}
/**
+ * @param string
+ * @return unescaped string
* @since 1.6
*/
public static String unescape(final String string)
@@ -271,6 +274,9 @@ public class ASTStringLiteral extends Si
/**
+ * @param visitor
+ * @param data
+ * @return rendered object
* @see
org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.node.ParserVisitor,
* java.lang.Object)
*/
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/BooleanPropertyExecutor.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/BooleanPropertyExecutor.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/BooleanPropertyExecutor.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/BooleanPropertyExecutor.java
Mon Mar 11 11:09:53 2019
@@ -26,12 +26,12 @@ import org.slf4j.Logger;
/**
* Handles discovery and valuation of a
* boolean object property, of the
- * form public boolean is<property> when executed.
+ * form public boolean is<property> when executed.
*
* We do this separately as to preserve the current
- * quasi-broken semantics of get<as is property>
- * get< flip 1st char> get("property") and now followed
- * by is<Property>
+ * quasi-broken semantics of get<as is property>
+ * get<flip 1st char> get("property") and now followed
+ * by is<Property>
*
* @author <a href="[email protected]">Geir Magnusson Jr.</a>
* @version $Id$
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/GetExecutor.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/GetExecutor.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/GetExecutor.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/GetExecutor.java
Mon Mar 11 11:09:53 2019
@@ -71,6 +71,7 @@ public class GetExecutor extends Abstrac
}
/**
+ * @param clazz
* @since 1.5
*/
protected void discover(final Class clazz)
@@ -106,6 +107,8 @@ public class GetExecutor extends Abstrac
}
/**
+ * @param o
+ * @return value
* @see
org.apache.velocity.runtime.parser.node.AbstractExecutor#execute(java.lang.Object)
*/
public Object execute(final Object o)
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/MathUtils.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/MathUtils.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/MathUtils.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/MathUtils.java
Mon Mar 11 11:09:53 2019
@@ -461,7 +461,7 @@ public abstract class MathUtils
* Compare two numbers.
* @param op1
* @param op2
- * @return 1 if n1 > n2, -1 if n1 < n2 and 0 if equal.
+ * @return 1 if n1 > n2, -1 if n1 < n2 and 0 if equal.
*/
public static int compare (Number op1, Number op2) {
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/NodeUtils.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/NodeUtils.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/NodeUtils.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/NodeUtils.java
Mon Mar 11 11:09:53 2019
@@ -32,7 +32,7 @@ import org.apache.velocity.runtime.parse
public class NodeUtils
{
/**
- * Collect all the <SPECIAL_TOKEN>s that
+ * Collect all the <SPECIAL_TOKEN>s that
* are carried along with a token. Special
* tokens do not participate in parsing but
* can still trigger certain lexical actions.
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/SimpleNode.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/SimpleNode.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/SimpleNode.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/parser/node/SimpleNode.java
Mon Mar 11 11:09:53 2019
@@ -328,6 +328,8 @@ public class SimpleNode implements Node
/**
* Return a string that tells the current location of this node.
+ * @param context
+ * @return location
*/
protected String getLocation(InternalContextAdapter context)
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/Resource.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/Resource.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/Resource.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/Resource.java
Mon Mar 11 11:09:53 2019
@@ -275,6 +275,7 @@ public abstract class Resource
/**
* Sets the type of this Resource (RESOURCE_TEMPLATE or RESOURCE_CONTENT)
+ * @param type RESOURCE_TEMPLATE or RESOURCE_CONTENT
* @since 1.6
*/
public void setType(int type)
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/ResourceManagerImpl.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/ResourceManagerImpl.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/ResourceManagerImpl.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/ResourceManagerImpl.java
Mon Mar 11 11:09:53 2019
@@ -479,7 +479,7 @@ public class ResourceManagerImpl
*
* @param resource resource to refresh
* @param encoding character encoding of the resource to refresh.
- *
+ * @return resource
* @throws ResourceNotFoundException if template not found from current
source for this Resource
* @throws ParseErrorException if template cannot be parsed due to
syntax (or other) error.
*/
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.java
Mon Mar 11 11:09:53 2019
@@ -499,6 +499,7 @@ public class DataSourceResourceLoader ex
* @param tableName table to fetch from
* @param keyColumn column whose value should match templateName
* @return PreparedStatement
+ * @throws SQLException
*/
protected PreparedStatement prepareStatement(
final Connection conn,
@@ -531,6 +532,11 @@ public class DataSourceResourceLoader ex
/**
* Gets a reader from a result set's column
+ * @param resultSet
+ * @param column
+ * @param encoding
+ * @return reader
+ * @throws SQLException
*/
protected Reader getReader(ResultSet resultSet, String column, String
encoding)
throws SQLException
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/JarHolder.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/JarHolder.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/JarHolder.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/JarHolder.java
Mon Mar 11 11:09:53 2019
@@ -51,6 +51,7 @@ public class JarHolder
/**
* @param rs
* @param urlpath
+ * @param log
*/
public JarHolder( RuntimeServices rs, String urlpath, Logger log )
{
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/JarResourceLoader.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/JarResourceLoader.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/JarResourceLoader.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/JarResourceLoader.java
Mon Mar 11 11:09:53 2019
@@ -45,17 +45,16 @@ import java.util.Map;
* The configuration of the JarResourceLoader is straightforward -
* You simply add the JarResourceLoader to the configuration via
* </p>
- * <p><pre>
+ * <pre><code>
* resource.loaders = jar
* resource.loader.jar.class =
org.apache.velocity.runtime.resource.loader.JarResourceLoader
* resource.loader.jar.path = list of JAR <URL>s
- * </pre></p>
+ * </code></pre>
*
- * <p> So for example, if you had a jar file on your local filesystem, you
could simply do
- * <pre>
+ * <p> So for example, if you had a jar file on your local filesystem, you
could simply do</p>
+ * <pre><code>
* resource.loader.jar.path = jar:file:/opt/myfiles/jar1.jar
- * </pre>
- * </p>
+ * </code></pre>
* <p> Note that jar specification for the <code>.path</code> configuration
property
* conforms to the same rules for the java.net.JarUrlConnection class.
* </p>
Modified:
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/ResourceLoader.java
URL:
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/ResourceLoader.java?rev=1855206&r1=1855205&r2=1855206&view=diff
==============================================================================
---
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/ResourceLoader.java
(original)
+++
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/ResourceLoader.java
Mon Mar 11 11:09:53 2019
@@ -142,6 +142,7 @@ public abstract class ResourceLoader
* to create a template.
*
* @param source
+ * @param encoding
* @return The reader for the requested resource.
* @throws ResourceNotFoundException
* @since 2.0
@@ -277,7 +278,8 @@ public abstract class ResourceLoader
* @param rawStream The raw input stream.
* @param encoding The asked encoding.
* @return found reader
- * @throws IOException, UnsupportedEncodingException
+ * @throws IOException
+ * @throws UnsupportedEncodingException
* @since 2.0
*/
protected Reader buildReader(InputStream rawStream, String encoding)
