diff --git a/voila-runtime-oawtemplate/src/main/java/it/mice/voila/runtime/oawtemplate/utils/EscapeUtils.java b/voila-runtime-oawtemplate/src/main/java/it/mice/voila/runtime/oawtemplate/utils/EscapeUtils.java index de093dfa08eef78f62b679e3d8629a9faa55d8ec..906df4d71726891a043733edb721e51adcf9e86b 100644 --- a/voila-runtime-oawtemplate/src/main/java/it/mice/voila/runtime/oawtemplate/utils/EscapeUtils.java +++ b/voila-runtime-oawtemplate/src/main/java/it/mice/voila/runtime/oawtemplate/utils/EscapeUtils.java @@ -19,7 +19,7 @@ import org.w3c.dom.Text; shouldn't need to directly use the services of this class very often.
For Model Objects containing free form user input, - it is highly recommended that you use {@link SafeText}, not String. + it is highly recommended that you use {SafeText}, not String. Free form user input is open to malicious use, such as Cross Site Scripting attacks. @@ -29,11 +29,11 @@ import org.w3c.dom.Text;
The following WEB4J classes will automatically escape special characters for you, when needed :
The following characters are replaced with corresponding HTML character entities : -
Character | Replacement |
---|---|
< | < |
> | > |
& | & |
" | " |
\t | |
! | ! |
# | # |
$ | $ |
% | % |
' | ' |
( | ( |
) | ) |
* | * |
+ | + |
, | , |
- | - |
. | . |
/ | / |
: | : |
; | ; |
= | = |
? | ? |
@ | @ |
[ | [ |
\ | \ |
] | ] |
^ | ^ |
_ | _ |
` | ` |
{ | { |
| | | |
} | } |
~ | ~ |
< | {@code < } |
> | {@code > } |
& | {@code & } |
" | {@code "} |
! | {@code !} |
# | {@code #} |
$ | {@code $} |
% | {@code %} |
' | {@code '} |
( | {@code (} |
) | {@code )} |
* | {@code *} |
+ | {@code +} |
, | {@code ,} |
- | {@code -} |
. | {@code .} |
/ | {@code /} |
: | {@code :} |
; | {@code ;} |
= | {@code =} |
? | {@code ?} |
@ | {@code @} |
[ | {@code [} |
\ | {@code \} |
] | {@code ]} |
^ | {@code ^} |
_ | {@code _} |
` | {@code `} |
{ | {@code {} |
| | {@code |} |
} | {@code }} |
~ | {@code ~} |
Note that JSTL's {@code Replaces all '&' characters with '&'.
+ Replaces all '&' characters with '{@code &}'.
An ampersand character may appear in the query string of a URL.
The ampersand character is indeed valid in a URL.
@@ -216,14 +218,19 @@ public class EscapeUtils {
such attributes have the additional constraint that ampersands
must be escaped.
- The JSTL The JSTL tag does indeed perform proper URL encoding of
query parameters. But it does not, in general, produce text which
is valid as an HREF attribute, simply because it does
not escape the ampersand character. This is a nuisance when
multiple query parameters appear in the URL, since it requires a little
extra work.
- */
- public static String forHrefAmpersand(String aURL){
+
+ /**
+ * @param aURL the aURL.
+ * @return the result.
+ */
+
+public static String forHrefAmpersand(String aURL){
return aURL.replace("&", "&");
}
@@ -237,8 +244,12 @@ public class EscapeUtils {
attribute, then there are two issues - ensuring the query string is valid HTTP
(it is URL-encoded), and ensuring it is valid HTML (ensuring the
ampersand is escaped).
- */
- public static String forURL(String aURLFragment){
+
+ /**
+ * @param aURLFragment the aURLFragment.
+ * @return the result.
+ */
+public static String forURL(String aURLFragment){
String result = null;
try {
result = URLEncoder.encode(aURLFragment, "UTF-8");
@@ -253,21 +264,24 @@ public class EscapeUtils {
Escape characters for text appearing as XML data, between tags.
The following characters are replaced with corresponding character entities :
- Note that JSTL's {@code The following commonly used control characters are escaped :
- See RFC 4627 for more information.
- */
- public static String forJSON(String aText){
+
+ /**
+ * @param aText the aText.
+ * @return the result.
+ */
+public static String forJSON(String aText){
final StringBuilder result = new StringBuilder();
StringCharacterIterator iterator = new StringCharacterIterator(aText);
char character = iterator.current();
@@ -357,10 +375,13 @@ public class EscapeUtils {
}
/**
- Return aText with all '<' and '>' characters
+ Return aText with all '<' and '>' characters
replaced by their escaped equivalents.
- */
- public static String toDisableTags(String aText){
+
+ * @param aText the aText.
+ * @return the result.
+ */
+public static String toDisableTags(String aText){
final StringBuilder result = new StringBuilder();
final StringCharacterIterator iterator = new StringCharacterIterator(aText);
char character = iterator.current();
@@ -391,13 +412,16 @@ public class EscapeUtils {
If replacement text can contain arbitrary characters, then you
will usually need to escape that text, to ensure special characters
are interpreted literally.
- */
+ *
+ * @param aInput the aInput.
+ * @return the result.
+ */
public static String forReplacementString(String aInput){
return Matcher.quoteReplacement(aInput);
}
@@ -490,8 +517,10 @@ public class EscapeUtils {
Disable all SCRIPT tags in aText.
Insensitive to case.
- */
- public static String forScriptTagsOnly(String aText){
+ * @param aText the aText.
+ * @return the result.
+ */
+public static String forScriptTagsOnly(String aText){
String result = null;
Matcher matcher = SCRIPT.matcher(aText);
result = matcher.replaceAll("<SCRIPT>");
diff --git a/voila-runtime-root/.gitignore b/voila-runtime-root/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..fd39fa3de0f63bc5c78eca219e74e0a8531bd3e6
--- /dev/null
+++ b/voila-runtime-root/.gitignore
@@ -0,0 +1 @@
+/pom.xml
diff --git a/voila-runtime-root/pom.xml b/voila-runtime-root/pom.xml
index c6a6d23b68f610b4422c0a18720a7528ba19ecc7..0c884285dc7d4c4ec4212e0005e7b196bfcdb8fe 100644
--- a/voila-runtime-root/pom.xml
+++ b/voila-runtime-root/pom.xml
@@ -170,12 +170,14 @@
Bookmark START_LOOP pattern (eg : START_LOOP_{i}). {i} defined the i th
+ * bookmark start loop(eg : START_LOOP_1). Bookmark END_LOOP pattern (eg : END_LOOP_{i}). {i} defined the i th
+ * bookmark end loop (eg : END_LOOP_1).
+
- Character Encoding
- < <
- > >
- & &
- " "
+ ' '
+ < {@code < }
+ > {@code > }
+ & {@code & }
+ " {@code "} ' {@code '}
+
Character Escaped As " \"
@@ -316,8 +330,12 @@ public class EscapeUtils {
\ \\
- *
- *
- *
+ *
+ *
UnsupportedRTFDocumentTransformer
if template
* engine is not supported.
*
- * @param RTFfDocument Transformer Type (fmTransformer, vmTransformer,...)
- * @return
- * @throws UnsupportedRTFDocumentTransformer
+ * @param rtfDocumentTransformerType the rtf Document Transformer Type.
+ * @return the result.
+ * @throws UnsupportedRTFDocumentTransformer the exception.
*/
public IRTFDocumentTransformer newRTFDocumentTransformer(String rtfDocumentTransformerType)
throws UnsupportedRTFDocumentTransformer {
@@ -144,9 +144,9 @@ public class RTFTemplateBuilder {
* exception UnsupportedRTFDocumentParser
if template
* engine is not supported.
*
- * @param RTFfDocument Parser Type (defaultRTFParser,...)
- * @return
- * @throws UnsupportedRTFDocumentParser
+ * @param rtfDocumentParserType the rtf Document Parser Type.
+ * @return the result.
+ * @throws UnsupportedRTFDocumentParser the exception.
*/
public IRTFDocumentParser newRTFDocumentParser(String rtfDocumentParserType)
throws UnsupportedRTFDocumentParser {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/RTFTemplateWithVelocity.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/RTFTemplateWithVelocity.java
index e4a81a18eff1945af90ff280e849183598e96518..3e293cfe2a64732ab4be1faec017b90ffe2f07da 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/RTFTemplateWithVelocity.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/RTFTemplateWithVelocity.java
@@ -10,7 +10,7 @@ import net.sourceforge.rtf.helper.RTFTemplateBuilder;
public class RTFTemplateWithVelocity {
/**
- * @param args
+ * @param args the args.
*/
public static void main(String[] args) {
try {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/RTFTemplateWithVelocityAndXmlFields.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/RTFTemplateWithVelocityAndXmlFields.java
index 11f454de237b68aaf2dbcfebf9648d27926a7a4f..e45961716227858d352fef303abc7115f181cd28 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/RTFTemplateWithVelocityAndXmlFields.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/RTFTemplateWithVelocityAndXmlFields.java
@@ -10,7 +10,7 @@ import net.sourceforge.rtf.helper.RTFTemplateBuilder;
public class RTFTemplateWithVelocityAndXmlFields {
/**
- * @param args
+ * @param args the args.
*/
public static void main(String[] args) {
try {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestFreemarkerEngine.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestFreemarkerEngine.java
index aae758fdef1d65a835b9b5e04f4bc851dc9cf658..6f4cebdc8b32707a76c9f93cea3fd27c16590f1f 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestFreemarkerEngine.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestFreemarkerEngine.java
@@ -9,7 +9,7 @@ import net.sourceforge.rtf.helper.RTFTemplateBuilder;
public class TestFreemarkerEngine {
/**
- * @param args
+ * @param args the args.
*/
public static void main(String[] args) {
try {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestFreemarkerTransformer.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestFreemarkerTransformer.java
index 5f9c864a10b8212211be22ff07e6b16e24f487f2..a0dd7e681cc3d37fa4498e1cfe9e12339dcdb710 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestFreemarkerTransformer.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestFreemarkerTransformer.java
@@ -14,7 +14,7 @@ import net.sourceforge.rtf.helper.RTFTemplateBuilder;
public class TestFreemarkerTransformer {
/**
- * @param args
+ * @param args the args.
*/
public static void main(String[] args) {
try {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestVelocityEngine.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestVelocityEngine.java
index 309111e1c2043739826c58956bba29c43d1f1572..9a037744b9033484710354eebc4a8ef450699c85 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestVelocityEngine.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestVelocityEngine.java
@@ -10,7 +10,7 @@ import net.sourceforge.rtf.helper.RTFTemplateBuilder;
public class TestVelocityEngine {
/**
- * @param args
+ * @param args the args.
*/
public static void main(String[] args) {
try {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestVelocityTransformer.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestVelocityTransformer.java
index 8903bd95d6ef254b888c68f081fc24b6494bbfe0..f4037643f34f84056f110b17d211f8ffe56b916e 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestVelocityTransformer.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/helper/test/TestVelocityTransformer.java
@@ -14,7 +14,7 @@ import net.sourceforge.rtf.helper.RTFTemplateBuilder;
public class TestVelocityTransformer {
/**
- * @param args
+ * @param args the args.
*/
public static void main(String[] args) {
try {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/parser/AbstractCoreRTFParser.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/parser/AbstractCoreRTFParser.java
index f8ccbd8ea44512c9c71dade1028f6f1c2a26df91..f0259fed03e0d6f521a6c50dca6f78d240b3cfcc 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/parser/AbstractCoreRTFParser.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/parser/AbstractCoreRTFParser.java
@@ -49,7 +49,7 @@ public abstract class AbstractCoreRTFParser {
/**
* Parse RTF Reader stream.
* @param reader RTF source reader to parse.
- * @throws IOException
+ * @throws IOException the exception.
*/
public void parse(Reader reader) throws IOException {
BufferedReader br = new BufferedReader(reader);
@@ -62,8 +62,8 @@ public abstract class AbstractCoreRTFParser {
/**
* Parse RTF Input stream.
- * @param input stream RTF source reader to parse.
- * @throws IOException
+ * @param inputStream RTF source reader to parse.
+ * @throws IOException the exception.
*/
public void parse(InputStream inputStream) throws IOException {
BufferedInputStream bs = new BufferedInputStream(inputStream);
@@ -78,7 +78,7 @@ public abstract class AbstractCoreRTFParser {
* Launch events startGroup, endGroup and
* handleKeyword among to charcater c.
* @param c current character parsed.
- * @throws IOException
+ * @throws IOException the exception.
*/
private void parse(char c) throws IOException {
if (c == '{') {
@@ -118,7 +118,7 @@ public abstract class AbstractCoreRTFParser {
/**
* Return level of current group.
- * @return level of current group
+ * @return level of current group.
*/
protected int getLevel() {
return level;
@@ -132,7 +132,7 @@ public abstract class AbstractCoreRTFParser {
* character { is found.
* @param startGroupCharacter start group character {.
* @param level of current group.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void startGroup(char startGroupCharacter, int level)
throws IOException;
@@ -142,7 +142,7 @@ public abstract class AbstractCoreRTFParser {
* character } is found.
* @param endGroupCharacter end group character }.
* @param level of current group.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void endGroup(char endGroupCharacter, int level)
throws IOException;
@@ -152,7 +152,7 @@ public abstract class AbstractCoreRTFParser {
* Event RTF keyword. This event is launched when
* RTF content (current string parsed) end by character \.
* @param content RTF keyword.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void handleKeyword(String content) throws IOException;
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/parser/AbstractDefaultRTFParser.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/parser/AbstractDefaultRTFParser.java
index b4261b48433667b8f8d2c34a03ca18f0b769530b..a9790088a80edf5602356e2d835e2b4264255de3 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/parser/AbstractDefaultRTFParser.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/parser/AbstractDefaultRTFParser.java
@@ -61,7 +61,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
/**
* Manage events RTF keyword (Row, Field, Bookmark, Page and other RTF content).
* @param content RTF keyword.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected void handleKeyword(String content) throws IOException {
String keyword = content.trim();
@@ -132,7 +132,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event start row. This event is launched when
* RTF keyword \trowd is found.
* @param content RTF start row keyword \trowd.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void startRow(String content) throws IOException;
@@ -140,7 +140,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event end row. This event is launched when
* RTF keyword \row is found.
* @param content RTF end row keyword \row.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void endRow(String content) throws IOException;
@@ -148,7 +148,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event current paragraph is in table. This event helps to locate
* start of rows, which does not begin with \trowd (it only appears at the end of row)
* @param content RTF in table keyword \intbl.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void inTable(String content) throws IOException;
@@ -157,7 +157,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event start field. This event is launched when
* RTF keyword \field is found.
* @param content RTF end row keyword \field.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void startField(String content) throws IOException;
@@ -166,7 +166,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event start bookmark. This event is launched when
* RTF keyword \bkmkstart is found.
* @param content RTF start bookmark keyword \bkmkstart.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void startBookmark(String content) throws IOException;
@@ -174,7 +174,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event end bookmark. This event is launched when
* RTF keyword \bkmkend is found.
* @param content RTF end bookmark keyword \bkmkend.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void endBookmark(String content) throws IOException;
@@ -183,7 +183,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event page break. This event is launched when
* RTF keyword \page is found.
* @param content RTF start page keyword \page.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void startPage(String content) throws IOException;
@@ -192,7 +192,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event other RTF content. This event is launched
* when other RTF content is found (not a RTF keyword)
* @param content other RTF content.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void handleText(String content) throws IOException;
@@ -201,7 +201,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event start user property. This event is launched when
* RTF keyword \propname is found.
* @param content RTF start user property keyword \propname.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void startUserProperty(String content) throws IOException;
@@ -209,7 +209,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event end user property. This event is launched when
* RTF keyword \staticval is found.
* @param content RTF end user property keyword \staticval.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void endUserProperty(String content) throws IOException;
@@ -217,7 +217,7 @@ public abstract class AbstractDefaultRTFParser extends AbstractCoreRTFParser {
* Event annotation. This event is launched when
* RTF keyword \annotation is found.
* @param content RTF annotation keyword \annotation.
- * @throws IOException
+ * @throws IOException the exception.
*/
protected abstract void startAnnotation(String content) throws IOException;
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/AbstractRTFDocumentTransformer.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/AbstractRTFDocumentTransformer.java
index 0fbe0f307def61a2a6c29d0ca6bfde40c9902754..c4377b0118da3e8500cd542bdccdc04a4adf42f3 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/AbstractRTFDocumentTransformer.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/AbstractRTFDocumentTransformer.java
@@ -777,7 +777,7 @@ public abstract class AbstractRTFDocumentTransformer implements
/**
* Return string for end for each
*
- * @return
+ * @return the result.
*/
protected abstract String getMacroEndForEach();
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/AbstractTemplateEngine.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/AbstractTemplateEngine.java
index de378f517d65d2ef794c8a686d92e54a3a8e9428..bba7b6ccb47c61a2c96788d05841520a618492d0 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/AbstractTemplateEngine.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/AbstractTemplateEngine.java
@@ -52,8 +52,8 @@ public abstract class AbstractTemplateEngine implements ITemplateEngine {
/**
* Put a value for the given key.
*
- * @param key
- * @param value
+ * @param key the key.
+ * @param value the value.
*/
public void put(String key, Object value) {
if (this.context == null) {
@@ -151,8 +151,8 @@ public abstract class AbstractTemplateEngine implements ITemplateEngine {
/**
* Return true if value must be escaped and false otherwise
- * @param value
- * @return
+ * @param value the value.
+ * @return the result.
*/
public boolean mustBeEscaped(Object value) {
if (value instanceof InputStream)
@@ -176,8 +176,8 @@ public abstract class AbstractTemplateEngine implements ITemplateEngine {
/**
* Escape special chracters { and } with \{ and \}
* otherwise, RTF document generated is not valid.
- * @param value
- * @return
+ * @param value the value.
+ * @return the result.
*/
protected Object escapeSpecialCharacters(Object value) {
if(value != null && value instanceof String ) {
@@ -203,7 +203,6 @@ public abstract class AbstractTemplateEngine implements ITemplateEngine {
* This method treats any previously populated keys in the context kindly,
* so it won't act unpredictably if this is called late
*
- * @param innerContext a pre-populated Context object
*/
public void setGlobalContext( IContext globalContext)
{
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/IContext.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/IContext.java
index d3970dd18ff23b7ffb011a23c20ecb691cd2ca82..a03b8b8a063f73f639cd54928d6ee1e622b64522 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/IContext.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/IContext.java
@@ -5,21 +5,22 @@ public interface IContext {
/**
* Put a value for the given key.
*
- * @param key
- * @param value
- * @return
+ * @param key the key.
+ * @param value the value.
+ * @return the result.
*/
public Object put(String key, Object value);
/** Get the value of the given key.
*
- * @param key
+ * @param key the key.
+ * @return the result.
*/
public Object get(String key);
/**
*
- * @return
+ * @return the result.
*/
public Object[] getKeys();
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/freemarker/RTFFreemarkerTransformerImpl.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/freemarker/RTFFreemarkerTransformerImpl.java
index a768827b1a4b31853fb965ebcea840c15f6dedb0..16fe4e6fcf765b26ebc007bd258b7a54144f16c2 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/freemarker/RTFFreemarkerTransformerImpl.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/freemarker/RTFFreemarkerTransformerImpl.java
@@ -90,8 +90,8 @@ public class RTFFreemarkerTransformerImpl extends AbstractRTFDocumentTransformer
* For context=a.MyGetter Freemarker wait
* a.myGetter (lower case for the first letter)
*
- * @param fieldName
- * @return
+ * @param fieldName the fieldName.
+ * @return the result.
*/
protected String formatSubFieldName(String fieldName) {
if (fieldName.length() > 0) {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/RTFVelocityTransformerImpl.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/RTFVelocityTransformerImpl.java
index f665342ca6bce9bec84065c05661e28ce6c4e15d..7f83820a44ddecf8af0d066dc73381afbf8f5f26 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/RTFVelocityTransformerImpl.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/RTFVelocityTransformerImpl.java
@@ -31,7 +31,7 @@ public class RTFVelocityTransformerImpl extends AbstractRTFDocumentTransformer {
* field name to translate into velocity name.
* @param withGetter
* true if getter must be returned and false otherwise.
- * @return
+ * @return the result.
*/
protected String getObjectValueList(String fieldName,
String fieldNameWithListInfo, boolean withGetter) {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/VelocityContextImpl.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/VelocityContextImpl.java
index 28836f64564842973ea717f56bb842e856ab789a..f668c5ecfb29f3cd7472b11acd951b340e170a46 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/VelocityContextImpl.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/VelocityContextImpl.java
@@ -27,8 +27,7 @@ public class VelocityContextImpl extends VelocityContext implements IContext {
/**
* Overridden so that the null
values are accepted.
- *
- * @see AbstractVelocityContext#put(String,Object)
+ *
*/
public Object put(String key, Object value)
{
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/VelocityTemplateEngineImpl.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/VelocityTemplateEngineImpl.java
index e987cfef59ff1470d4b31fba419c74b0a40e0f9c..4e77cf61626960aba6d89e99c0a56adbacf7d54f 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/VelocityTemplateEngineImpl.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/template/velocity/VelocityTemplateEngineImpl.java
@@ -133,7 +133,6 @@ public class VelocityTemplateEngineImpl extends AbstractTemplateEngine {
/**
* Overridden so that the null
values are accepted.
*
- * @see AbstractVelocityContext#put(String,Object)
*/
public Object put(String key, Object value) {
if (key == null) {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/AbstractRTFUseCase.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/AbstractRTFUseCase.java
index f70aeb94a62d7342c854d8ab584b150fb53ee069..13ceaca3ca070bae751af577a77b314be20d53f8 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/AbstractRTFUseCase.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/AbstractRTFUseCase.java
@@ -51,13 +51,13 @@ public abstract class AbstractRTFUseCase {
/**
* Run RTFTemplate for merging rtfSource with the context putted with the
* method putContext which be must implement. After execution of this
- * method, files rtfSource + ".
- *
*
@@ -78,7 +78,8 @@ public class RTFAnnotationWithVelocity extends AbstractRTFUseCase {
*
*
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main(String[] args) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/bookmark/RTFTemplateWithBookmarkImbricated.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/bookmark/RTFTemplateWithBookmarkImbricated.java
index 2536ddad3d244f238ba8dce4c8b2e117892cbbfd..b68e9d0beb8bd5a25a529c4c1cb178efae76d9b3 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/bookmark/RTFTemplateWithBookmarkImbricated.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/bookmark/RTFTemplateWithBookmarkImbricated.java
@@ -39,7 +39,8 @@ public class RTFTemplateWithBookmarkImbricated extends AbstractRTFUseCase {
*
*
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/cache/RTFTemplateWithCache.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/cache/RTFTemplateWithCache.java
index f6cf3706586626eec057ac5fd2438c0ca79ff147..8364d9c29aa51ccee9209ca27126b05731689ace 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/cache/RTFTemplateWithCache.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/cache/RTFTemplateWithCache.java
@@ -21,7 +21,8 @@ public class RTFTemplateWithCache {
private static Map transformedDocumentMap = new HashMap();
/**
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main(String[] args) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/config/RTFTemplateWithJavaConfig.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/config/RTFTemplateWithJavaConfig.java
index a4d174d351261dbbc63d6ffcf7a769feac353ea8..7ea9b2e325684b2296deb56e2fdd1500b683a412 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/config/RTFTemplateWithJavaConfig.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/config/RTFTemplateWithJavaConfig.java
@@ -10,7 +10,7 @@ import net.sourceforge.rtf.template.velocity.VelocityTemplateEngineImpl;
public class RTFTemplateWithJavaConfig {
/**
- * @param args
+ * @param args the args.
*/
public static void main(String[] args) {
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/config/RTFTemplateWithSpringConfig.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/config/RTFTemplateWithSpringConfig.java
index 7eefe968f7a1c21b7ba477606f7e974bb7ff40e7..509ad11edee6c4d9ce18809d5424848a45a9dac0 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/config/RTFTemplateWithSpringConfig.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/config/RTFTemplateWithSpringConfig.java
@@ -18,7 +18,7 @@ import net.sourceforge.rtf.usecases.util.UseCaseUtil;
public class RTFTemplateWithSpringConfig {
/**
- * @param args
+ * @param args the args.
*/
public static void main(String[] args) {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/formtext/RTFTemplateWithFormTextWithVelocity.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/formtext/RTFTemplateWithFormTextWithVelocity.java
index 68d9756108ad752e291b168f8577105083df313f..450290c1e7cb947cce92c3eda43b0fb5dad70167 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/formtext/RTFTemplateWithFormTextWithVelocity.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/formtext/RTFTemplateWithFormTextWithVelocity.java
@@ -73,7 +73,8 @@ public class RTFTemplateWithFormTextWithVelocity extends AbstractRTFUseCase {
/**
* Use case of RTFTemplate with the RTF source model jakarta-velocity-model.rtf.
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/image/RTFTemplateWithImageWithFreemarker.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/image/RTFTemplateWithImageWithFreemarker.java
index e4c900632c8b5aa6da369996a6275c1c6902c290..c3ff19bb2ad507987ddd585dcbc2048bb7c3bbe7 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/image/RTFTemplateWithImageWithFreemarker.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/image/RTFTemplateWithImageWithFreemarker.java
@@ -101,7 +101,8 @@ public class RTFTemplateWithImageWithFreemarker extends AbstractRTFUseCase {
*
*
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/image/RTFTemplateWithImageWithVelocity.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/image/RTFTemplateWithImageWithVelocity.java
index 793fffa53b52828abca73c7eb49e8df1720fdbbb..cffaf883baa0660b22aee52333bf1df425eae7c8 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/image/RTFTemplateWithImageWithVelocity.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/image/RTFTemplateWithImageWithVelocity.java
@@ -100,7 +100,8 @@ public class RTFTemplateWithImageWithVelocity extends AbstractRTFUseCase {
*
*
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/jakartavelocityproject/RTFJakartaVelocityProjectWithFreemarker.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/jakartavelocityproject/RTFJakartaVelocityProjectWithFreemarker.java
index e4f625a285ef75947297c0f071411e608bef1ccb..dcea2fd1b08eb61f7da376a0532ef311c830b3c8 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/jakartavelocityproject/RTFJakartaVelocityProjectWithFreemarker.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/jakartavelocityproject/RTFJakartaVelocityProjectWithFreemarker.java
@@ -83,7 +83,7 @@ public class RTFJakartaVelocityProjectWithFreemarker extends AbstractRTFUseCase
* Use case of RTFTemplate with the RTF source model jakarta-velocity-model.rtf.
* It generate three files into directory usecases/out/jakartavelocityproject :
*
- *
*
*
*
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/jakartavelocityproject/RTFJakartaVelocityProjectWithVelocity.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/jakartavelocityproject/RTFJakartaVelocityProjectWithVelocity.java
index e0a965663e93a54c15eb6e55fd9158da7e1b2a0e..367b10043666353393c6764580d63cb4a6c95a52 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/jakartavelocityproject/RTFJakartaVelocityProjectWithVelocity.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/jakartavelocityproject/RTFJakartaVelocityProjectWithVelocity.java
@@ -82,7 +82,7 @@ public class RTFJakartaVelocityProjectWithVelocity extends AbstractRTFUseCase {
* Use case of RTFTemplate with the RTF source model jakarta-velocity-model.rtf.
* It generate three files into directory usecases/out/jakartavelocityproject :
*
- *
*
*
*
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/loop/RTFJakartaVelocityProjectWithFreemarker.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/loop/RTFJakartaVelocityProjectWithFreemarker.java
index bedabf952b6c39e71a3e68951e986c1b79defb6f..5c3a403d7f3325cd13f6bc91f3d5bb0f9d65fb35 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/loop/RTFJakartaVelocityProjectWithFreemarker.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/loop/RTFJakartaVelocityProjectWithFreemarker.java
@@ -49,7 +49,7 @@ public class RTFJakartaVelocityProjectWithFreemarker extends AbstractRTFUseCase
* Use case of RTFTemplate with the RTF source model jakarta-velocity-model.rtf.
* It generate three files into directory usecases/out/jakartavelocityproject :
*
- *
*
*
*
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/loop/RTFJakartaVelocityProjectWithVelocity.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/loop/RTFJakartaVelocityProjectWithVelocity.java
index af9283671ff1a9c131965ce01d8faaa66650acc0..a40240cc362f4d18b95cfe2110964881364763e9 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/loop/RTFJakartaVelocityProjectWithVelocity.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/loop/RTFJakartaVelocityProjectWithVelocity.java
@@ -63,7 +63,8 @@ public class RTFJakartaVelocityProjectWithVelocity extends AbstractRTFUseCase {
/**
* Use case of RTFTemplate with the RTF source model loop.rtf.
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBeakWithGroupWithFreemarker.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBeakWithGroupWithFreemarker.java
index 0ea8712010c68a86070d1fb82a3215538c4f9679..5946b0f2527c71413a3bc3468b9c1410c5710068 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBeakWithGroupWithFreemarker.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBeakWithGroupWithFreemarker.java
@@ -51,7 +51,8 @@ public class RTFTemplatePageBeakWithGroupWithFreemarker extends AbstractRTFUseCa
/**
* Use case of RTFTemplate with the RTF source model jakarta-velocity-model.rtf.
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBeakWithGroupWithVelocity.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBeakWithGroupWithVelocity.java
index 6d9636ee9cb8742588f2d2894f076e3d51b44f6a..f88a8a319c9ece1111b8e05497248069280ba9db 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBeakWithGroupWithVelocity.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBeakWithGroupWithVelocity.java
@@ -51,7 +51,8 @@ public class RTFTemplatePageBeakWithGroupWithVelocity extends AbstractRTFUseCase
/**
* Use case of RTFTemplate with the RTF source model jakarta-velocity-model.rtf.
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBreakWithFreemarker.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBreakWithFreemarker.java
index ed136b3d8ed81c794b70fc162a239adf70a03dc1..b7d3de323418c21d9d650874ab0fc0205821349c 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBreakWithFreemarker.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBreakWithFreemarker.java
@@ -82,7 +82,8 @@ public class RTFTemplatePageBreakWithFreemarker extends AbstractRTFUseCase {
/**
* Use case of RTFTemplate with the RTF source model jakarta-velocity-model.rtf.
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBreakWithVelocity.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBreakWithVelocity.java
index cfc85749cd6596171170f6ce6a8a80a424aa1404..ea34094e0022ac763222a3372898998cf8233a25 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBreakWithVelocity.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/page/RTFTemplatePageBreakWithVelocity.java
@@ -82,7 +82,8 @@ public class RTFTemplatePageBreakWithVelocity extends AbstractRTFUseCase {
/**
* Use case of RTFTemplate with the RTF source model jakarta-velocity-model.rtf.
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main( String[] args ) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/rtfcode/RTFCodeWithVelocity.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/rtfcode/RTFCodeWithVelocity.java
index 9593baa8d62feb14d3d9ef2f0498350eecbd9874..88f8c198d88529cdd9e8e455f9fdd68c979bcd41 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/rtfcode/RTFCodeWithVelocity.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/rtfcode/RTFCodeWithVelocity.java
@@ -91,7 +91,7 @@ public class RTFCodeWithVelocity extends AbstractRTFUseCase {
* jakarta-velocity-model.rtf. It generate three files into
* directory usecases/out/jakartavelocityproject :
*
- *
*
@@ -102,7 +102,8 @@ public class RTFCodeWithVelocity extends AbstractRTFUseCase {
*
*
- * @param args
+ * @param args the args.
+ * @throws Exception the exception.
*/
public static void main(String[] args) throws Exception {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/strategies/RTFTemplateReaderStrategy.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/strategies/RTFTemplateReaderStrategy.java
index 3c58c69bd8599d7a61ba2227db8fe7253ae5ecdd..d4fc2d68bfd1bdc8c8ebfeaa25cf491d39fad5bc 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/strategies/RTFTemplateReaderStrategy.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/usecases/strategies/RTFTemplateReaderStrategy.java
@@ -29,7 +29,7 @@ import net.sourceforge.rtf.usecases.util.UseCaseUtil;
public class RTFTemplateReaderStrategy {
/**
- * @param args
+ * @param args the args.
*/
public static void main(String[] args) {
String baseDirectory = UseCaseUtil.getBaseDirectory(args);
diff --git a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/web/servlet/AbstractRTFTemplateServlet.java b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/web/servlet/AbstractRTFTemplateServlet.java
index 7914c70e09b7c20ed5a5f35422c3bd20254732bf..fd91df06ed5b8b5ebfe0c1c9f7844941765936fb 100644
--- a/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/web/servlet/AbstractRTFTemplateServlet.java
+++ b/voila-runtime-rtftemplate/src/main/java/net/sourceforge/rtf/web/servlet/AbstractRTFTemplateServlet.java
@@ -55,8 +55,8 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
}
/**
- * Handles HTTP GET
requests by calling {@link
- * #doRequest()}.
+ * Handles HTTP GET
requests by calling
+ * { #doRequest()}.
*/
public void doGet( HttpServletRequest request, HttpServletResponse response )
throws ServletException, IOException
@@ -65,8 +65,8 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
}
/**
- * Handles HTTP POST
requests by calling {@link
- * #doRequest()}.
+ * Handles HTTP POST
requests by calling
+ * { #doRequest()}.
*/
public void doPost( HttpServletRequest request, HttpServletResponse response )
throws ServletException, IOException
@@ -78,8 +78,10 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
/**
* Handles all requests (by default).
*
- * @param request HttpServletRequest object containing client request
- * @param response HttpServletResponse object for the response
+ * @param request HttpServletRequest object containing client request
+ * @param response HttpServletResponse object for the response
+ * @throws ServletException the exception.
+ * @throws IOException the exception.
*/
protected void doRequest(HttpServletRequest request, HttpServletResponse response )
throws ServletException, IOException
@@ -186,6 +188,8 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
* @param request original HttpServletRequest from servlet container.
* @param response HttpServletResponse object from servlet container.
* @param cause Exception that was thrown by some other part of process.
+ * @throws ServletException the exception.
+ * @throws IOException the exception.
*/
protected void error( HttpServletRequest request, HttpServletResponse response, Exception cause )
throws ServletException, IOException
@@ -216,8 +220,8 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
/**
* Set content type to RTF.
- * @param request
- * @param response
+ * @param request the request.
+ * @param response the response.
*/
protected void setContentType(HttpServletRequest request,
HttpServletResponse response) {
@@ -226,8 +230,8 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
/**
* Set FileName of Content Disposition
- * @param response
- * @param fileName
+ * @param response the response.
+ * @param fileName the fileName.
*/
protected void setContentDisposition(HttpServletResponse response, String fileName) {
response.setHeader("Content-Disposition", "attachment; filename=\""+fileName+"\"");
@@ -235,9 +239,9 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
/**
* This method to implement must return Reader of the RTF model source to use.
- * @param request
- * @return
- * @throws Exception
+ * @param request the request.
+ * @return the result.
+ * @throws Exception the exception.
*/
protected Reader getRTFReader( HttpServletRequest request ) throws Exception {
return null;
@@ -246,9 +250,9 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
/**
* This method to implement must return InputStream of the RTF model source to use.
- * @param request
- * @return
- * @throws Exception
+ * @param request the request.
+ * @return the result.
+ * @throws Exception the exception.
*/
protected InputStream getRTFInputStream( HttpServletRequest request ) throws Exception {
return null;
@@ -256,26 +260,25 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
/**
* This method to implement must put context for the RTF model source to use.
- * @param request
- * @param response
- * @param ctx
- * @throws Exception
+ * @param request the request.
+ * @param ctx the ctx.
+ * @throws Exception the exception.
*/
protected abstract void putContext(HttpServletRequest request, IContext ctx ) throws Exception;
/**
* This method to implement must return XML fileds available for the RTF model or null if there is not XML Fileds available.
- * @param request
- * @param response
- * @return
- * @throws Exception
+ * @param request the request.
+ * @return the result.
+ * @throws Exception the exception.
*/
protected abstract InputStream getXMLFieldsAvailable( HttpServletRequest request ) throws Exception;
/**
* If this method is implemented, RTFTemplate use this TransformerConfig,
* oterwise, RTFTemplate use default TransformerConfig.
- * @return
+ * @param request the request.
+ * @return the result.
*/
protected InputStream getTransformerConfig(HttpServletRequest request) {
return null;
@@ -283,9 +286,9 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
/**
* Return the real path of RTF Model.
- * @param request
- * @param rtfModelFile
- * @return
+ * @param request the request.
+ * @param rtfModelFile the rtf Model File.
+ * @return the result.
*/
protected String getRealPathOfRTFModel(HttpServletRequest request , String rtfModelFile) {
return request.getRealPath("") + rtfModelFile;
@@ -321,7 +324,7 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
/**
* Return global Spring configuration for RTFTemplate
- * @return
+ * @return the result.
*/
protected ApplicationContext getGlobalApplicationContext() {
return null;
@@ -329,7 +332,8 @@ public abstract class AbstractRTFTemplateServlet extends HttpServlet {
/**
* Return Spring configuration for RTFTemplate
- * @return
+ * @param request the request.
+ * @return the result.
*/
protected ApplicationContext getApplicationContext(HttpServletRequest request) {
return null;