You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2026/07/11 12:50:59 UTC
(commons-jexl) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-jexl.git
The following commit(s) were added to refs/heads/master by this push:
new 4d491721 Javadoc
4d491721 is described below
commit 4d4917219a45f2d9b68a6c1e312448c71ac30238
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Jul 11 08:50:53 2026 -0400
Javadoc
---
.../org/apache/commons/jexl3/JexlArithmetic.java | 70 +++++++++++-----------
.../java/org/apache/commons/jexl3/JexlBuilder.java | 40 ++++++-------
.../java/org/apache/commons/jexl3/JexlCache.java | 12 ++--
.../java/org/apache/commons/jexl3/JexlContext.java | 12 ++--
.../java/org/apache/commons/jexl3/JexlEngine.java | 32 +++++-----
.../org/apache/commons/jexl3/JexlException.java | 56 ++++++++---------
.../org/apache/commons/jexl3/JexlExpression.java | 6 +-
.../org/apache/commons/jexl3/JexlFeatures.java | 6 +-
.../java/org/apache/commons/jexl3/JexlInfo.java | 14 ++---
.../org/apache/commons/jexl3/JexlOperator.java | 12 ++--
.../java/org/apache/commons/jexl3/JexlOptions.java | 14 ++---
.../java/org/apache/commons/jexl3/JexlScript.java | 22 +++----
.../java/org/apache/commons/jexl3/JxltEngine.java | 42 ++++++-------
.../org/apache/commons/jexl3/ObjectContext.java | 4 +-
.../commons/jexl3/internal/ArrayBuilder.java | 4 +-
.../apache/commons/jexl3/internal/Debugger.java | 6 +-
.../org/apache/commons/jexl3/internal/Engine.java | 28 ++++-----
.../apache/commons/jexl3/internal/Engine32.java | 2 +-
.../commons/jexl3/internal/FqcnResolver.java | 4 +-
.../org/apache/commons/jexl3/internal/Frame.java | 8 +--
.../commons/jexl3/internal/IntegerRange.java | 4 +-
.../apache/commons/jexl3/internal/Interpreter.java | 30 +++++-----
.../commons/jexl3/internal/InterpreterBase.java | 22 +++----
.../commons/jexl3/internal/LexicalFrame.java | 2 +-
.../commons/jexl3/internal/LexicalScope.java | 4 +-
.../apache/commons/jexl3/internal/LongRange.java | 4 +-
.../apache/commons/jexl3/internal/Operator.java | 8 +--
.../org/apache/commons/jexl3/internal/Scope.java | 28 ++++-----
.../org/apache/commons/jexl3/internal/Script.java | 22 +++----
.../commons/jexl3/internal/ScriptVisitor.java | 4 +-
.../apache/commons/jexl3/internal/SoftCache.java | 2 +-
.../org/apache/commons/jexl3/internal/Source.java | 4 +-
.../commons/jexl3/internal/TemplateDebugger.java | 14 ++---
.../commons/jexl3/internal/TemplateEngine.java | 30 +++++-----
.../jexl3/internal/TemplateInterpreter.java | 2 +-
.../commons/jexl3/internal/TemplateScript.java | 6 +-
.../internal/introspection/AbstractExecutor.java | 10 ++--
.../internal/introspection/BooleanGetExecutor.java | 2 +-
.../jexl3/internal/introspection/ClassMap.java | 8 +--
.../jexl3/internal/introspection/ClassTool.java | 2 +-
.../internal/introspection/DuckGetExecutor.java | 2 +-
.../internal/introspection/DuckSetExecutor.java | 2 +-
.../internal/introspection/FieldGetExecutor.java | 2 +-
.../internal/introspection/FieldSetExecutor.java | 2 +-
.../jexl3/internal/introspection/IndexedType.java | 12 ++--
.../jexl3/internal/introspection/Introspector.java | 16 ++---
.../internal/introspection/ListGetExecutor.java | 2 +-
.../internal/introspection/ListSetExecutor.java | 2 +-
.../internal/introspection/MapGetExecutor.java | 2 +-
.../internal/introspection/MapSetExecutor.java | 2 +-
.../jexl3/internal/introspection/MethodKey.java | 14 ++---
.../jexl3/internal/introspection/Permissions.java | 16 ++---
.../internal/introspection/PermissionsParser.java | 12 ++--
.../introspection/PropertyGetExecutor.java | 2 +-
.../introspection/PropertySetExecutor.java | 4 +-
.../jexl3/internal/introspection/Uberspect.java | 12 ++--
.../commons/jexl3/introspection/JexlMethod.java | 4 +-
.../jexl3/introspection/JexlPermissions.java | 8 +--
.../jexl3/introspection/JexlPropertyGet.java | 4 +-
.../jexl3/introspection/JexlPropertySet.java | 4 +-
.../commons/jexl3/introspection/JexlSandbox.java | 26 ++++----
.../commons/jexl3/introspection/JexlUberspect.java | 20 +++----
.../apache/commons/jexl3/parser/ASTIdentifier.java | 4 +-
.../apache/commons/jexl3/parser/ASTJexlScript.java | 16 ++---
.../commons/jexl3/parser/ASTJxltLiteral.java | 2 +-
.../commons/jexl3/parser/ASTRegexLiteral.java | 2 +-
.../commons/jexl3/parser/ASTStringLiteral.java | 2 +-
.../commons/jexl3/parser/FeatureController.java | 2 +-
.../apache/commons/jexl3/parser/JavaccError.java | 4 +-
.../org/apache/commons/jexl3/parser/JexlNode.java | 10 ++--
.../apache/commons/jexl3/parser/JexlParser.java | 28 ++++-----
.../commons/jexl3/parser/JexlScriptParser.java | 4 +-
.../apache/commons/jexl3/parser/SimpleNode.java | 6 +-
.../apache/commons/jexl3/parser/StringParser.java | 18 +++---
.../commons/jexl3/parser/TokenMgrException.java | 2 +-
.../commons/jexl3/scripting/JexlScriptEngine.java | 12 ++--
.../jexl3/scripting/JexlScriptEngineFactory.java | 2 +-
.../org/apache/commons/jexl3/scripting/Main.java | 2 +-
.../org/apache/commons/jexl3/Arithmetic360.java | 2 +-
.../org/apache/commons/jexl3/ArithmeticTest.java | 2 +-
.../java/org/apache/commons/jexl3/CacheTest.java | 2 +-
.../org/apache/commons/jexl3/Issues300Test.java | 2 +-
.../org/apache/commons/jexl3/Issues400Test.java | 2 +-
.../java/org/apache/commons/jexl3/LexicalTest.java | 2 +-
.../java/org/apache/commons/jexl3/ScriptTest.java | 4 +-
.../java/org/apache/commons/jexl3/SpreadCache.java | 6 +-
.../commons/jexl3/SynchronizedArithmetic.java | 6 +-
.../apache/commons/jexl3/SynchronizedContext.java | 2 +-
.../java/org/apache/commons/jexl3/VarTest.java | 12 ++--
.../apache/commons/jexl3/examples/StreamTest.java | 8 +--
.../org/apache/commons/jexl3/internal/Util.java | 2 +-
.../commons/jexl3/jexl342/OptionalArithmetic.java | 2 +-
.../jexl3/jexl342/ReferenceGetExecutor.java | 2 +-
.../jexl3/jexl342/ReferenceMethodExecutor.java | 2 +-
.../jexl3/jexl342/ReferenceSetExecutor.java | 2 +-
.../commons/jexl3/jexl342/ReferenceUberspect.java | 12 ++--
.../org/apache/commons/jexl3/junit/Asserter.java | 6 +-
97 files changed, 483 insertions(+), 483 deletions(-)
diff --git a/src/main/java/org/apache/commons/jexl3/JexlArithmetic.java b/src/main/java/org/apache/commons/jexl3/JexlArithmetic.java
index 8d6918eb..00fe77d2 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlArithmetic.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlArithmetic.java
@@ -88,7 +88,7 @@ public class JexlArithmetic {
* Creates the actual "array" instance.
*
* @param extended true when the last argument is ', ...'
- * @return the array
+ * @return The array
*/
Object create(boolean extended);
}
@@ -128,7 +128,7 @@ public class JexlArithmetic {
/**
* Creates the actual "map" instance.
*
- * @return the map
+ * @return The map
*/
Object create();
@@ -166,7 +166,7 @@ public class JexlArithmetic {
/**
* Creates the actual "set" instance.
*
- * @return the set
+ * @return The set
*/
Object create();
}
@@ -182,7 +182,7 @@ public class JexlArithmetic {
*
* @param operator the operator
* @param args the arguments
- * @return the most specific method or null if no specific override could be found
+ * @return The most specific method or null if no specific override could be found
*/
JexlMethod getOperator(JexlOperator operator, Object... args);
@@ -409,7 +409,7 @@ public class JexlArithmetic {
*
* @param size the number of elements in the array
* @param extended whether the map is extended or not
- * @return the array builder
+ * @return The array builder
*/
public ArrayBuilder arrayBuilder(final int size, final boolean extended) {
return new org.apache.commons.jexl3.internal.ArrayBuilder(size, extended);
@@ -660,7 +660,7 @@ public class JexlArithmetic {
* @param strictCast whether strict cast is required
* @param defaultValue the default value to return, if not strict
* @param <T> The value type
- * @return the default value is strict is false
+ * @return The default value is strict is false
* @throws JexlArithmetic.NullOperand if strict-cast
* @since 3.3
*/
@@ -675,7 +675,7 @@ public class JexlArithmetic {
* The last method called before returning a result from a script execution.
*
* @param returned the returned value
- * @return the controlled returned value
+ * @return The controlled returned value
*/
public Object controlReturn(final Object returned) {
return returned;
@@ -687,7 +687,7 @@ public class JexlArithmetic {
*
* @param from the included lower bound value (null if none)
* @param to the included upper bound value (null if none)
- * @return the range as an iterable
+ * @return The range as an iterable
* @throws ArithmeticException as an option if creation fails
*/
public Iterable<?> createRange(final Object from, final Object to) throws ArithmeticException {
@@ -858,7 +858,7 @@ public class JexlArithmetic {
* <p>Override or overload this method to add new signatures to the size operators.
*
* @param object the object to check the emptiness of
- * @return the boolean or false if object is not null
+ * @return The boolean or false if object is not null
* @since 3.2
*/
public Boolean empty(final Object object) {
@@ -892,7 +892,7 @@ public class JexlArithmetic {
*
* @param left left argument
* @param right right argument
- * @return the test result
+ * @return The test result
*/
public boolean equals(final Object left, final Object right) {
if (left == right) {
@@ -911,7 +911,7 @@ public class JexlArithmetic {
/**
* The MathContext instance used for +,-,/,*,% operations on big decimals.
*
- * @return the math context
+ * @return The math context
*/
public MathContext getMathContext() {
return mathContext;
@@ -920,7 +920,7 @@ public class JexlArithmetic {
/**
* The BigDecimal scale used for comparison and coercion operations.
*
- * @return the scale
+ * @return The scale
*/
public int getMathScale() {
return mathScale;
@@ -931,7 +931,7 @@ public class JexlArithmetic {
*
* @param left left argument
* @param right right argument
- * @return the test result
+ * @return The test result
*/
public boolean greaterThan(final Object left, final Object right) {
if (left == right || left == null || right == null) {
@@ -945,7 +945,7 @@ public class JexlArithmetic {
*
* @param left left argument
* @param right right argument
- * @return the test result
+ * @return The test result
*/
public boolean greaterThanOrEqual(final Object left, final Object right) {
if (left == right) {
@@ -1018,7 +1018,7 @@ public class JexlArithmetic {
*
* @param logger the logger for warning messages; may be null
* @param arg the supplier providing the argument to evaluate
- * @return the evaluated result on success or {@link JexlEngine#TRY_FAILED} on failure
+ * @return The evaluated result on success or {@link JexlEngine#TRY_FAILED} on failure
* @since 3.6.3
*/
public Object evaluate(final Log logger, final Supplier<Object> arg) {
@@ -1044,7 +1044,7 @@ public class JexlArithmetic {
* Check for emptiness of various types: Number, Collection, Array, Map, String.
*
* @param object the object to check the emptiness of
- * @return the boolean or null if there is no arithmetic solution
+ * @return The boolean or null if there is no arithmetic solution
*/
public Boolean isEmpty(final Object object) {
return isEmpty(object, object == null);
@@ -1055,7 +1055,7 @@ public class JexlArithmetic {
*
* @param object the object to check the emptiness of
* @param def the default value if object emptiness cannot be determined
- * @return the boolean or null if there is no arithmetic solution
+ * @return The boolean or null if there is no arithmetic solution
*/
public Boolean isEmpty(final Object object, final Boolean def) {
if (object != null) {
@@ -1207,7 +1207,7 @@ public class JexlArithmetic {
*
* @param left left argument
* @param right right argument
- * @return the test result
+ * @return The test result
*/
public boolean lessThan(final Object left, final Object right) {
if (left == right || left == null || right == null) {
@@ -1222,7 +1222,7 @@ public class JexlArithmetic {
*
* @param left left argument
* @param right right argument
- * @return the test result
+ * @return The test result
*/
public boolean lessThanOrEqual(final Object left, final Object right) {
if (left == right) {
@@ -1264,7 +1264,7 @@ public class JexlArithmetic {
*
* @param size the number of elements in the map
* @param extended whether the map is extended or not
- * @return the map builder
+ * @return The map builder
*/
public MapBuilder mapBuilder(final int size, final boolean extended) {
return new org.apache.commons.jexl3.internal.MapBuilder(size, extended);
@@ -1386,7 +1386,7 @@ public class JexlArithmetic {
*
* @param value the double value
* @param narrow the target narrow class
- * @return the narrowed or initial number
+ * @return The narrowed or initial number
*/
private Number narrow(final Class<?> narrow, final double value) {
return narrowAccept(narrow, Float.class) && (float) value == value
@@ -1524,7 +1524,7 @@ public class JexlArithmetic {
*
* @param original the original number
* @param narrow the attempted target class
- * @return the narrowed number or the source if no narrowing was possible
+ * @return The narrowed number or the source if no narrowing was possible
*/
public Number narrowNumber(final Number original, final Class<?> narrow) {
if (original != null) {
@@ -1583,7 +1583,7 @@ public class JexlArithmetic {
*
* @see #isNegateStable()
* @param val the value to negate
- * @return the negated value
+ * @return The negated value
*/
public Object negate(final Object val) {
if (val == null) {
@@ -1845,7 +1845,7 @@ public class JexlArithmetic {
*
* @see #isPositivizeStable()
* @param val the value to positivize
- * @return the positive value
+ * @return The positive value
*/
public Object positivize(final Object val) {
if (val == null) {
@@ -1876,7 +1876,7 @@ public class JexlArithmetic {
* Ensure a big decimal is rounded by this arithmetic scale and rounding mode.
*
* @param number the big decimal to round
- * @return the rounded big decimal
+ * @return The rounded big decimal
*/
protected BigDecimal roundBigDecimal(final BigDecimal number) {
final int mscale = getMathScale();
@@ -1903,7 +1903,7 @@ public class JexlArithmetic {
*
* @param size the number of elements in the set
* @param extended whether the set is extended or not
- * @return the array builder
+ * @return The array builder
*/
public SetBuilder setBuilder(final int size, final boolean extended) {
return new org.apache.commons.jexl3.internal.SetBuilder(size, extended);
@@ -1952,7 +1952,7 @@ public class JexlArithmetic {
* Calculate the {@code size} of various types: Collection, Array, Map, String.
*
* @param object the object to get the size of
- * @return the <em>size</em> of object, 0 if null, 1 if there is no <em>better</em> solution
+ * @return The <em>size</em> of object, 0 if null, 1 if there is no <em>better</em> solution
*/
public Integer size(final Object object) {
return size(object, object == null ? 0 : 1);
@@ -1963,7 +1963,7 @@ public class JexlArithmetic {
*
* @param object the object to get the size of
* @param def the default value if object size cannot be determined
- * @return the size of object or null if there is no arithmetic solution
+ * @return The size of object or null if there is no arithmetic solution
*/
public Integer size(final Object object, final Integer def) {
if (object instanceof CharSequence) {
@@ -2009,7 +2009,7 @@ public class JexlArithmetic {
*
* @param left left argument
* @param right right argument
- * @return the test result
+ * @return The test result
*/
public boolean strictEquals(final Object left, final Object right) {
if (left == right) {
@@ -2203,7 +2203,7 @@ public class JexlArithmetic {
*
* @param val value to coerce
* @param strict true if the calling operator or casting is strict, false otherwise
- * @return the boolean value if coercion is possible, true if value was not null.
+ * @return The boolean value if coercion is possible, true if value was not null.
*/
protected boolean toBoolean(final boolean strict, final Object val) {
return isNullOperand(val)? controlNullOperand(strict, false) : toBoolean(val);
@@ -2214,7 +2214,7 @@ public class JexlArithmetic {
* <p>Double.NaN, null, "false" and empty string coerce to false.</p>
*
* @param val value to coerce
- * @return the boolean value if coercion is possible, true if value was not null.
+ * @return The boolean value if coercion is possible, true if value was not null.
*/
public boolean toBoolean(final Object val) {
if (val instanceof Boolean) {
@@ -2295,7 +2295,7 @@ public class JexlArithmetic {
*
* @param strict true if the calling operator or casting is strict, false otherwise
* @param val value to coerce
- * @return the value coerced to int
+ * @return The value coerced to int
* @throws ArithmeticException if val is null and mode is strict or if coercion is not possible
* @since 3.3
*/
@@ -2309,7 +2309,7 @@ public class JexlArithmetic {
* <p>Boolean false is 0, true is 1.</p>
*
* @param val value to coerce
- * @return the value coerced to int
+ * @return The value coerced to int
* @throws ArithmeticException if val is null and mode is strict or if coercion is not possible
*/
public int toInteger(final Object val) {
@@ -2346,7 +2346,7 @@ public class JexlArithmetic {
*
* @param strict true if the calling operator or casting is strict, false otherwise
* @param val value to coerce
- * @return the value coerced to long
+ * @return The value coerced to long
* @throws ArithmeticException if value is null and mode is strict or if coercion is not possible
* @since 3.3
*/
@@ -2360,7 +2360,7 @@ public class JexlArithmetic {
* <p>Boolean false is 0, true is 1.</p>
*
* @param val value to coerce
- * @return the value coerced to long
+ * @return The value coerced to long
* @throws ArithmeticException if value is null and mode is strict or if coercion is not possible
*/
public long toLong(final Object val) {
diff --git a/src/main/java/org/apache/commons/jexl3/JexlBuilder.java b/src/main/java/org/apache/commons/jexl3/JexlBuilder.java
index 1d929f92..63283988 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlBuilder.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlBuilder.java
@@ -294,7 +294,7 @@ public class JexlBuilder {
/**
* Gets the JexlArithmetic instance the engine will use.
*
- * @return the arithmetic
+ * @return The arithmetic
*/
public JexlArithmetic arithmetic() {
return this.arithmetic;
@@ -328,7 +328,7 @@ public class JexlBuilder {
/**
* Gets the expression cache size the engine will use.
*
- * @return the cache size
+ * @return The cache size
*/
public int cache() {
return cache;
@@ -350,7 +350,7 @@ public class JexlBuilder {
/**
* Gets the expression-cache factory the engine will use.
*
- * @return the cache factory
+ * @return The cache factory
*/
public IntFunction<JexlCache<?, ?>> cacheFactory() {
return this.cacheFactory;
@@ -370,7 +370,7 @@ public class JexlBuilder {
/**
* Gets the Jexl script parser factory the engine will use.
*
- * @return the cache factory
+ * @return The cache factory
* @since 3.5.0
*/
public Supplier<JexlScriptParser> parserFactory() {
@@ -392,7 +392,7 @@ public class JexlBuilder {
/**
* Gets the maximum length for an expression to be cached.
*
- * @return the cache threshold
+ * @return The cache threshold
*/
public int cacheThreshold() {
return cacheThreshold;
@@ -416,7 +416,7 @@ public class JexlBuilder {
/**
* Gets the cancellable information flag
*
- * @return the cancellable information flag
+ * @return The cancellable information flag
* @since 3.1
*/
public Boolean cancellable() {
@@ -440,7 +440,7 @@ public class JexlBuilder {
/**
* Gets the charset
*
- * @return the charset
+ * @return The charset
*/
public Charset charset() {
return charset;
@@ -513,7 +513,7 @@ public class JexlBuilder {
/**
* Gets the debug flag.
*
- * @return the debugging information flag
+ * @return The debugging information flag
*/
public Boolean debug() {
return this.debug;
@@ -534,7 +534,7 @@ public class JexlBuilder {
/**
* Gets the features the engine will use as a base by default.
*
- * @return the features
+ * @return The features
*/
public JexlFeatures features() {
return this.features;
@@ -566,7 +566,7 @@ public class JexlBuilder {
/**
* Gets the optional set of imported packages.
*
- * @return the set of imports, may be empty, not null
+ * @return The set of imports, may be empty, not null
*/
public Collection<String> imports() {
return options.getImports();
@@ -644,7 +644,7 @@ public class JexlBuilder {
/**
* Gets the classloader
*
- * @return the class loader
+ * @return The class loader
*/
public ClassLoader loader() {
return loader;
@@ -676,7 +676,7 @@ public class JexlBuilder {
/**
* Gets the logger
*
- * @return the logger
+ * @return The logger
*/
public Log logger() {
return this.logger;
@@ -696,7 +696,7 @@ public class JexlBuilder {
/**
* Gets the map of namespaces.
*
- * @return the map of namespaces.
+ * @return The map of namespaces.
*/
public Map<String, Object> namespaces() {
return options.getNamespaces();
@@ -735,7 +735,7 @@ public class JexlBuilder {
/**
* Gets the current set of options
*
- * @return the current set of options
+ * @return The current set of options
*/
public JexlOptions options() {
return options;
@@ -744,7 +744,7 @@ public class JexlBuilder {
/**
* Gets the permissions
*
- * @return the permissions
+ * @return The permissions
*/
public JexlPermissions permissions() {
return this.permissions;
@@ -788,7 +788,7 @@ public class JexlBuilder {
/**
* Gets the sandbox
*
- * @return the sandbox
+ * @return The sandbox
*/
public JexlSandbox sandbox() {
return this.sandbox;
@@ -808,7 +808,7 @@ public class JexlBuilder {
/**
* Is error handling silent?
*
- * @return the silent error handling flag
+ * @return The silent error handling flag
*/
public Boolean silent() {
return options.isSilent();
@@ -831,7 +831,7 @@ public class JexlBuilder {
/**
* Gets the cache size
*
- * @return the cache size
+ * @return The cache size
*/
public int stackOverflow() {
return stackOverflow;
@@ -851,7 +851,7 @@ public class JexlBuilder {
/**
* Gets the JexlUberspect strategy
*
- * @return the JexlUberspect strategy */
+ * @return The JexlUberspect strategy */
public JexlUberspect.ResolverStrategy strategy() {
return this.strategy;
}
@@ -906,7 +906,7 @@ public class JexlBuilder {
/**
* Gets the uberspect
*
- * @return the uberspect */
+ * @return The uberspect */
public JexlUberspect uberspect() {
return this.uberspect;
}
diff --git a/src/main/java/org/apache/commons/jexl3/JexlCache.java b/src/main/java/org/apache/commons/jexl3/JexlCache.java
index a506f481..3993260d 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlCache.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlCache.java
@@ -31,7 +31,7 @@ public interface JexlCache<K, V> {
/**
* Returns the cache capacity, the maximum number of elements it can contain.
*
- * @return the cache capacity
+ * @return The cache capacity
*/
int capacity();
@@ -47,7 +47,7 @@ public interface JexlCache<K, V> {
* For implementations testing only
* </p>
*
- * @return the cache entry list
+ * @return The cache entry list
*/
default Collection<Map.Entry<K, V>> entries() {
return Collections.emptyList();
@@ -57,7 +57,7 @@ public interface JexlCache<K, V> {
* Gets a value from this cache.
*
* @param key the cache entry key
- * @return the cache entry value
+ * @return The cache entry value
*/
V get(K key);
@@ -66,14 +66,14 @@ public interface JexlCache<K, V> {
*
* @param key the cache entry key
* @param script the cache entry value
- * @return the previously associated value if any
+ * @return The previously associated value if any
*/
V put(K key, V script);
/**
* Returns the cache size, the actual number of elements it contains.
*
- * @return the cache size
+ * @return The cache size
*/
int size();
@@ -85,7 +85,7 @@ public interface JexlCache<K, V> {
/**
* Gets the referenced object.
*
- * @return the referenced object
+ * @return The referenced object
*/
Object getCache();
diff --git a/src/main/java/org/apache/commons/jexl3/JexlContext.java b/src/main/java/org/apache/commons/jexl3/JexlContext.java
index 5991efd4..4fceae5a 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlContext.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlContext.java
@@ -67,7 +67,7 @@ public interface JexlContext {
* @param name the annotation name
* @param args the arguments of the annotation, evaluated as arguments of this call
* @param statement the statement that was annotated; the processor should invoke this statement 'call' method
- * @return the result of statement.call()
+ * @return The result of statement.call()
* @throws Exception if annotation processing fails
*/
Object processAnnotation(String name, Object[] args, Callable<Object> statement) throws Exception;
@@ -120,7 +120,7 @@ public interface JexlContext {
* @param info the info at the pragma location.
* @param name the module name.
* @param body the module definition which can be its location or source.
- * @return the module object.
+ * @return The module object.
*/
Object processModule(JexlEngine engine, JexlInfo info, String name, String body);
}
@@ -137,7 +137,7 @@ public interface JexlContext {
* Creates the functor object that will be used instead of the namespace.
*
* @param context the context.
- * @return the namespace functor instance.
+ * @return The namespace functor instance.
*/
Object createFunctor(JexlContext context);
}
@@ -162,7 +162,7 @@ public interface JexlContext {
* Resolves a namespace by its name.
*
* @param name the name.
- * @return the namespace object.
+ * @return The namespace object.
*/
Object resolveNamespace(String name);
}
@@ -183,7 +183,7 @@ public interface JexlContext {
* it can safely alter its boolean flags during execution with no effect, avoiding any behavior ambiguity.
* </p>
*
- * @return the engine options.
+ * @return The engine options.
*/
JexlOptions getEngineOptions();
}
@@ -252,7 +252,7 @@ public interface JexlContext {
* Gets the value of a variable.
*
* @param name the variable's name.
- * @return the value.
+ * @return The value.
*/
Object get(String name);
diff --git a/src/main/java/org/apache/commons/jexl3/JexlEngine.java b/src/main/java/org/apache/commons/jexl3/JexlEngine.java
index bba934f9..339f61fe 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlEngine.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlEngine.java
@@ -118,21 +118,21 @@ public abstract class JexlEngine {
/**
* The MathContext instance used for +,-,/,*,% operations on big decimals.
*
- * @return the math context
+ * @return The math context
*/
MathContext getArithmeticMathContext();
/**
* The BigDecimal scale used for comparison and coercion operations.
*
- * @return the scale
+ * @return The scale
*/
int getArithmeticMathScale();
/**
* The charset used for parsing.
*
- * @return the charset
+ * @return The charset
*/
Charset getCharset();
@@ -201,7 +201,7 @@ public abstract class JexlEngine {
/**
* Accesses the current thread local context.
*
- * @return the context or null
+ * @return The context or null
*/
public static JexlContext.ThreadLocal getThreadContext() {
return CONTEXT.get();
@@ -212,7 +212,7 @@ public abstract class JexlEngine {
* <p>Advanced: you should only use this to retrieve the engine within a method/ctor called through the evaluation
* of a script/expression.</p>
*
- * @return the engine or null
+ * @return The engine or null
*/
public static JexlEngine getThreadEngine() {
return ENGINE.get();
@@ -233,7 +233,7 @@ public abstract class JexlEngine {
* Creates a string from a reader.
*
* @param reader to be read.
- * @return the contents of the reader as a String.
+ * @return The contents of the reader as a String.
* @throws IOException on any error reading the reader.
*/
protected static String toString(final BufferedReader reader) throws IOException {
@@ -466,14 +466,14 @@ public abstract class JexlEngine {
/**
* Gets this engine underlying {@link JexlArithmetic}.
*
- * @return the arithmetic
+ * @return The arithmetic
*/
public abstract JexlArithmetic getArithmetic();
/**
* Gets the charset used for parsing.
*
- * @return the charset
+ * @return The charset
*/
public abstract Charset getCharset();
@@ -486,7 +486,7 @@ public abstract class JexlEngine {
* @param context the evaluation context
* @param bean the bean to get properties from
* @param expr the property expression
- * @return the value of the property
+ * @return The value of the property
* @throws JexlException if there is an error parsing the expression or during evaluation
*/
public abstract Object getProperty(JexlContext context, Object bean, String expr);
@@ -503,7 +503,7 @@ public abstract class JexlEngine {
*
* @param bean the bean to get properties from
* @param expr the property expression
- * @return the value of the property
+ * @return The value of the property
* @throws JexlException if there is an error parsing the expression or during evaluation
*/
public abstract Object getProperty(Object bean, String expr);
@@ -511,7 +511,7 @@ public abstract class JexlEngine {
/**
* Gets this engine underlying {@link JexlUberspect}.
*
- * @return the uberspect
+ * @return The uberspect
*/
public abstract JexlUberspect getUberspect();
@@ -521,7 +521,7 @@ public abstract class JexlEngine {
* @param obj the method's invoker object
* @param meth the method's name
* @param args the method's arguments
- * @return the method returned value or null if it failed and engine is silent
+ * @return The method returned value or null if it failed and engine is silent
* @throws JexlException if method could not be found or failed and engine is not silent
*/
public abstract Object invokeMethod(Object obj, String meth, Object... args);
@@ -569,7 +569,7 @@ public abstract class JexlEngine {
* @param <T> the type of object
* @param clazz the class to instantiate
* @param args the constructor arguments
- * @return the created object instance or null on failure when silent
+ * @return The created object instance or null on failure when silent
*/
public abstract <T> T newInstance(Class<? extends T> clazz, Object... args);
@@ -578,7 +578,7 @@ public abstract class JexlEngine {
*
* @param clazz the name of the class to instantiate resolved through this engine's class loader
* @param args the constructor arguments
- * @return the created object instance or null on failure when silent
+ * @return The created object instance or null on failure when silent
*/
public abstract Object newInstance(String clazz, Object... args);
@@ -586,7 +586,7 @@ public abstract class JexlEngine {
* Reads a JEXL source from a File.
*
* @param file the script file
- * @return the source
+ * @return The source
*/
protected String readSource(final File file) {
Objects.requireNonNull(file, "file");
@@ -601,7 +601,7 @@ public abstract class JexlEngine {
* Reads a JEXL source from an URL.
*
* @param url the script url
- * @return the source
+ * @return The source
*/
protected String readSource(final URL url) {
Objects.requireNonNull(url, "url");
diff --git a/src/main/java/org/apache/commons/jexl3/JexlException.java b/src/main/java/org/apache/commons/jexl3/JexlException.java
index bc528766..c6d3851c 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlException.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlException.java
@@ -83,7 +83,7 @@ public class JexlException extends RuntimeException {
* Tries to remove this ambiguity in the source.
*
* @param src the source that triggered this exception
- * @return the source with the ambiguous statement removed
+ * @return The source with the ambiguous statement removed
* or null if no recovery was possible
*/
public String tryCleanSource(final String src) {
@@ -121,7 +121,7 @@ public class JexlException extends RuntimeException {
/**
* Gets the annotation name
*
- * @return the annotation name
+ * @return The annotation name
*/
public String getAnnotation() {
return getDetail();
@@ -313,7 +313,7 @@ public class JexlException extends RuntimeException {
/**
* Gets the method name
*
- * @return the method name
+ * @return The method name
*/
public String getMethod() {
final String signature = getMethodSignature();
@@ -324,7 +324,7 @@ public class JexlException extends RuntimeException {
/**
* Gets the method signature.
*
- * @return the method signature
+ * @return The method signature
* @since 3.2
*/
public String getMethodSignature() {
@@ -359,7 +359,7 @@ public class JexlException extends RuntimeException {
/**
* Gets the method name
*
- * @return the method name
+ * @return The method name
*/
public String getSymbol() {
return getDetail();
@@ -459,7 +459,7 @@ public class JexlException extends RuntimeException {
/**
* Gets the property name
*
- * @return the property name
+ * @return The property name
*/
public String getProperty() {
return getDetail();
@@ -501,7 +501,7 @@ public class JexlException extends RuntimeException {
/**
* Gets the returned value
*
- * @return the returned value
+ * @return The returned value
*/
public Object getValue() {
return result;
@@ -558,7 +558,7 @@ public class JexlException extends RuntimeException {
/**
* Gets the thrown value
*
- * @return the thrown value
+ * @return The thrown value
*/
public Object getValue() {
return result;
@@ -653,7 +653,7 @@ public class JexlException extends RuntimeException {
/**
* Gets the variable name
*
- * @return the variable name
+ * @return The variable name
*/
public String getVariable() {
return getDetail();
@@ -690,7 +690,7 @@ public class JexlException extends RuntimeException {
* Stringifies the variable issue.
*
* @param var the variable name
- * @return the issue message
+ * @return The issue message
*/
public String message(final String var) {
switch(this) {
@@ -716,7 +716,7 @@ public class JexlException extends RuntimeException {
*
* @param node the node where the error occurred
* @param annotation the annotation name
- * @return the error message
+ * @return The error message
* @since 3.1
*/
public static String annotationError(final JexlNode node, final String annotation) {
@@ -732,7 +732,7 @@ public class JexlException extends RuntimeException {
*
* @param <X> the throwable type
* @param xthrow the throwable
- * @return the throwable
+ * @return The throwable
*/
static <X extends Throwable> X clean(final X xthrow) {
if (xthrow != null) {
@@ -792,7 +792,7 @@ public class JexlException extends RuntimeException {
*
* @param node the node
* @param info the information
- * @return the information or null
+ * @return The information or null
*/
static JexlInfo detailedInfo(final JexlNode node, final JexlInfo info) {
if (info != null && node != null) {
@@ -832,7 +832,7 @@ public class JexlException extends RuntimeException {
*
* @param node the node
* @param info the information
- * @return the information or null
+ * @return The information or null
* @deprecated 3.2
*/
@Deprecated
@@ -845,7 +845,7 @@ public class JexlException extends RuntimeException {
*
* @param info the node
* @param cause the cause
- * @return the info to use
+ * @return The info to use
*/
static JexlInfo merge(final JexlInfo info, final JavaccError cause) {
if (cause == null || cause.getLine() < 0) {
@@ -862,7 +862,7 @@ public class JexlException extends RuntimeException {
*
* @param node the node where the error occurred
* @param method the method name
- * @return the error message
+ * @return The error message
* @deprecated 3.2
*/
@Deprecated
@@ -876,7 +876,7 @@ public class JexlException extends RuntimeException {
* @param node the node where the error occurred
* @param method the method name
* @param args the method arguments
- * @return the error message
+ * @return The error message
*/
public static String methodError(final JexlNode node, final String method, final Object[] args) {
final StringBuilder msg = errorAt(node);
@@ -915,7 +915,7 @@ public class JexlException extends RuntimeException {
*
* @param node the node where the error occurred
* @param symbol the operator name
- * @return the error message
+ * @return The error message
*/
public static String operatorError(final JexlNode node, final String symbol) {
final StringBuilder msg = errorAt(node);
@@ -930,7 +930,7 @@ public class JexlException extends RuntimeException {
*
* @param node the node where the error occurred
* @param var the variable
- * @return the error message
+ * @return The error message
* @deprecated 3.2
*/
@Deprecated
@@ -944,7 +944,7 @@ public class JexlException extends RuntimeException {
* @param node the node where the error occurred
* @param pty the property
* @param undef whether the property is null or undefined
- * @return the error message
+ * @return The error message
*/
public static String propertyError(final JexlNode node, final String pty, final boolean undef) {
final StringBuilder msg = errorAt(node);
@@ -967,7 +967,7 @@ public class JexlException extends RuntimeException {
* @param fromc the beginning column
* @param tol the ending line
* @param toc the ending column
- * @return the source with the zone from (from) to (to) removed
+ * @return The source with the zone from (from) to (to) removed
*/
public static String sliceSource(final String src, final int froml, final int fromc, final int tol, final int toc) {
final BufferedReader reader = new BufferedReader(new StringReader(src));
@@ -1012,7 +1012,7 @@ public class JexlException extends RuntimeException {
* Unwraps the cause of a throwable due to reflection.
*
* @param xthrow the throwable
- * @return the cause
+ * @return The cause
*/
static Throwable unwrap(final Throwable xthrow) {
if (xthrow instanceof TryFailed
@@ -1029,7 +1029,7 @@ public class JexlException extends RuntimeException {
* @param node the node where the error occurred
* @param variable the variable
* @param undef whether the variable is null or undefined
- * @return the error message
+ * @return The error message
* @deprecated 3.2
*/
@Deprecated
@@ -1043,7 +1043,7 @@ public class JexlException extends RuntimeException {
* @param node the node where the error occurred
* @param variable the variable
* @param issue the variable kind of issue
- * @return the error message
+ * @return The error message
*/
public static String variableError(final JexlNode node, final String variable, final VariableIssue issue) {
final StringBuilder msg = errorAt(node);
@@ -1122,7 +1122,7 @@ public class JexlException extends RuntimeException {
/**
* Accesses the detailed message.
*
- * @return the message
+ * @return The message
*/
protected String detailedMessage() {
final Class<? extends JexlException> clazz = getClass();
@@ -1143,7 +1143,7 @@ public class JexlException extends RuntimeException {
/**
* Gets the specific information for this exception.
*
- * @return the information
+ * @return The information
*/
public JexlInfo getInfo() {
return detailedInfo(mark, info);
@@ -1184,7 +1184,7 @@ public class JexlException extends RuntimeException {
/**
* Pleasing checkstyle.
*
- * @return the info
+ * @return The info
*/
protected JexlInfo info() {
return info;
@@ -1195,7 +1195,7 @@ public class JexlException extends RuntimeException {
*
* @param prefix the prefix to the message
* @param expr the expression in error
- * @return the formatted message
+ * @return The formatted message
*/
protected String parserError(final String prefix, final String expr) {
final int length = expr.length();
diff --git a/src/main/java/org/apache/commons/jexl3/JexlExpression.java b/src/main/java/org/apache/commons/jexl3/JexlExpression.java
index dfe37aaa..bb745d47 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlExpression.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlExpression.java
@@ -44,7 +44,7 @@ public interface JexlExpression {
* <p>The interpreter will handle interruption/cancellation gracefully if needed.</p>
*
* @param context the context
- * @return the callable
+ * @return The callable
* @since 3.1
*/
Callable<Object> callable(JexlContext context);
@@ -62,14 +62,14 @@ public interface JexlExpression {
/**
* Recreates the source text of this expression from the internal syntactic tree.
*
- * @return the source text
+ * @return The source text
*/
String getParsedText();
/**
* Returns the source text of this expression.
*
- * @return the source text
+ * @return The source text
*/
String getSourceText();
}
diff --git a/src/main/java/org/apache/commons/jexl3/JexlFeatures.java b/src/main/java/org/apache/commons/jexl3/JexlFeatures.java
index 3234d86d..afc7d62e 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlFeatures.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlFeatures.java
@@ -303,7 +303,7 @@ public final class JexlFeatures {
* The text corresponding to a feature code.
*
* @param feature the feature number
- * @return the feature name
+ * @return The feature name
*/
public static String stringify(final int feature) {
return feature >= 0 && feature < F_NAMES.length ? F_NAMES[feature] : "unsupported feature";
@@ -490,7 +490,7 @@ public final class JexlFeatures {
/**
* Gets the immutable set of reserved names.
*
- * @return the (unmodifiable) set of reserved names.
+ * @return The (unmodifiable) set of reserved names.
*/
public Set<String> getReservedNames() {
return reservedNames;
@@ -692,7 +692,7 @@ public final class JexlFeatures {
/**
* Gets the declared namespaces test.
*
- * @return the declared namespaces test.
+ * @return The declared namespaces test.
*/
public Predicate<String> namespaceTest() {
return nameSpaces;
diff --git a/src/main/java/org/apache/commons/jexl3/JexlInfo.java b/src/main/java/org/apache/commons/jexl3/JexlInfo.java
index d5e48bf1..9512d681 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlInfo.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlInfo.java
@@ -33,21 +33,21 @@ public class JexlInfo {
/**
* Gets the end column on the line that triggered the error
*
- * @return the end column on the line that triggered the error
+ * @return The end column on the line that triggered the error
*/
int end();
/**
* Gets the start column on the line that triggered the error
*
- * @return the start column on the line that triggered the error
+ * @return The start column on the line that triggered the error
*/
int start();
/**
* Gets the code that triggered the error
*
- * @return the actual part of code that triggered the error
+ * @return The actual part of code that triggered the error
*/
@Override
String toString();
@@ -57,7 +57,7 @@ public class JexlInfo {
* Gets the info from a script.
*
* @param script the script
- * @return the info
+ * @return The info
*/
public static JexlInfo from(final JexlScript script) {
return script instanceof Script? ((Script) script).getInfo() : null;
@@ -146,7 +146,7 @@ public class JexlInfo {
/**
* Gets the column number.
*
- * @return the column.
+ * @return The column.
*/
public final int getColumn() {
return column;
@@ -155,7 +155,7 @@ public class JexlInfo {
/**
* Gets error detail
*
- * @return the detailed information in case of an error
+ * @return The detailed information in case of an error
*/
public Detail getDetail() {
return null;
@@ -182,7 +182,7 @@ public class JexlInfo {
/**
* Formats this info in the form 'name@line:column'.
*
- * @return the formatted info
+ * @return The formatted info
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/jexl3/JexlOperator.java b/src/main/java/org/apache/commons/jexl3/JexlOperator.java
index b0ce360b..2166ba26 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlOperator.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlOperator.java
@@ -549,7 +549,7 @@ public enum JexlOperator {
/**
* Gets this operator number of parameters.
*
- * @return the method arity
+ * @return The method arity
*/
public int getArity() {
return arity;
@@ -558,7 +558,7 @@ public enum JexlOperator {
/**
* Gets the base operator.
*
- * @return the base operator
+ * @return The base operator
*/
public final JexlOperator getBaseOperator() {
return base;
@@ -567,7 +567,7 @@ public enum JexlOperator {
/**
* Gets this operator method name in a JexlArithmetic.
*
- * @return the method name
+ * @return The method name
*/
public final String getMethodName() {
return methodName;
@@ -576,7 +576,7 @@ public enum JexlOperator {
/**
* Gets this operator symbol.
*
- * @return the symbol
+ * @return The symbol
*/
public final String getOperatorSymbol() {
return operator;
@@ -635,7 +635,7 @@ public enum JexlOperator {
*
* @param node an optional reference caching resolved method or failing signature
* @param object the object to get the size of
- * @return the evaluation result
+ * @return The evaluation result
*/
Object size(JexlCache.Reference node, Object object);
@@ -647,7 +647,7 @@ public enum JexlOperator {
*
* @param node the node holding the object
* @param object the object to check the emptiness of
- * @return the evaluation result
+ * @return The evaluation result
*/
Object empty(JexlCache.Reference node, Object object);
diff --git a/src/main/java/org/apache/commons/jexl3/JexlOptions.java b/src/main/java/org/apache/commons/jexl3/JexlOptions.java
index c3e0d638..d545f721 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlOptions.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlOptions.java
@@ -95,7 +95,7 @@ public final class JexlOptions {
*
* @param ordinal the flag ordinal
* @param mask the flags mask
- * @return the mask value with this flag or-ed in
+ * @return The mask value with this flag or-ed in
*/
private static boolean isSet(final int ordinal, final int mask) {
return (mask & 1 << ordinal) != 0;
@@ -109,7 +109,7 @@ public final class JexlOptions {
*
* @param initial the initial mask state
* @param flags the flags to set
- * @return the flag mask updated
+ * @return The flag mask updated
*/
public static int parseFlags(final int initial, final String... flags) {
int mask = initial;
@@ -144,7 +144,7 @@ public final class JexlOptions {
* @param ordinal the flag ordinal
* @param mask the flags mask
* @param value true or false
- * @return the new flags mask value
+ * @return The new flags mask value
*/
private static int set(final int ordinal, final int mask, final boolean value) {
return value? mask | 1 << ordinal : mask & ~(1 << ordinal);
@@ -204,7 +204,7 @@ public final class JexlOptions {
/**
* Gets the optional set of imported packages.
*
- * @return the set of imports, may be empty, not null
+ * @return The set of imports, may be empty, not null
*/
public Collection<String> getImports() {
return imports;
@@ -213,7 +213,7 @@ public final class JexlOptions {
/**
* The MathContext instance used for +,-,/,*,% operations on big decimals.
*
- * @return the math context
+ * @return The math context
*/
public MathContext getMathContext() {
return mathContext;
@@ -222,7 +222,7 @@ public final class JexlOptions {
/**
* The BigDecimal scale used for comparison and coercion operations.
*
- * @return the scale
+ * @return The scale
*/
public int getMathScale() {
return mathScale;
@@ -231,7 +231,7 @@ public final class JexlOptions {
/**
* Gets the optional map of namespaces.
*
- * @return the map of namespaces, may be empty, not null
+ * @return The map of namespaces, may be empty, not null
*/
public Map<String, Object> getNamespaces() {
return namespaces;
diff --git a/src/main/java/org/apache/commons/jexl3/JexlScript.java b/src/main/java/org/apache/commons/jexl3/JexlScript.java
index 26a3cc37..5521f2c4 100644
--- a/src/main/java/org/apache/commons/jexl3/JexlScript.java
+++ b/src/main/java/org/apache/commons/jexl3/JexlScript.java
@@ -46,7 +46,7 @@ public interface JexlScript {
* <p>The interpreter will handle interruption/cancellation gracefully if needed.</p>
*
* @param context the context
- * @return the callable
+ * @return The callable
* @since 2.1
*/
Callable<Object> callable(JexlContext context);
@@ -59,7 +59,7 @@ public interface JexlScript {
*
* @param context the context
* @param args the script arguments
- * @return the callable
+ * @return The callable
* @since 2.1
*/
Callable<Object> callable(JexlContext context, Object... args);
@@ -71,7 +71,7 @@ public interface JexlScript {
* no error is generated and this script is returned.</p>
*
* @param args the arguments to bind
- * @return the curried script or this script if no binding can occur
+ * @return The curried script or this script if no binding can occur
*/
JexlScript curry(Object... args);
@@ -101,7 +101,7 @@ public interface JexlScript {
/**
* Gets this script local variables.
*
- * @return the local variables or null
+ * @return The local variables or null
* @since 2.1
*/
String[] getLocalVariables();
@@ -109,7 +109,7 @@ public interface JexlScript {
/**
* Gets this script parameters.
*
- * @return the parameters or null
+ * @return The parameters or null
* @since 2.1
*/
String[] getParameters();
@@ -117,7 +117,7 @@ public interface JexlScript {
/**
* Recreates the source text of this expression from the internal syntactic tree.
*
- * @return the source text
+ * @return The source text
*/
String getParsedText();
@@ -125,21 +125,21 @@ public interface JexlScript {
* Recreates the source text of this expression from the internal syntactic tree.
*
* @param indent the number of spaces for indentation, 0 meaning no indentation
- * @return the source text
+ * @return The source text
*/
String getParsedText(int indent);
/**
* Gets this script pragmas.
*
- * @return the (non null, may be empty) pragmas map
+ * @return The (non null, may be empty) pragmas map
*/
Map<String, Object> getPragmas();
/**
* Returns the source text of this expression.
*
- * @return the source text
+ * @return The source text
*/
String getSourceText();
@@ -147,7 +147,7 @@ public interface JexlScript {
* Gets this script unbound parameters.
* <p>Parameters that haven't been bound by a previous call to curry().</p>
*
- * @return the parameters or null
+ * @return The parameters or null
* @since 3.2
*/
String[] getUnboundParameters();
@@ -157,7 +157,7 @@ public interface JexlScript {
* <p>Note that since variables can be in an ant-ish form (ie foo.bar.quux), each variable is returned as
* a list of strings where each entry is a fragment of the variable ({"foo", "bar", "quux"} in the example.</p>
*
- * @return the variables or null
+ * @return The variables or null
* @since 2.1
*/
Set<List<String>> getVariables();
diff --git a/src/main/java/org/apache/commons/jexl3/JxltEngine.java b/src/main/java/org/apache/commons/jexl3/JxltEngine.java
index 052eb9db..817a0080 100644
--- a/src/main/java/org/apache/commons/jexl3/JxltEngine.java
+++ b/src/main/java/org/apache/commons/jexl3/JxltEngine.java
@@ -115,7 +115,7 @@ public abstract class JxltEngine {
/**
* Generates this expression's string representation.
*
- * @return the string representation
+ * @return The string representation
*/
String asString();
@@ -123,7 +123,7 @@ public abstract class JxltEngine {
* Adds this expression's string representation to a StringBuilder.
*
* @param strb the builder to fill
- * @return the builder argument
+ * @return The builder argument
*/
StringBuilder asString(StringBuilder strb);
@@ -133,7 +133,7 @@ public abstract class JxltEngine {
* <p>If the underlying JEXL engine is silent, errors will be logged through its logger as warning.</p>
*
* @param context the variable context
- * @return the result of this expression evaluation or null if an error occurs and the {@link JexlEngine} is
+ * @return The result of this expression evaluation or null if an error occurs and the {@link JexlEngine} is
* running in silent mode
* @throws Exception if an error occurs and the {@link JexlEngine}
* is not silent
@@ -147,7 +147,7 @@ public abstract class JxltEngine {
* original expression that lead to it.</p>
* <p>Other expressions return themselves.</p>
*
- * @return the source expression
+ * @return The source expression
*/
Expression getSource();
@@ -156,7 +156,7 @@ public abstract class JxltEngine {
* <p>This method will visit all nodes of the sub-expressions and extract all variables whether they
* are written in 'dot' or 'bracketed' notation. (a.b is equivalent to a['b']).</p>
*
- * @return the set of variables, each as a list of strings (ant-ish variables use more than 1 string)
+ * @return The set of variables, each as a list of strings (ant-ish variables use more than 1 string)
* or the empty set if no variables are used
*/
Set<List<String>> getVariables();
@@ -200,7 +200,7 @@ public abstract class JxltEngine {
* Formats this expression, adding its source string representation in
* comments if available: 'expression /*= source *\/'' .
*
- * @return the formatted expression string
+ * @return The formatted expression string
*/
@Override
String toString();
@@ -257,7 +257,7 @@ public abstract class JxltEngine {
/**
* Recreate the template source from its inner components.
*
- * @return the template source rewritten
+ * @return The template source rewritten
*/
String asString();
@@ -281,14 +281,14 @@ public abstract class JxltEngine {
/**
* Gets the list of parameters expected by this template.
*
- * @return the parameter names array
+ * @return The parameter names array
*/
String[] getParameters();
/**
* Gets this script pragmas.
*
- * @return the (non-null, possibly empty) pragmas map
+ * @return The (non-null, possibly empty) pragmas map
* @since 3.1
*/
Map<String, Object> getPragmas();
@@ -298,7 +298,7 @@ public abstract class JxltEngine {
* <p>This method will visit all nodes of the sub-expressions and extract all variables whether they
* are written in 'dot' or 'bracketed' notation. (a.b is equivalent to a['b']).</p>
*
- * @return the set of variables, each as a list of strings (ant-ish variables use more than 1 string)
+ * @return The set of variables, each as a list of strings (ant-ish variables use more than 1 string)
* or the empty set if no variables are used
*/
Set<List<String>> getVariables();
@@ -307,7 +307,7 @@ public abstract class JxltEngine {
* Prepares this template by expanding any contained deferred TemplateExpression.
*
* @param context the context to prepare against
- * @return the prepared version of the template
+ * @return The prepared version of the template
*/
Template prepare(JexlContext context);
@@ -318,7 +318,7 @@ public abstract class JxltEngine {
*
* @param context the context to prepare against
* @param args the arguments to bind (optional)
- * @return the prepared version of the template
+ * @return The prepared version of the template
* @since 3.6.2
*/
default Template prepare(final JexlContext context, final Object... args) {
@@ -341,7 +341,7 @@ public abstract class JxltEngine {
*
* @param info the {@link JexlInfo} source information
* @param expression the {@link Template} string expression
- * @return the {@link Expression}, null if silent and an error occurred
+ * @return The {@link Expression}, null if silent and an error occurred
* @throws Exception if an error occurs and the {@link JexlEngine} is not silent
*/
public abstract Expression createExpression(JexlInfo info, String expression);
@@ -353,7 +353,7 @@ public abstract class JxltEngine {
* <p>If the underlying JEXL engine is silent, errors will be logged through its logger as warnings.</p>
*
* @param expression the {@link Template} string expression
- * @return the {@link Expression}, null if silent and an error occurred
+ * @return The {@link Expression}, null if silent and an error occurred
* @throws Exception if an error occurs and the {@link JexlEngine} is not silent
*/
public Expression createExpression(final String expression) {
@@ -365,7 +365,7 @@ public abstract class JxltEngine {
*
* @param info the source info
* @param source the source
- * @return the template
+ * @return The template
*/
public Template createTemplate(final JexlInfo info, final String source) {
return createTemplate(info, "$$", new StringReader(source), (String[]) null);
@@ -378,7 +378,7 @@ public abstract class JxltEngine {
* @param prefix the directive prefix
* @param source the source
* @param parms the parameter names
- * @return the template
+ * @return The template
*/
public abstract Template createTemplate(JexlInfo info, String prefix, Reader source, String... parms);
@@ -388,7 +388,7 @@ public abstract class JxltEngine {
* @param info the source info
* @param parms the parameter names
* @param source the source
- * @return the template
+ * @return The template
*/
public Template createTemplate(final JexlInfo info, final String source, final String... parms) {
return createTemplate(info, "$$", new StringReader(source), parms);
@@ -398,7 +398,7 @@ public abstract class JxltEngine {
* Creates a new template.
*
* @param source the source
- * @return the template
+ * @return The template
*/
public Template createTemplate(final String source) {
return createTemplate(null, source);
@@ -410,7 +410,7 @@ public abstract class JxltEngine {
* @param prefix the directive prefix
* @param source the source
* @param parms the parameter names
- * @return the template
+ * @return The template
*/
public Template createTemplate(final String prefix, final Reader source, final String... parms) {
return createTemplate(null, prefix, source, parms);
@@ -421,7 +421,7 @@ public abstract class JxltEngine {
*
* @param source the source
* @param parms the parameter names
- * @return the template
+ * @return The template
*/
public Template createTemplate(final String source, final String... parms) {
return createTemplate(null, source, parms);
@@ -430,7 +430,7 @@ public abstract class JxltEngine {
/**
* Gets the {@link JexlEngine} underlying this template engine.
*
- * @return the JexlEngine
+ * @return The JexlEngine
*/
public abstract JexlEngine getEngine();
}
diff --git a/src/main/java/org/apache/commons/jexl3/ObjectContext.java b/src/main/java/org/apache/commons/jexl3/ObjectContext.java
index cd90cbf5..09075b36 100644
--- a/src/main/java/org/apache/commons/jexl3/ObjectContext.java
+++ b/src/main/java/org/apache/commons/jexl3/ObjectContext.java
@@ -62,7 +62,7 @@ public class ObjectContext<T> implements JexlContext, JexlContext.NamespaceResol
/**
* Gets the Jexl engine
*
- * @return the Jexl engine
+ * @return The Jexl engine
*/
protected JexlEngine getJexl() {
return jexl;
@@ -71,7 +71,7 @@ public class ObjectContext<T> implements JexlContext, JexlContext.NamespaceResol
/**
* Gets the object exposed by this context
*
- * @return the object exposed by this context
+ * @return The object exposed by this context
*/
protected T getObject() {
return object;
diff --git a/src/main/java/org/apache/commons/jexl3/internal/ArrayBuilder.java b/src/main/java/org/apache/commons/jexl3/internal/ArrayBuilder.java
index 97750c3e..2d5fbab9 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/ArrayBuilder.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/ArrayBuilder.java
@@ -52,7 +52,7 @@ public class ArrayBuilder implements JexlArithmetic.ArrayBuilder {
* Gets the primitive type of given class (when it exists).
*
* @param parm a class
- * @return the primitive type or null it the argument is not unboxable
+ * @return The primitive type or null it the argument is not unboxable
*/
protected static Class<?> unboxingClass(final Class<?> parm) {
return BOXING_CLASSES.getOrDefault(parm, parm);
@@ -169,7 +169,7 @@ public class ArrayBuilder implements JexlArithmetic.ArrayBuilder {
*
* @param clazz the class
* @param size the size
- * @return the instance
+ * @return The instance
* @param <T> The type
*/
protected <T> List<T> newList(final Class<? extends T> clazz, final int size) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/Debugger.java b/src/main/java/org/apache/commons/jexl3/internal/Debugger.java
index 3e92ceff..67c36333 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/Debugger.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/Debugger.java
@@ -262,7 +262,7 @@ public class Debugger extends ParserVisitor implements JexlInfo.Detail {
* Rebuilds an expression from a JEXL node.
*
* @param node the node to rebuilt from
- * @return the rebuilt expression
+ * @return The rebuilt expression
* @since 3.0
*/
public String data(final JexlNode node) {
@@ -366,7 +366,7 @@ public class Debugger extends ParserVisitor implements JexlInfo.Detail {
* Tries (hard) to find the features used to parse a node.
*
* @param node the node
- * @return the features or null
+ * @return The features or null
*/
protected JexlFeatures getFeatures(final JexlNode node) {
JexlNode walk = node;
@@ -1526,7 +1526,7 @@ public class Debugger extends ParserVisitor implements JexlInfo.Detail {
*
* @param p the parameter name
* @param data the visitor argument
- * @return the parameter name to use
+ * @return The parameter name to use
*/
protected String visitParameter(final String p, final Object data) {
return p;
diff --git a/src/main/java/org/apache/commons/jexl3/internal/Engine.java b/src/main/java/org/apache/commons/jexl3/internal/Engine.java
index a3e585c4..4df0ed9e 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/Engine.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/Engine.java
@@ -154,7 +154,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
}
/**
- *@return the collected variables
+ *@return The collected variables
*/
public Set<List<String>> collected() {
return refs;
@@ -474,7 +474,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
*
* @param clazz the class to instantiate
* @param args the constructor arguments
- * @return the created object instance or null on failure when silent
+ * @return The created object instance or null on failure when silent
*/
protected Object doCreateInstance(final Object clazz, final Object... args) {
JexlException xjexl = null;
@@ -513,7 +513,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
*
* @param script the script
* @param context the context
- * @return the options
+ * @return The options
*/
protected JexlOptions evalOptions(final ASTJexlScript script, final JexlContext context) {
final JexlOptions opts = evalOptions(context);
@@ -543,7 +543,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* is false, this method creates a copy of the options making them immutable during execution.
*
* @param context the context
- * @return the options if any
+ * @return The options if any
*/
protected JexlOptions evalOptions(final JexlContext context) {
// Make a copy of the handled options if any
@@ -562,7 +562,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* Obsolete version of options evaluation.
*
* @param opts the obsolete instance of options
- * @return the newer class of options
+ * @return The newer class of options
*/
private JexlOptions evalOptions(final JexlEngine.Options opts) {
// This condition and block for compatibility between 3.1 and 3.2
@@ -592,7 +592,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* Gets the array of local variable from a script.
*
* @param script the script
- * @return the local variables array which may be empty (but not null) if no local variables were defined
+ * @return The local variables array which may be empty (but not null) if no local variables were defined
* @since 3.0
* @deprecated 3.6.1
*/
@@ -605,7 +605,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* Solves a namespace using this engine map of functions.
*
* @param name the namespoce name
- * @return the object associated
+ * @return The object associated
*/
final Object getNamespace(final String name) {
return functions.get(name);
@@ -615,7 +615,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* Gets the array of parameters from a script.
*
* @param script the script
- * @return the parameters which may be empty (but not null) if no parameters were defined
+ * @return The parameters which may be empty (but not null) if no parameters were defined
* @since 3.0
* @deprecated 3.6.1
*/
@@ -663,7 +663,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* are written in 'dot' or 'bracketed' notation. (a.b is equivalent to a['b']).</p>
*
* @param script the script
- * @return the set of variables, each as a list of strings (ant-ish variables use more than 1 string)
+ * @return The set of variables, each as a list of strings (ant-ish variables use more than 1 string)
* or the empty set if no variables are used
*/
protected Set<List<String>> getVariables(final ASTJexlScript script) {
@@ -810,7 +810,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* Sets options from this engine options.
*
* @param opts the options to set
- * @return the options
+ * @return The options
*/
public JexlOptions optionsSet(final JexlOptions opts) {
if (opts != null) {
@@ -826,7 +826,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* @param parsingf the set of parsing features
* @param src the expression to parse
* @param scope the script frame
- * @return the parsed tree
+ * @return The parsed tree
* @throws JexlException if any error occurred during parsing
*/
protected ASTJexlScript parse(final JexlInfo info, final JexlFeatures parsingf, final String src, final Scope scope) {
@@ -875,7 +875,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* @param expr whether to parse an expression or a script
* @param src the source to parse
* @param scope the scope, maybe null
- * @return the parsed tree
+ * @return The parsed tree
*/
protected ASTJexlScript jxltParse(final JexlInfo info, final boolean expr, final String src, final Scope scope) {
synchronized(parsing) {
@@ -1021,7 +1021,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* Swaps the current thread local engine.
*
* @param jexl the engine or null
- * @return the previous thread local engine
+ * @return The previous thread local engine
*/
protected JexlEngine putThreadEngine(final JexlEngine jexl) {
final JexlEngine pjexl = ENGINE.get();
@@ -1033,7 +1033,7 @@ public class Engine extends JexlEngine implements JexlUberspect.ConstantResolver
* Swaps the current thread local context.
*
* @param tls the context or null
- * @return the previous thread local context
+ * @return The previous thread local context
*/
protected JexlContext.ThreadLocal putThreadLocal(final JexlContext.ThreadLocal tls) {
final JexlContext.ThreadLocal local = CONTEXT.get();
diff --git a/src/main/java/org/apache/commons/jexl3/internal/Engine32.java b/src/main/java/org/apache/commons/jexl3/internal/Engine32.java
index 24bfe598..dc40f487 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/Engine32.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/Engine32.java
@@ -44,7 +44,7 @@ public class Engine32 extends Engine {
* @param frame the frame
* @param block the scope
* @param identifier the variable identifier
- * @return the variable value
+ * @return The variable value
*/
static Object getVariable(final Interpreter ii, final Frame frame, final LexicalScope block, final ASTIdentifier identifier) {
final int symbol = identifier.getSymbol();
diff --git a/src/main/java/org/apache/commons/jexl3/internal/FqcnResolver.java b/src/main/java/org/apache/commons/jexl3/internal/FqcnResolver.java
index 141d8310..0788b3fb 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/FqcnResolver.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/FqcnResolver.java
@@ -83,7 +83,7 @@ public class FqcnResolver implements JexlUberspect.ClassConstantResolver {
* Gets a fully qualified class name from a simple class name and imports.
*
* @param name the simple name
- * @return the fqcn
+ * @return The fqcn
*/
String getQualifiedName(final String name) {
String fqcn;
@@ -98,7 +98,7 @@ public class FqcnResolver implements JexlUberspect.ClassConstantResolver {
* <p>It tries to solve the class name as package.classname or package$classname (inner class).</p>
*
* @param name the simple class name
- * @return the fully qualified class name or null if not found
+ * @return The fully qualified class name or null if not found
*/
private String solveClassName(final String name) {
for (final String pkg : imports) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/Frame.java b/src/main/java/org/apache/commons/jexl3/internal/Frame.java
index dbfaf212..2037cb2f 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/Frame.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/Frame.java
@@ -92,7 +92,7 @@ public class Frame {
*
* @param s the offset in this frame
* @param lexical true if this captured symbol is redefined locally
- * @return the stacked value
+ * @return The stacked value
*/
Object capture(final int s, final boolean lexical) {
return stack[s];
@@ -102,7 +102,7 @@ public class Frame {
* Gets a value.
*
* @param s the offset in this frame
- * @return the stacked value
+ * @return The stacked value
*/
Object get(final int s) {
return stack[s];
@@ -130,7 +130,7 @@ public class Frame {
/**
* Gets this script unbound parameters, i.e. parameters not bound through curry().
*
- * @return the parameter names
+ * @return The parameter names
*/
public String[] getUnboundParameters() {
return scope.getParameters(curried);
@@ -152,7 +152,7 @@ public class Frame {
* may point back to it that occur with recursive function definitions.</p>
*
* @param closure the owning closure
- * @return the cleaned-up stack or the stack itself (most of the time)
+ * @return The cleaned-up stack or the stack itself (most of the time)
*/
Object[] nocycleStack(final Closure closure) {
Object[] ns = stack;
diff --git a/src/main/java/org/apache/commons/jexl3/internal/IntegerRange.java b/src/main/java/org/apache/commons/jexl3/internal/IntegerRange.java
index c41da5e9..0a333cfa 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/IntegerRange.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/IntegerRange.java
@@ -234,7 +234,7 @@ public abstract class IntegerRange implements Collection<Integer> {
/**
* Gets the interval maximum value.
*
- * @return the high boundary
+ * @return The high boundary
*/
public int getMax() {
return max;
@@ -243,7 +243,7 @@ public abstract class IntegerRange implements Collection<Integer> {
/**
* Gets the interval minimum value.
*
- * @return the low boundary
+ * @return The low boundary
*/
public int getMin() {
return min;
diff --git a/src/main/java/org/apache/commons/jexl3/internal/Interpreter.java b/src/main/java/org/apache/commons/jexl3/internal/Interpreter.java
index 3d29d66a..cfc5106e 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/Interpreter.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/Interpreter.java
@@ -85,7 +85,7 @@ public class Interpreter extends InterpreterBase {
}
/**
- * @return the actual statement.
+ * @return The actual statement.
*/
public Object getStatement() {
return stmt;
@@ -154,7 +154,7 @@ public class Interpreter extends InterpreterBase {
* @param target the target of the method, what it should be invoked upon
* @param funcNode the object carrying the method or function or the method identifier
* @param argNode the node carrying the arguments
- * @return the result of the method invocation
+ * @return The result of the method invocation
*/
protected Object call(final JexlNode node, final Object target, final Object funcNode, final ASTArguments argNode) {
cancelCheck(node);
@@ -320,7 +320,7 @@ public class Interpreter extends InterpreterBase {
* @param catchBody the body
* @param caught the caught exception
* @param data the data
- * @return the result of body evaluation
+ * @return The result of body evaluation
*/
private Object evalCatch(final ASTReference catchVar, final JexlNode catchBody,
final JexlException caught, final Object data) {
@@ -365,7 +365,7 @@ public class Interpreter extends InterpreterBase {
* static (name or numbered identifier) or dynamic (jxlt).
*
* @param node the identifier access node
- * @return the evaluated identifier
+ * @return The evaluated identifier
*/
private Object evalIdentifier(final ASTIdentifierAccess node) {
if (!(node instanceof ASTIdentifierAccessJxlt)) {
@@ -389,7 +389,7 @@ public class Interpreter extends InterpreterBase {
* <p>This parses and stores the JXLT template if necessary (upon first execution)</p>
*
* @param node the node
- * @return the JXLT template evaluation.
+ * @return The JXLT template evaluation.
* @param <NODE> the node type
*/
private <NODE extends JexlNode & JexlNode.JxltHandle> Object evalJxltHandle(final NODE node) {
@@ -415,7 +415,7 @@ public class Interpreter extends InterpreterBase {
* @param node the node
* @param assignop the assignment operator or null if simply assignment
* @param data the data
- * @return the left hand side
+ * @return The left hand side
*/
protected Object executeAssign(final JexlNode node, final JexlOperator assignop, final Object data) { // CSOFF: MethodLength
cancelCheck(node);
@@ -759,7 +759,7 @@ public class Interpreter extends InterpreterBase {
* its logger as warning.
*
* @param node the script or expression to interpret.
- * @return the result of the interpretation.
+ * @return The result of the interpretation.
* @throws JexlException if any error occurs during interpretation.
*/
public Object interpret(final JexlNode node) {
@@ -833,7 +833,7 @@ public class Interpreter extends InterpreterBase {
*
* @param object the Object
* @param clazz the Class
- * @return the result of isInstance call
+ * @return The result of isInstance call
*/
private boolean isInstance(final Object object, final Object clazz) {
if (object == null || clazz == null) {
@@ -909,7 +909,7 @@ public class Interpreter extends InterpreterBase {
* @param annotation the annotation name
* @param args the annotation arguments
* @param stmt the statement / block that was annotated
- * @return the result of statement.call()
+ * @return The result of statement.call()
* @throws Exception if anything goes wrong
*/
protected Object processAnnotation(final String annotation, final Object[] args, final Callable<Object> stmt) throws Exception {
@@ -922,7 +922,7 @@ public class Interpreter extends InterpreterBase {
* Swaps the current thread local interpreter.
*
* @param inter the interpreter or null
- * @return the previous thread local interpreter
+ * @return The previous thread local interpreter
*/
protected Interpreter putThreadInterpreter(final Interpreter inter) {
final Interpreter pinter = INTER.get();
@@ -934,7 +934,7 @@ public class Interpreter extends InterpreterBase {
* Resolves a class name.
*
* @param name the simple class name
- * @return the fully qualified class name or the name
+ * @return The fully qualified class name or the name
*/
private String resolveClassName(final String name) {
// try with local solver
@@ -957,7 +957,7 @@ public class Interpreter extends InterpreterBase {
* Runs a closure.
*
* @param closure the closure
- * @return the closure return value
+ * @return The closure return value
*/
protected Object runClosure(final Closure closure) {
final ASTJexlScript script = closure.getScript();
@@ -1575,7 +1575,7 @@ public class Interpreter extends InterpreterBase {
* @param node the actual method call node
* @param antish non-null when name.call is an antish variable
* @param data the context
- * @return the method call result
+ * @return The method call result
*/
private Object visit(final ASTMethodNode node, final Object antish, final Object data) {
Object object = antish;
@@ -2315,7 +2315,7 @@ public class Interpreter extends InterpreterBase {
*
* @param node the block
* @param data the usual data
- * @return the result of the last expression evaluation
+ * @return The result of the last expression evaluation
*/
private Object visitBlock(final ASTBlock node, final Object data) {
final int numChildren = node.jjtGetNumChildren();
@@ -2332,7 +2332,7 @@ public class Interpreter extends InterpreterBase {
*
* @param node the node
* @param data the usual data, always null
- * @return the return value
+ * @return The return value
*/
protected Object visitLexicalNode(final JexlNode node, final Object data) {
block = new LexicalFrame(frame, null);
diff --git a/src/main/java/org/apache/commons/jexl3/internal/InterpreterBase.java b/src/main/java/org/apache/commons/jexl3/internal/InterpreterBase.java
index 20a824bb..479c20c4 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/InterpreterBase.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/InterpreterBase.java
@@ -97,7 +97,7 @@ public abstract class InterpreterBase extends ParserVisitor {
* Evaluates the method previously dispatched.
*
* @param methodName the method name
- * @return the method invocation result
+ * @return The method invocation result
* @throws Exception when invocation fails
*/
protected Object eval(final String methodName) throws Exception {
@@ -291,7 +291,7 @@ public abstract class InterpreterBase extends ParserVisitor {
* @param name the method name
* @param target the method target
* @param args the method arguments
- * @return the method invocation result (or JexlEngine.TRY_FAILED)
+ * @return The method invocation result (or JexlEngine.TRY_FAILED)
*/
protected Object tryInvoke(final InterpreterBase ii, final String name, final Object target, final Object[] args) {
return me.tryInvoke(name, target, ii.functionArguments(null, narrow, args));
@@ -306,7 +306,7 @@ public abstract class InterpreterBase extends ParserVisitor {
* <p>Used by calls to unsolvableProperty(...).</p>
*
* @param node the property node
- * @return the (pretty) string value
+ * @return The (pretty) string value
*/
protected static String stringifyPropertyValue(final JexlNode node) {
return node != null ? new Debugger().depth(1).data(node) : "???";
@@ -439,7 +439,7 @@ public abstract class InterpreterBase extends ParserVisitor {
* @param target the pseudo-method owner, first to-be argument
* @param narrow whether we should attempt to narrow number arguments
* @param args the other (non-null) arguments
- * @return the arguments array
+ * @return The arguments array
*/
protected Object[] callArguments(final Object target, final boolean narrow, final Object[] args) {
// makes target 1st args, copy others - optionally narrow numbers
@@ -542,7 +542,7 @@ public abstract class InterpreterBase extends ParserVisitor {
* @param node the parent node
* @param left the left argument
* @param right the right argument
- * @return the left, right or parent node
+ * @return The left, right or parent node
*/
protected JexlNode findNullOperand(final JexlNode node, final Object left, final Object right) {
if (left == null) {
@@ -567,7 +567,7 @@ public abstract class InterpreterBase extends ParserVisitor {
*
* @param narrow whether narrowing should occur
* @param arg the argument
- * @return the narrowed argument
+ * @return The narrowed argument
*/
protected Object functionArgument(final boolean narrow, final Object arg) {
return narrow && arg instanceof Number ? arithmetic.narrow((Number) arg) : arg;
@@ -580,7 +580,7 @@ public abstract class InterpreterBase extends ParserVisitor {
* @param target the pseudo-method owner, first to-be argument
* @param narrow whether we should attempt to narrow number arguments
* @param args the other (non-null) arguments
- * @return the arguments array
+ * @return The arguments array
*/
protected Object[] functionArguments(final Object target, final boolean narrow, final Object[] args) {
// when target == context, we are dealing with the null namespace
@@ -610,7 +610,7 @@ public abstract class InterpreterBase extends ParserVisitor {
* @param object to retrieve value from
* @param attribute the attribute of the object, e.g. an index (1, 0, 2) or key for a map
* @param node the node that evaluated as the object
- * @return the attribute value
+ * @return The attribute value
*/
protected Object getAttribute(final Object object, final Object attribute, final JexlNode node) {
if (object == null) {
@@ -677,7 +677,7 @@ public abstract class InterpreterBase extends ParserVisitor {
* @param frame the local frame
* @param block the lexical block if any
* @param identifier the variable node
- * @return the value
+ * @return The value
*/
protected Object getVariable(final Frame frame, final LexicalScope block, final ASTIdentifier identifier) {
final int symbol = identifier.getSymbol();
@@ -871,7 +871,7 @@ public abstract class InterpreterBase extends ParserVisitor {
*
* @param prefix the prefix name (can be null for global namespace)
* @param node the AST node
- * @return the namespace instance
+ * @return The namespace instance
*/
protected Object resolveNamespace(final String prefix, final JexlNode node) {
Object namespace;
@@ -1078,7 +1078,7 @@ public abstract class InterpreterBase extends ParserVisitor {
* <p>Used by calls to unsolvableProperty(...).</p>
*
* @param node the property node
- * @return the (pretty) string
+ * @return The (pretty) string
*/
protected String stringifyProperty(final JexlNode node) {
if (node instanceof ASTArrayAccess) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/LexicalFrame.java b/src/main/java/org/apache/commons/jexl3/internal/LexicalFrame.java
index f055d030..9823a3cc 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/LexicalFrame.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/LexicalFrame.java
@@ -107,7 +107,7 @@ public class LexicalFrame extends LexicalScope {
/**
* Pops back values and lexical frame.
*
- * @return the previous frame
+ * @return The previous frame
*/
public LexicalFrame pop() {
// undefine all symbols
diff --git a/src/main/java/org/apache/commons/jexl3/internal/LexicalScope.java b/src/main/java/org/apache/commons/jexl3/internal/LexicalScope.java
index 63886f73..1c3608a2 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/LexicalScope.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/LexicalScope.java
@@ -141,7 +141,7 @@ public class LexicalScope {
}
/**
- * @return the number of symbols defined in this scope.
+ * @return The number of symbols defined in this scope.
*/
public int getSymbolCount() {
return count;
@@ -185,7 +185,7 @@ public class LexicalScope {
/**
* Ensures more symbols can be stored.
*
- * @return the set of more symbols
+ * @return The set of more symbols
*/
private BitSet moreBits() {
if (moreSymbols == null) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/LongRange.java b/src/main/java/org/apache/commons/jexl3/internal/LongRange.java
index 5e6c378a..d4e61cdf 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/LongRange.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/LongRange.java
@@ -236,7 +236,7 @@ public abstract class LongRange implements Collection<Long> {
/**
* Gets the interval maximum value.
*
- * @return the high boundary
+ * @return The high boundary
*/
public long getMax() {
return max;
@@ -245,7 +245,7 @@ public abstract class LongRange implements Collection<Long> {
/**
* Gets the interval minimum value.
*
- * @return the low boundary
+ * @return The low boundary
*/
public long getMin() {
return min;
diff --git a/src/main/java/org/apache/commons/jexl3/internal/Operator.java b/src/main/java/org/apache/commons/jexl3/internal/Operator.java
index a6752ba0..8e01b246 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/Operator.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/Operator.java
@@ -160,7 +160,7 @@ public final class Operator implements JexlOperator.Uberspect {
*
* @param operator the operator
* @param args the arguments (as seen by the interpreter)
- * @return the tidied arguments
+ * @return The tidied arguments
*/
private Object[] arguments(final JexlOperator operator, final Object...args) {
return operator.getArity() == 1 && args.length > 1 ? new Object[]{args[0]} : args;
@@ -480,7 +480,7 @@ public final class Operator implements JexlOperator.Uberspect {
*
* @param operator the operator
* @param args the arguments
- * @return the result
+ * @return The result
*/
private Object performBaseOperation(final JexlOperator operator, final Object... args) {
switch (operator) {
@@ -523,7 +523,7 @@ public final class Operator implements JexlOperator.Uberspect {
* @param node the node
* @param operator the operator
* @param args the operator arguments
- * @return the operator evaluation result or TRY_FAILED
+ * @return The operator evaluation result or TRY_FAILED
*/
private Object tryEval(final JexlCache.Reference node, final JexlOperator operator, final Object...args) {
if (node != null) {
@@ -633,7 +633,7 @@ public final class Operator implements JexlOperator.Uberspect {
* From compare() int result to operator boolean result.
*
* @param cmp the compare result
- * @return the operator applied
+ * @return The operator applied
*/
protected boolean operate(final int cmp) {
switch(operator) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/Scope.java b/src/main/java/org/apache/commons/jexl3/internal/Scope.java
index a1a0f1b6..5723947f 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/Scope.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/Scope.java
@@ -110,7 +110,7 @@ public final class Scope {
* Gets an unmodifiable view of a scope"e;s symbols map.
*
* @param scope the scope
- * @return the symbols map
+ * @return The symbols map
*/
static Map<String, Integer> getSymbolsMap(final Scope scope) {
if (scope != null && scope.namedVariables != null) {
@@ -138,7 +138,7 @@ public final class Scope {
*
* @param frame the caller frame
* @param args the arguments
- * @return the arguments array
+ * @return The arguments array
*/
public Frame createFrame(final boolean ref, final Frame frame, final Object...args) {
if (namedVariables == null) {
@@ -171,7 +171,7 @@ public final class Scope {
* </p>
*
* @param param the parameter name
- * @return the register index storing this variable
+ * @return The register index storing this variable
*/
public int declareParameter(final String param) {
if (namedVariables == null) {
@@ -193,7 +193,7 @@ public final class Scope {
* </p>
*
* @param varName the variable name
- * @return the register index storing this variable
+ * @return The register index storing this variable
*/
public int declareVariable(final String varName) {
if (namedVariables == null) {
@@ -219,7 +219,7 @@ public final class Scope {
/**
* Gets the (maximum) number of arguments this script expects.
*
- * @return the number of parameters
+ * @return The number of parameters
*/
public int getArgCount() {
return parms;
@@ -229,7 +229,7 @@ public final class Scope {
* Gets the captured index of a given symbol, i.e., the target index of a symbol in a child scope.
*
* @param symbol the symbol index
- * @return the target symbol index or null if the symbol is not captured
+ * @return The target symbol index or null if the symbol is not captured
*/
public Integer getCaptured(final int symbol) {
if (capturedVariables != null) {
@@ -247,7 +247,7 @@ public final class Scope {
* Gets the index of a captured symbol, i.e., the source index of a symbol in a parent scope.
*
* @param symbol the symbol index
- * @return the source symbol index or -1 if the symbol is not captured
+ * @return The source symbol index or -1 if the symbol is not captured
*/
public int getCaptureDeclaration(final int symbol) {
final Integer declared = capturedVariables != null ? capturedVariables.get(symbol) : null;
@@ -258,7 +258,7 @@ public final class Scope {
* Gets this script captured symbols names, i.e., local variables defined in outer scopes and used
* by this scope.
*
- * @return the captured names
+ * @return The captured names
*/
public String[] getCapturedVariables() {
if (capturedVariables != null) {
@@ -279,7 +279,7 @@ public final class Scope {
/**
* Gets this script local variable, i.e. symbols assigned to local variables excluding captured variables.
*
- * @return the local variable names
+ * @return The local variable names
*/
public String[] getLocalVariables() {
if (namedVariables == null || vars <= 0) {
@@ -298,7 +298,7 @@ public final class Scope {
/**
* Gets this script parameters, i.e., symbols assigned before creating local variables.
*
- * @return the parameter names
+ * @return The parameter names
*/
public String[] getParameters() {
return getParameters(0);
@@ -308,7 +308,7 @@ public final class Scope {
* Gets this script parameters.
*
* @param bound number of known bound parameters (curry)
- * @return the parameter names
+ * @return The parameter names
*/
String[] getParameters(final int bound) {
final int unbound = parms - bound;
@@ -335,7 +335,7 @@ public final class Scope {
* If this fails, look within parents for a symbol that can be captured.
*
* @param name the symbol name
- * @return the symbol index
+ * @return The symbol index
*/
public Integer getSymbol(final String name) {
return getSymbol(name, true);
@@ -346,7 +346,7 @@ public final class Scope {
*
* @param name the symbol name
* @param capture whether solving by capturing a parent symbol is allowed
- * @return the symbol index
+ * @return The symbol index
*/
private Integer getSymbol(final String name, final boolean capture) {
Integer register = namedVariables != null ? namedVariables.get(name) : null;
@@ -370,7 +370,7 @@ public final class Scope {
/**
* Gets this script symbols names, i.e., parameters and local variables.
*
- * @return the symbol names
+ * @return The symbol names
*/
public String[] getSymbols() {
return namedVariables != null ? namedVariables.keySet().toArray(new String[0]) : EMPTY_STRS;
diff --git a/src/main/java/org/apache/commons/jexl3/internal/Script.java b/src/main/java/org/apache/commons/jexl3/internal/Script.java
index 5eb7b562..3780909c 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/Script.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/Script.java
@@ -81,7 +81,7 @@ public class Script implements JexlScript, JexlExpression {
/**
* Run the interpreter.
*
- * @return the evaluation result
+ * @return The evaluation result
*/
protected Object interpret() {
return interpreter.interpret(script);
@@ -142,7 +142,7 @@ public class Script implements JexlScript, JexlExpression {
* <p>The interpreter will handle interruption/cancellation gracefully if needed.</p>
*
* @param context the context
- * @return the callable
+ * @return The callable
*/
@Override
public Callable callable(final JexlContext context) {
@@ -156,7 +156,7 @@ public class Script implements JexlScript, JexlExpression {
*
* @param context the context
* @param args the script arguments
- * @return the callable
+ * @return The callable
*/
@Override
public Callable callable(final JexlContext context, final Object... args) {
@@ -186,7 +186,7 @@ public class Script implements JexlScript, JexlExpression {
* Creates this script frame for evaluation.
*
* @param args the arguments to bind to parameters
- * @return the frame (may be null)
+ * @return The frame (may be null)
*/
protected Frame createFrame(final Object[] args) {
return script.createFrame(args);
@@ -266,28 +266,28 @@ public class Script implements JexlScript, JexlExpression {
/**
* Gets this script captured variable, i.e. symbols captured from outer scopes.
*
- * @return the captured variable names
+ * @return The captured variable names
*/
public String[] getCapturedVariables() {
return script.getCapturedVariables();
}
/**
- * @return the engine that created this script
+ * @return The engine that created this script
*/
public JexlEngine getEngine() {
return jexl;
}
/**
- * @return the script features
+ * @return The script features
*/
public JexlFeatures getFeatures() {
return script.getFeatures();
}
/**
- * @return the info
+ * @return The info
*/
public JexlInfo getInfo() {
return script.jexlInfo();
@@ -319,7 +319,7 @@ public class Script implements JexlScript, JexlExpression {
* Gets this script pragmas
* <p>Pragma keys are ant-ish variables, their values are scalar literals.
*
- * @return the pragmas
+ * @return The pragmas
*/
@Override
public Map<String, Object> getPragmas() {
@@ -327,7 +327,7 @@ public class Script implements JexlScript, JexlExpression {
}
/**
- * @return the script AST
+ * @return The script AST
*/
protected ASTJexlScript getScript() {
return script;
@@ -348,7 +348,7 @@ public class Script implements JexlScript, JexlExpression {
* <p>Note that since variables can be in an ant-ish form (ie foo.bar.quux), each variable is returned as
* a list of strings where each entry is a fragment of the variable ({"foo", "bar", "quux"} in the example.</p>
*
- * @return the variables or null
+ * @return The variables or null
*/
@Override
public Set<List<String>> getVariables() {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/ScriptVisitor.java b/src/main/java/org/apache/commons/jexl3/internal/ScriptVisitor.java
index 0aa6f00a..9dbc7634 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/ScriptVisitor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/ScriptVisitor.java
@@ -592,7 +592,7 @@ public class ScriptVisitor extends ParserVisitor {
*
* @param jscript the expression
* @param data some data context
- * @return the visit result or null if jscript was not a Script implementation
+ * @return The visit result or null if jscript was not a Script implementation
*/
public Object visitExpression (final JexlExpression jscript, final Object data) {
if (jscript instanceof Script) {
@@ -618,7 +618,7 @@ public class ScriptVisitor extends ParserVisitor {
*
* @param jscript the expression
* @param data some data context
- * @return the visit result or null if jscript was not a Script implementation
+ * @return The visit result or null if jscript was not a Script implementation
*/
public Object visitScript(final JexlScript jscript, final Object data) {
if (jscript instanceof Script) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/SoftCache.java b/src/main/java/org/apache/commons/jexl3/internal/SoftCache.java
index ea80986f..ab66afd8 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/SoftCache.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/SoftCache.java
@@ -54,7 +54,7 @@ public class SoftCache<K, V> implements JexlCache<K, V> {
* Creates a synchronized LinkedHashMap.
*
* @param capacity the map capacity
- * @return the map instance
+ * @return The map instance
* @param <K> key type
* @param <V> value type
*/
diff --git a/src/main/java/org/apache/commons/jexl3/internal/Source.java b/src/main/java/org/apache/commons/jexl3/internal/Source.java
index 9b967883..6f963fde 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/Source.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/Source.java
@@ -101,7 +101,7 @@ public final class Source implements Comparable<Source> {
}
/**
- * @return the features associated with the source
+ * @return The features associated with the source
*/
public JexlFeatures getFeatures() {
return features;
@@ -113,7 +113,7 @@ public final class Source implements Comparable<Source> {
}
/**
- * @return the length of the script source
+ * @return The length of the script source
*/
int length() {
return str.length();
diff --git a/src/main/java/org/apache/commons/jexl3/internal/TemplateDebugger.java b/src/main/java/org/apache/commons/jexl3/internal/TemplateDebugger.java
index fdb660a7..5f52fdc2 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/TemplateDebugger.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/TemplateDebugger.java
@@ -116,7 +116,7 @@ public class TemplateDebugger extends Debugger {
* In a template, any statement that is not 'jexl:print(n)' must be prefixed by "$$".
*
* @param child the node to check
- * @return the expression number or -1 if the node is not a jexl:print
+ * @return The expression number or -1 if the node is not a jexl:print
*/
private TemplateExpression getPrintStatement(final JexlNode child) {
if (exprs != null && child instanceof ASTFunctionNode) {
@@ -229,7 +229,7 @@ public class TemplateDebugger extends Debugger {
*
* @param expr the composite expression
* @param data the visitor argument
- * @return the visitor argument
+ * @return The visitor argument
*/
private Object visit(final CompositeExpression expr, final Object data) {
for (final TemplateExpression ce : expr.exprs) {
@@ -243,7 +243,7 @@ public class TemplateDebugger extends Debugger {
*
* @param expr the constant expression
* @param data the visitor argument
- * @return the visitor argument
+ * @return The visitor argument
*/
private Object visit(final ConstantExpression expr, final Object data) {
expr.asString(builder);
@@ -255,7 +255,7 @@ public class TemplateDebugger extends Debugger {
*
* @param expr the deferred expression
* @param data the visitor argument
- * @return the visitor argument
+ * @return The visitor argument
*/
private Object visit(final DeferredExpression expr, final Object data) {
builder.append(expr.isImmediate() ? '$' : '#');
@@ -270,7 +270,7 @@ public class TemplateDebugger extends Debugger {
*
* @param expr the immediate expression
* @param data the visitor argument
- * @return the visitor argument
+ * @return The visitor argument
*/
private Object visit(final ImmediateExpression expr, final Object data) {
builder.append(expr.isImmediate() ? '$' : '#');
@@ -285,7 +285,7 @@ public class TemplateDebugger extends Debugger {
*
* @param expr the nested expression
* @param data the visitor argument
- * @return the visitor argument
+ * @return The visitor argument
*/
private Object visit(final NestedExpression expr, final Object data) {
super.accept(expr.node, data);
@@ -297,7 +297,7 @@ public class TemplateDebugger extends Debugger {
*
* @param expr the constant expression
* @param data the visitor argument
- * @return the visitor argument
+ * @return The visitor argument
*/
private Object visit(final TemplateExpression expr, final Object data) {
Object r;
diff --git a/src/main/java/org/apache/commons/jexl3/internal/TemplateEngine.java b/src/main/java/org/apache/commons/jexl3/internal/TemplateEngine.java
index bee20ff2..94424a00 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/TemplateEngine.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/TemplateEngine.java
@@ -355,7 +355,7 @@ public final class TemplateEngine extends JxltEngine {
* Base for to-string.
*
* @param error the builder to fill
- * @return the builder
+ * @return The builder
*/
StringBuilder toString(final StringBuilder error) {
error.append("exprs{");
@@ -407,7 +407,7 @@ public final class TemplateEngine extends JxltEngine {
}
/**
- * @return the index member
+ * @return The index member
*/
int getIndex() {
return index;
@@ -597,7 +597,7 @@ public final class TemplateEngine extends JxltEngine {
* Interprets a sub-expression.
*
* @param interpreter a JEXL interpreter
- * @return the result of interpretation
+ * @return The result of interpretation
* @throws JexlException (only for nested and composite)
*/
protected abstract Object evaluate(Interpreter interpreter);
@@ -613,7 +613,7 @@ public final class TemplateEngine extends JxltEngine {
* @param frame the frame storing parameters and local variables
* @param context the context storing global variables
* @param options flags and properties that can alter the evaluation behavior.
- * @return the expression value
+ * @return The expression value
* @throws JexlException if expression evaluation fails
*/
protected final Object evaluate(final JexlContext context, final Frame frame, final JexlOptions options) {
@@ -634,7 +634,7 @@ public final class TemplateEngine extends JxltEngine {
}
}
- /** @return the info */
+ /** @return The info */
JexlInfo getInfo() {
return null;
}
@@ -679,7 +679,7 @@ public final class TemplateEngine extends JxltEngine {
* The options to use during evaluation.
*
* @param context the context
- * @return the options
+ * @return The options
*/
protected JexlOptions options(final JexlContext context) {
return jexl.evalOptions(null, context);
@@ -707,7 +707,7 @@ public final class TemplateEngine extends JxltEngine {
* @param frame the frame storing parameters and local variables
* @param context the context storing global variables
* @param options flags and properties that can alter the evaluation behavior.
- * @return the expression value
+ * @return The expression value
* @throws JexlException if expression preparation fails
*/
protected final TemplateExpression prepare(final JexlContext context, final Frame frame, final JexlOptions options) {
@@ -748,7 +748,7 @@ public final class TemplateEngine extends JxltEngine {
* @param expr the source
* @param position the offset into the source
* @param c the separator character
- * @return the new position to read the source from
+ * @return The new position to read the source from
*/
private static int append(final StringBuilder strb, final CharSequence expr, final int position, final char c) {
strb.append(c);
@@ -808,7 +808,7 @@ public final class TemplateEngine extends JxltEngine {
* Reads lines from a (buffered / mark-able) reader keeping all new-lines and line-feeds.
*
* @param reader the reader
- * @return the line iterator
+ * @return The line iterator
*/
static Iterator<CharSequence> readLines(final Reader reader) {
if (!reader.markSupported()) {
@@ -951,7 +951,7 @@ public final class TemplateEngine extends JxltEngine {
}
/**
- * @return the deferred character
+ * @return The deferred character
*/
char getDeferredChar() {
return deferredChar;
@@ -960,7 +960,7 @@ public final class TemplateEngine extends JxltEngine {
/**
* Gets the JexlEngine underlying this JxltEngine.
*
- * @return the JexlEngine
+ * @return The JexlEngine
*/
@Override
public Engine getEngine() {
@@ -968,7 +968,7 @@ public final class TemplateEngine extends JxltEngine {
}
/**
- * @return the immediate character
+ * @return The immediate character
*/
char getImmediateChar() {
return immediateChar;
@@ -980,7 +980,7 @@ public final class TemplateEngine extends JxltEngine {
* @param info the source info
* @param expr the string expression
* @param scope the template scope
- * @return the unified expression instance
+ * @return The unified expression instance
* @throws JexlException if an error occurs during parsing
*/
TemplateExpression parseExpression(final JexlInfo info, final String expr, final Scope scope) { // CSOFF: MethodLength
@@ -1195,7 +1195,7 @@ public final class TemplateEngine extends JxltEngine {
*
* @param prefix the directive prefix
* @param source the source reader
- * @return the list of blocks
+ * @return The list of blocks
*/
List<Block> readTemplate(final String prefix, final Reader source) {
final ArrayList<Block> blocks = new ArrayList<>();
@@ -1272,7 +1272,7 @@ public final class TemplateEngine extends JxltEngine {
*
* @param sequence the sequence
* @param pattern the pattern to match at start of sequence
- * @return the first position after end of pattern if it matches, -1 otherwise
+ * @return The first position after end of pattern if it matches, -1 otherwise
*/
int startsWith(final CharSequence sequence, final CharSequence pattern) {
final int length = sequence.length();
diff --git a/src/main/java/org/apache/commons/jexl3/internal/TemplateInterpreter.java b/src/main/java/org/apache/commons/jexl3/internal/TemplateInterpreter.java
index 45bea15e..16dd361a 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/TemplateInterpreter.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/TemplateInterpreter.java
@@ -236,7 +236,7 @@ public class TemplateInterpreter extends Interpreter {
*
* @param node the function node
* @param data the data
- * @return the function evaluation result.
+ * @return The function evaluation result.
*/
@Override
protected Object visit(final ASTFunctionNode node, final Object data) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/TemplateScript.java b/src/main/java/org/apache/commons/jexl3/internal/TemplateScript.java
index cacf3344..c06d89ff 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/TemplateScript.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/TemplateScript.java
@@ -81,7 +81,7 @@ public final class TemplateScript implements JxltEngine.Template {
*
* @param info the node info
* @param scope the outer scope
- * @return the scope
+ * @return The scope
*/
private static Scope scopeOf(final JexlNode.Info info, final Scope scope) {
Scope found = null;
@@ -101,7 +101,7 @@ public final class TemplateScript implements JxltEngine.Template {
*
* @param scope the outer scope
* @param blocks the list of blocks
- * @return the array of expressions
+ * @return The array of expressions
*/
private TemplateExpression[] calleeScripts(final Scope scope, final Block[] blocks, final JexlNode.Info[] callSites) {
final TemplateExpression[] expressions = new TemplateExpression[callSites.length];
@@ -128,7 +128,7 @@ public final class TemplateScript implements JxltEngine.Template {
* that were parsed from a template.</p>
*
* @param blocks the list of blocks
- * @return the script source
+ * @return The script source
*/
private static String callerScript(final Block[] blocks) {
final StringBuilder strb = new StringBuilder();
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/AbstractExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/AbstractExecutor.java
index 5864d579..569d8899 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/AbstractExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/AbstractExecutor.java
@@ -120,7 +120,7 @@ abstract class AbstractExecutor {
* Gets the class of an object or Object if null.
*
* @param instance the instance
- * @return the class
+ * @return The class
*/
static Class<?> classOf(final Object instance) {
return instance == null ? Object.class : instance.getClass();
@@ -132,7 +132,7 @@ abstract class AbstractExecutor {
* @param clazz the class to introspect
* @param name the name of the method
* @param parms the parameters
- * @return the method
+ * @return The method
*/
static java.lang.reflect.Method initMarker(final Class<?> clazz, final String name, final Class<?>... parms) {
try {
@@ -146,7 +146,7 @@ abstract class AbstractExecutor {
* Creates an arguments array.
*
* @param args the list of arguments
- * @return the arguments array
+ * @return The arguments array
*/
static Object[] makeArgs(final Object... args) {
return args;
@@ -224,7 +224,7 @@ abstract class AbstractExecutor {
/**
* Gets the object class targeted by this executor.
*
- * @return the target object class
+ * @return The target object class
*/
public final Class<?> getTargetClass() {
return objectClass;
@@ -233,7 +233,7 @@ abstract class AbstractExecutor {
/**
* Gets the property targeted by this executor.
*
- * @return the target property
+ * @return The target property
*/
public Object getTargetProperty() {
return null;
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/BooleanGetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/BooleanGetExecutor.java
index af419f56..4aee7caf 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/BooleanGetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/BooleanGetExecutor.java
@@ -34,7 +34,7 @@ public final class BooleanGetExecutor extends AbstractExecutor.Get {
* @param is the introspector
* @param clazz the class to find the get method from
* @param property the property name
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static BooleanGetExecutor discover(final Introspector is, final Class<?> clazz, final String property) {
if (property != null && !property.isEmpty()) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/ClassMap.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/ClassMap.java
index 86bf39b9..9d5f85a4 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/ClassMap.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/ClassMap.java
@@ -122,7 +122,7 @@ final class ClassMap {
}
/**
- * @return the empty classmap instance
+ * @return The empty classmap instance
*/
static ClassMap empty() {
return EMPTY;
@@ -272,7 +272,7 @@ final class ClassMap {
/**
* Gets the field names cached by this map.
*
- * @return the array of field names
+ * @return The array of field names
*/
String[] getFieldNames() {
return fieldCache.keySet().toArray(new String[0]);
@@ -324,7 +324,7 @@ final class ClassMap {
/**
* Gets the methods names cached by this map.
*
- * @return the array of method names
+ * @return The array of method names
*/
String[] getMethodNames() {
return byName.keySet().toArray(new String[0]);
@@ -334,7 +334,7 @@ final class ClassMap {
* Gets all the methods with a given name from this map.
*
* @param methodName the seeked methods name
- * @return the array of methods (null or non-empty)
+ * @return The array of methods (null or non-empty)
*/
Method[] getMethods(final String methodName) {
final Method[] lm = byName.get(methodName);
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/ClassTool.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/ClassTool.java
index 9cbff68f..7b61bf81 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/ClassTool.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/ClassTool.java
@@ -68,7 +68,7 @@ final class ClassTool {
* Gets the package name of a class (class.getPackage() may return null).
*
* @param clz the class
- * @return the class package name
+ * @return The class package name
*/
static String getPackageName(final Class<?> clz) {
String pkgName = "";
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/DuckGetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/DuckGetExecutor.java
index 560b9c20..22ae69c6 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/DuckGetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/DuckGetExecutor.java
@@ -40,7 +40,7 @@ public final class DuckGetExecutor extends AbstractExecutor.Get {
* @param is the introspector
* @param clazz the class to find the get method from
* @param identifier the key to use as an argument to the get method
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static DuckGetExecutor discover(final Introspector is, final Class<?> clazz, final Object identifier) {
final java.lang.reflect.Method method = is.getMethod(clazz, "get", identifier);
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/DuckSetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/DuckSetExecutor.java
index 6e214dd1..38ae0648 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/DuckSetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/DuckSetExecutor.java
@@ -47,7 +47,7 @@ public final class DuckSetExecutor extends AbstractExecutor.Set {
* @param clazz the class to find the set method from
* @param key the key to use as 1st argument to the set method
* @param value the value to use as 2nd argument to the set method
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static DuckSetExecutor discover(final Introspector is, final Class<?> clazz, final Object key, final Object value) {
java.lang.reflect.Method method = is.getMethod(clazz, "set", key, value);
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/FieldGetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/FieldGetExecutor.java
index 3745dc07..45b8e83b 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/FieldGetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/FieldGetExecutor.java
@@ -35,7 +35,7 @@ public final class FieldGetExecutor implements JexlPropertyGet {
* @param is the introspector
* @param clazz the class to find the get method from
* @param identifier the key to use as an argument to the get method
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static JexlPropertyGet discover(final Introspector is, final Class<?> clazz, final String identifier) {
if (identifier != null) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/FieldSetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/FieldSetExecutor.java
index 676639aa..5de16923 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/FieldSetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/FieldSetExecutor.java
@@ -34,7 +34,7 @@ public final class FieldSetExecutor implements JexlPropertySet {
* @param clazz the class to find the get method from
* @param identifier the key to use as an argument to the get method
* @param value the value to set the field to
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static JexlPropertySet discover(final Introspector is,
final Class<?> clazz,
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/IndexedType.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/IndexedType.java
index dee0b502..9fa4f9e2 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/IndexedType.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/IndexedType.java
@@ -58,7 +58,7 @@ public final class IndexedType implements JexlPropertyGet {
* Gets a property from this indexed container.
*
* @param key the property key
- * @return the property value
+ * @return The property value
* @throws Exception if inner invocation fails
*/
public Object get(final Object key) throws Exception {
@@ -68,7 +68,7 @@ public final class IndexedType implements JexlPropertyGet {
/**
* Gets the property container class.
*
- * @return the container class
+ * @return The container class
*/
public Class<?> getContainerClass() {
return type.clazz;
@@ -77,7 +77,7 @@ public final class IndexedType implements JexlPropertyGet {
/**
* Gets the property container name.
*
- * @return the container name
+ * @return The container name
*/
public String getContainerName() {
return type.container;
@@ -88,7 +88,7 @@ public final class IndexedType implements JexlPropertyGet {
*
* @param key the property key
* @param value the property value
- * @return the invocation result (frequently null)
+ * @return The invocation result (frequently null)
* @throws Exception if inner invocation fails
*/
public Object set(final Object key, final Object value) throws Exception {
@@ -166,7 +166,7 @@ public final class IndexedType implements JexlPropertyGet {
*
* @param object the container instance (not null)
* @param key the property key (not null)
- * @return the property value
+ * @return The property value
* @throws Exception if invocation failed;
* IntrospectionException if a property getter could not be found
*/
@@ -199,7 +199,7 @@ public final class IndexedType implements JexlPropertyGet {
* @param object the container instance (not null)
* @param key the property key (not null)
* @param value the property value (not null)
- * @return the result of the method invocation (frequently null)
+ * @return The result of the method invocation (frequently null)
* @throws Exception if invocation failed;
* IntrospectionException if a property setter could not be found
*/
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/Introspector.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/Introspector.java
index cdcf9cfb..0ed5a2e3 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/Introspector.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/Introspector.java
@@ -147,7 +147,7 @@ public final class Introspector {
* Gets a class by name through this introspector class loader.
*
* @param className the class name
- * @return the class instance or null if it could not be found
+ * @return The class instance or null if it could not be found
*/
public Class<?> getClassByName(final String className) {
try {
@@ -252,7 +252,7 @@ public final class Introspector {
*
* @param c Class in which the field search is taking place
* @param key Name of the field being searched for
- * @return the desired field or null if it does not exist or is not accessible
+ * @return The desired field or null if it does not exist or is not accessible
*/
public Field getField(final Class<?> c, final String key) {
return getMap(c).getField(key);
@@ -262,7 +262,7 @@ public final class Introspector {
* Gets the array of accessible field names known for a given class.
*
* @param c the class
- * @return the class field names
+ * @return The class field names
*/
public String[] getFieldNames(final Class<?> c) {
if (c == null) {
@@ -275,7 +275,7 @@ public final class Introspector {
/**
* Gets the class loader used by this introspector.
*
- * @return the class loader
+ * @return The class loader
*/
public ClassLoader getLoader() {
return loader;
@@ -285,7 +285,7 @@ public final class Introspector {
* Gets the ClassMap for a given class.
*
* @param c the class
- * @return the class map
+ * @return The class map
*/
private ClassMap getMap(final Class<?> c) {
ClassMap classMap;
@@ -342,7 +342,7 @@ public final class Introspector {
* @param c the class
* @param name the method name
* @param params the method parameters
- * @return the desired method object
+ * @return The desired method object
* @throws MethodKey.AmbiguousException if no unambiguous method could be found through introspection
*/
public Method getMethod(final Class<?> c, final String name, final Object... params) {
@@ -353,7 +353,7 @@ public final class Introspector {
* Gets the array of accessible methods names known for a given class.
*
* @param c the class
- * @return the class method names
+ * @return The class method names
*/
public String[] getMethodNames(final Class<?> c) {
if (c == null) {
@@ -368,7 +368,7 @@ public final class Introspector {
*
* @param c the class
* @param methodName the method name
- * @return the array of methods (null or not empty)
+ * @return The array of methods (null or not empty)
*/
public Method[] getMethods(final Class<?> c, final String methodName) {
if (c == null) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/ListGetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/ListGetExecutor.java
index ff12db2e..847c5d23 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/ListGetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/ListGetExecutor.java
@@ -40,7 +40,7 @@ public final class ListGetExecutor extends AbstractExecutor.Get {
* @param is the introspector
* @param clazz the class to find the get method from
* @param index the index to use as an argument to the get method
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static ListGetExecutor discover(final Introspector is, final Class<?> clazz, final Integer index) {
if (index != null) {
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/ListSetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/ListSetExecutor.java
index 2ceb83dc..c9c736a3 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/ListSetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/ListSetExecutor.java
@@ -41,7 +41,7 @@ public final class ListSetExecutor extends AbstractExecutor.Set {
* @param clazz the class to find the get method from
* @param identifier the key to use as an argument to the get method
* @param value the value to use as argument in list.put(key, value)
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static ListSetExecutor discover(final Introspector is,
final Class<?> clazz,
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/MapGetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/MapGetExecutor.java
index 0956dce3..0f71f3d8 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/MapGetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/MapGetExecutor.java
@@ -36,7 +36,7 @@ public final class MapGetExecutor extends AbstractExecutor.Get {
* @param is the introspector
* @param clazz the class to find the get method from
* @param identifier the key to use as an argument to the get method
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static MapGetExecutor discover(final Introspector is, final Class<?> clazz, final Object identifier) {
// we still need to ensure permissions grant access to get(...)
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/MapSetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/MapSetExecutor.java
index 98d5407c..b085dde9 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/MapSetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/MapSetExecutor.java
@@ -35,7 +35,7 @@ public final class MapSetExecutor extends AbstractExecutor.Set {
* @param clazz the class to find the set method from
* @param identifier the key to use as an argument to the get method
* @param value the value to use as argument in map.put(key, value)
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static MapSetExecutor discover(final Introspector is,
final Class<?> clazz,
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/MethodKey.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/MethodKey.java
index 01c65350..e2ace756 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/MethodKey.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/MethodKey.java
@@ -202,7 +202,7 @@ public final class MethodKey {
* Helper to build class arrays.
*
* @param args the classes
- * @return the array
+ * @return The array
*/
private static Class<?>[] asArray(final Class<?>... args) {
return args;
@@ -552,7 +552,7 @@ public final class MethodKey {
* </p>
*
* @param parm a may-be primitive type class
- * @return the equivalent object class
+ * @return The equivalent object class
*/
static Class<?> primitiveClass(final Class<?> parm) {
// it was marginally faster to get from the map than call isPrimitive...
@@ -661,7 +661,7 @@ public final class MethodKey {
/**
* Gets this key's method name.
*
- * @return the method name
+ * @return The method name
*/
String getMethod() {
return method;
@@ -682,7 +682,7 @@ public final class MethodKey {
* </p>
*
* @param methods a list of methods
- * @return the most specific method.
+ * @return The most specific method.
* @throws MethodKey.AmbiguousException if there is more than one.
*/
private <T extends Executable> T getMostSpecific(final T[] methods) {
@@ -742,7 +742,7 @@ public final class MethodKey {
* Gets the most specific constructor that is applicable to the parameters of this key.
*
* @param methods a list of constructors.
- * @return the most specific constructor.
+ * @return The most specific constructor.
* @throws MethodKey.AmbiguousException if there is more than one.
*/
public Constructor<?> getMostSpecificConstructor(final Constructor<?>[] methods) {
@@ -753,7 +753,7 @@ public final class MethodKey {
* Gets the most specific method that is applicable to the parameters of this key.
*
* @param methods a list of methods.
- * @return the most specific method.
+ * @return The most specific method.
* @throws MethodKey.AmbiguousException if there is more than one.
*/
public Method getMostSpecificMethod(final Method[] methods) {
@@ -763,7 +763,7 @@ public final class MethodKey {
/**
* Gets this key's method parameter classes.
*
- * @return the parameters
+ * @return The parameters
*/
Class<?>[] getParameters() {
return params;
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/Permissions.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/Permissions.java
index fbf25bca..5b1928e0 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/Permissions.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/Permissions.java
@@ -67,7 +67,7 @@ public class Permissions implements JexlPermissions {
/**
* Creates a copy of a map containing copyable values.
* @param map the map to copy
- * @return the copy of the map
+ * @return The copy of the map
* @param <T> The type of Copyable values
*/
static <T extends Copyable<T>> Map<String, T> copyMap(final Map<String, T> map) {
@@ -341,7 +341,7 @@ public class Permissions implements JexlPermissions {
* Creates a new set of permissions by composing these permissions with a new set of rules.
*
* @param src the rules
- * @return the new permissions
+ * @return The new permissions
*/
@Override
public Permissions compose(final String... src) {
@@ -353,7 +353,7 @@ public class Permissions implements JexlPermissions {
* <p>As in {@code outer$inner} for <code>class outer { class inner...</code>.</p>
*
* @param clazz the clazz
- * @return the clazz key
+ * @return The clazz key
*/
static String classKey(final Class<?> clazz) {
return classKey(clazz, null);
@@ -365,7 +365,7 @@ public class Permissions implements JexlPermissions {
*
* @param clazz the clazz
* @param strb the buffer to compose the key
- * @return the clazz key
+ * @return The clazz key
*/
static String classKey(final Class<?> clazz, final StringBuilder strb) {
StringBuilder keyb = strb;
@@ -408,21 +408,21 @@ public class Permissions implements JexlPermissions {
* Gets the package constraints.
*
* @param packageName the package name
- * @return the package constraints instance, not-null.
+ * @return The package constraints instance, not-null.
*/
private NoJexlPackage getNoJexlPackage(final String packageName) {
return packages.getOrDefault(packageName, JEXL_PACKAGE);
}
/**
- * @return the packages
+ * @return The packages
*/
Map<String, NoJexlPackage> getPackages() {
return packages == null ? Collections.emptyMap() : Collections.unmodifiableMap(packages);
}
/**
- * @return the wildcards
+ * @return The wildcards
*/
Set<String> getWildcards() {
return allowed == null ? Collections.emptySet() : Collections.unmodifiableSet(allowed);
@@ -794,7 +794,7 @@ public class Permissions implements JexlPermissions {
* <p>If nothing was explicitly forbidden, everything is allowed.</p>
*
* @param clazz the class
- * @return the class constraints instance, not-null.
+ * @return The class constraints instance, not-null.
*/
private NoJexlClass getNoJexl(final Class<?> clazz) {
return getNoJexl(clazz, JEXL_CLASS);
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/PermissionsParser.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/PermissionsParser.java
index 1008a0cf..2e839a83 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/PermissionsParser.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/PermissionsParser.java
@@ -88,7 +88,7 @@ public class PermissionsParser {
* @param wildcards the set of allowed packages
* @param packages the map of restricted elements
* @param srcs the sources
- * @return the permissions map
+ * @return The permissions map
*/
synchronized Permissions parse(final Set<String> wildcards, final Map<String, Permissions.NoJexlPackage> packages,
final String... srcs) {
@@ -113,7 +113,7 @@ public class PermissionsParser {
* Parses permissions from a source.
*
* @param srcs the sources
- * @return the permissions map
+ * @return The permissions map
*/
public Permissions parse(final String... srcs) {
return parse(new LinkedHashSet<>(), new ConcurrentHashMap<>(), srcs);
@@ -127,7 +127,7 @@ public class PermissionsParser {
* @param outer the outer class (if any)
* @param inner the inner class name (if any)
* @param offset the initial parsing position in the source
- * @return the new parsing position
+ * @return The new parsing position
*/
private int readClass(final Permissions.NoJexlPackage njpackage, final boolean nojexl, final String outer, final String inner, final int offset) {
final StringBuilder temp = new StringBuilder();
@@ -267,7 +267,7 @@ public class PermissionsParser {
*
* @param id the builder to fill the identifier character with
* @param offset the initial reading position
- * @return the position after the identifier
+ * @return The position after the identifier
*/
private int readIdentifier(final StringBuilder id, final int offset) {
return readIdentifier(id, offset, false, false);
@@ -280,7 +280,7 @@ public class PermissionsParser {
* @param offset the initial reading position
* @param dot whether dots (.) are allowed
* @param star whether stars (*) are allowed
- * @return the position after the identifier
+ * @return The position after the identifier
*/
private int readIdentifier(final StringBuilder id, final int offset, final boolean dot, final boolean star) {
int begin = -1;
@@ -433,7 +433,7 @@ public class PermissionsParser {
*
* @param c the offending character
* @param i the offset position
- * @return the error message
+ * @return The error message
*/
private String unexpected(final char c, final int i) {
return "unexpected '" + c + "'@" + i;
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/PropertyGetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/PropertyGetExecutor.java
index 91868918..c970305d 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/PropertyGetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/PropertyGetExecutor.java
@@ -37,7 +37,7 @@ public final class PropertyGetExecutor extends AbstractExecutor.Get {
* @param is the introspector
* @param clazz the class to find the get method from
* @param property the property name to find
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static PropertyGetExecutor discover(final Introspector is, final Class<?> clazz, final String property) {
final java.lang.reflect.Method method = discoverGet(is, "get", clazz, property);
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/PropertySetExecutor.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/PropertySetExecutor.java
index 2f006019..2f79f3e9 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/PropertySetExecutor.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/PropertySetExecutor.java
@@ -39,7 +39,7 @@ public class PropertySetExecutor extends AbstractExecutor.Set {
* @param clazz the class to find the get method from
* @param property the property name to find
* @param value the value to assign to the property
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
public static PropertySetExecutor discover(final Introspector is,
final Class<?> clazz,
@@ -61,7 +61,7 @@ public class PropertySetExecutor extends AbstractExecutor.Set {
* @param clazz the class to find the get method from
* @param property the name of the property to set
* @param arg the value to assign to the property
- * @return the method if found, null otherwise
+ * @return The method if found, null otherwise
*/
private static java.lang.reflect.Method discoverSet(final Introspector is,
final Class<?> clazz,
diff --git a/src/main/java/org/apache/commons/jexl3/internal/introspection/Uberspect.java b/src/main/java/org/apache/commons/jexl3/internal/introspection/Uberspect.java
index 1cdb63e5..e420bc2e 100644
--- a/src/main/java/org/apache/commons/jexl3/internal/introspection/Uberspect.java
+++ b/src/main/java/org/apache/commons/jexl3/internal/introspection/Uberspect.java
@@ -116,7 +116,7 @@ public class Uberspect implements JexlUberspect {
* <p>
* If the reference has been collected, this method will recreate the underlying introspector.</p>
*
- * @return the introspector
+ * @return The introspector
*/
protected final Introspector base() {
Introspector intro = ref.get();
@@ -140,7 +140,7 @@ public class Uberspect implements JexlUberspect {
* <p>This is used to speed up resolution and avoid introspection when possible.</p>
*
* @param arithmetic the arithmetic instance
- * @return the set of overloaded operators
+ * @return The set of overloaded operators
*/
Set<JexlOperator> getOverloads(final JexlArithmetic arithmetic) {
final Class<? extends JexlArithmetic> aclass = arithmetic.getClass();
@@ -191,7 +191,7 @@ public class Uberspect implements JexlUberspect {
* Gets a class by name through this introspector class loader.
*
* @param className the class name
- * @return the class instance or null if it could not be found
+ * @return The class instance or null if it could not be found
*/
@Override
public final Class<?> getClassByName(final String className) {
@@ -227,7 +227,7 @@ public class Uberspect implements JexlUberspect {
* Gets the accessible field names known for a given class.
*
* @param c the class
- * @return the class field names
+ * @return The class field names
*/
public final String[] getFieldNames(final Class<?> c) {
return base().getFieldNames(c);
@@ -312,7 +312,7 @@ public class Uberspect implements JexlUberspect {
* Gets the accessible methods names known for a given class.
*
* @param c the class
- * @return the class method names
+ * @return The class method names
*/
public final String[] getMethodNames(final Class<?> c) {
return base().getMethodNames(c);
@@ -323,7 +323,7 @@ public class Uberspect implements JexlUberspect {
*
* @param c the class
* @param methodName the seeked methods name
- * @return the array of methods
+ * @return The array of methods
*/
public final Method[] getMethods(final Class<?> c, final String methodName) {
return base().getMethods(c, methodName);
diff --git a/src/main/java/org/apache/commons/jexl3/introspection/JexlMethod.java b/src/main/java/org/apache/commons/jexl3/introspection/JexlMethod.java
index d75fd29d..4f7d75aa 100644
--- a/src/main/java/org/apache/commons/jexl3/introspection/JexlMethod.java
+++ b/src/main/java/org/apache/commons/jexl3/introspection/JexlMethod.java
@@ -42,7 +42,7 @@ public interface JexlMethod {
* @param obj the object
* @param params method parameters.
- * @return the result
+ * @return The result
* @throws Exception on any error.
*/
Object invoke(Object obj, Object... params) throws Exception;
@@ -72,7 +72,7 @@ public interface JexlMethod {
* @param name the method name
* @param obj the object to invoke the method upon
* @param params the method arguments
- * @return the result of the method invocation that should be checked by tryFailed to determine if it succeeded
+ * @return The result of the method invocation that should be checked by tryFailed to determine if it succeeded
* or failed.
* @throws JexlException.TryFailed if the underlying method was invoked but threw an exception
* ({@link java.lang.reflect.InvocationTargetException})
diff --git a/src/main/java/org/apache/commons/jexl3/introspection/JexlPermissions.java b/src/main/java/org/apache/commons/jexl3/introspection/JexlPermissions.java
index d197135f..360ede3c 100644
--- a/src/main/java/org/apache/commons/jexl3/introspection/JexlPermissions.java
+++ b/src/main/java/org/apache/commons/jexl3/introspection/JexlPermissions.java
@@ -320,7 +320,7 @@ public interface JexlPermissions {
*
* @param allowed the decision to return
* @param message the message to log
- * @return the decision
+ * @return The decision
*/
private boolean log(final boolean allowed, final String message) {
if (logged.add(message)) {
@@ -643,7 +643,7 @@ public interface JexlPermissions {
* </pre>
*
* @param src the permissions source, the default (NoJexl aware) permissions if null
- * @return the permissions instance
+ * @return The permissions instance
* @since 3.3
*/
static JexlPermissions parse(final String... src) {
@@ -658,7 +658,7 @@ public interface JexlPermissions {
* ({@link #UNRESTRICTED}) allows everything.</p>
*
* @param rules the permission DSL declarations
- * @return the closed-world permission set
+ * @return The closed-world permission set
* @since 3.7.0
*/
static JexlPermissions create(final String... rules) {
@@ -791,7 +791,7 @@ public interface JexlPermissions {
* would extend the restricted set of permissions by allowing the com.my.app package.</p>
*
* @param src the new constraints
- * @return the new permissions
+ * @return The new permissions
*/
JexlPermissions compose(String... src);
diff --git a/src/main/java/org/apache/commons/jexl3/introspection/JexlPropertyGet.java b/src/main/java/org/apache/commons/jexl3/introspection/JexlPropertyGet.java
index 322c7509..97d98dfb 100644
--- a/src/main/java/org/apache/commons/jexl3/introspection/JexlPropertyGet.java
+++ b/src/main/java/org/apache/commons/jexl3/introspection/JexlPropertyGet.java
@@ -34,7 +34,7 @@ public interface JexlPropertyGet {
* Method used to get the property value of an object.
*
* @param obj the object to get the property value from.
- * @return the property value.
+ * @return The property value.
* @throws Exception on any error.
*/
Object invoke(Object obj) throws Exception;
@@ -70,7 +70,7 @@ public interface JexlPropertyGet {
*
* @param obj the object to invoke the property get upon
* @param key the property key to get
- * @return the result of the method invocation that should be checked by tryFailed to determine if it succeeded
+ * @return The result of the method invocation that should be checked by tryFailed to determine if it succeeded
* or failed.
* @throws JexlException.TryFailed if the underlying method was invoked but threw an exception
* ({@link java.lang.reflect.InvocationTargetException})
diff --git a/src/main/java/org/apache/commons/jexl3/introspection/JexlPropertySet.java b/src/main/java/org/apache/commons/jexl3/introspection/JexlPropertySet.java
index 68d8ab49..e6d2770e 100644
--- a/src/main/java/org/apache/commons/jexl3/introspection/JexlPropertySet.java
+++ b/src/main/java/org/apache/commons/jexl3/introspection/JexlPropertySet.java
@@ -35,7 +35,7 @@ public interface JexlPropertySet {
*
* @param obj Object on which the property setter will be called with the value
* @param arg value to be set
- * @return the value returned from the set operation (impl specific)
+ * @return The value returned from the set operation (impl specific)
* @throws Exception on any error.
*/
Object invoke(Object obj, Object arg) throws Exception;
@@ -63,7 +63,7 @@ public interface JexlPropertySet {
* @param obj the object to invoke the get upon
* @param key the property key to get
* @param value the property value to set
- * @return the result of the method invocation that should be checked by tryFailed to determine if it succeeded
+ * @return The result of the method invocation that should be checked by tryFailed to determine if it succeeded
* or failed.
* @throws JexlException.TryFailed if the underlying method was invoked but threw an exception
* ({@link java.lang.reflect.InvocationTargetException})
diff --git a/src/main/java/org/apache/commons/jexl3/introspection/JexlSandbox.java b/src/main/java/org/apache/commons/jexl3/introspection/JexlSandbox.java
index 89391078..07442574 100644
--- a/src/main/java/org/apache/commons/jexl3/introspection/JexlSandbox.java
+++ b/src/main/java/org/apache/commons/jexl3/introspection/JexlSandbox.java
@@ -184,7 +184,7 @@ public final class JexlSandbox {
* Gets a class by name, crude mechanism for backwards (<3.2 ) compatibility.
*
* @param cname the class name
- * @return the class
+ * @return The class
*/
static Class<?> forName(final String cname) {
try {
@@ -199,7 +199,7 @@ public final class JexlSandbox {
* <p>The sandbox inheritance property will apply to the permissions created by this method
*
* @param clazz the allowed class name
- * @return the permissions instance
+ * @return The permissions instance
*/
public Permissions allow(final String clazz) {
return permissions(clazz, true, true, true);
@@ -210,7 +210,7 @@ public final class JexlSandbox {
* <p>The sandbox inheritance property will apply to the permissions created by this method
*
* @param clazz the blocked class name
- * @return the permissions instance
+ * @return The permissions instance
*/
public Permissions block(final String clazz) {
return permissions(clazz, false, false, false);
@@ -260,7 +260,7 @@ public final class JexlSandbox {
* Gets the set of permissions associated to a class.
*
* @param clazz the class name
- * @return the defined permissions or an all-allow permission instance if none were defined
+ * @return The defined permissions or an all-allow permission instance if none were defined
*/
public Permissions get(final String clazz) {
return get(forName(clazz));
@@ -270,7 +270,7 @@ public final class JexlSandbox {
* Gets the permissions associated to a class.
*
* @param clazz the class
- * @return the permissions
+ * @return The permissions
*/
@SuppressWarnings("null")
public Permissions get(final Class<?> clazz) {
@@ -288,7 +288,7 @@ public final class JexlSandbox {
*
* @param clazz the class
* @param store whether the computed permissions should be stored in the sandbox
- * @return the permissions
+ * @return The permissions
*/
private Permissions compute(final Class<?> clazz, final boolean store) {
// belt and suspender; recursion should not lead here
@@ -333,7 +333,7 @@ public final class JexlSandbox {
* @param readFlag whether the readable property list is allow - true - or block - false -
* @param writeFlag whether the writable property list is allow - true - or block - false -
* @param executeFlag whether the executable method list is allow - true - or block - false -
- * @return the set of permissions
+ * @return The set of permissions
*/
public Permissions permissions(final String clazz,
final boolean readFlag,
@@ -350,7 +350,7 @@ public final class JexlSandbox {
* @param readf whether the readable property list is allow - true - or block - false -
* @param writef whether the writable property list is allow - true - or block - false -
* @param execf whether the executable method list is allow - true - or block - false -
- * @return the set of permissions
+ * @return The set of permissions
*/
public Permissions permissions(final String clazz,
final boolean inhf,
@@ -605,7 +605,7 @@ public final class JexlSandbox {
/**
* Gets the set of method names in these permissions.
*
- * @return the set of method names
+ * @return The set of method names
*/
public Names execute() {
return execute;
@@ -637,7 +637,7 @@ public final class JexlSandbox {
/**
* Gets the set of readable property names in these permissions.
*
- * @return the set of property names
+ * @return The set of property names
*/
public Names read() {
return read;
@@ -659,7 +659,7 @@ public final class JexlSandbox {
/**
* Gets the set of writable property names in these permissions.
*
- * @return the set of property names
+ * @return The set of property names
*/
public Names write() {
return write;
@@ -703,7 +703,7 @@ public final class JexlSandbox {
* Use block() instead.
*
* @param clazz the blocked class name
- * @return the permissions instance
+ * @return The permissions instance
* @deprecated 3.3
*/
@Deprecated
@@ -728,7 +728,7 @@ public final class JexlSandbox {
* Use allow() instead.
*
* @param clazz the allowed class name
- * @return the permissions instance
+ * @return The permissions instance
* @deprecated 3.3
*/
@Deprecated
diff --git a/src/main/java/org/apache/commons/jexl3/introspection/JexlUberspect.java b/src/main/java/org/apache/commons/jexl3/introspection/JexlUberspect.java
index 5039e146..8ee85c89 100644
--- a/src/main/java/org/apache/commons/jexl3/introspection/JexlUberspect.java
+++ b/src/main/java/org/apache/commons/jexl3/introspection/JexlUberspect.java
@@ -91,7 +91,7 @@ public interface JexlUberspect {
* Resolves a class name.
*
* @param name the simple class name
- * @return the fully qualified class name
+ * @return The fully qualified class name
*/
String resolveClassName(String name);
}
@@ -108,7 +108,7 @@ public interface JexlUberspect {
* Resolves a constant by its name.
*
* @param name the constant name, a qualified name
- * @return the constant value or TRY_FAILED if not found
+ * @return The constant value or TRY_FAILED if not found
*/
Object resolveConstant(String name);
}
@@ -149,7 +149,7 @@ public interface JexlUberspect {
* @param uber the uberspect
* @param obj the object
* @param identifier the property identifier
- * @return the property getter or null
+ * @return The property getter or null
*/
JexlPropertyGet getPropertyGet(JexlUberspect uber, Object obj, Object identifier);
@@ -160,7 +160,7 @@ public interface JexlUberspect {
* @param obj the object
* @param identifier the property identifier
* @param arg the property value
- * @return the property setter or null
+ * @return The property setter or null
*/
JexlPropertySet getPropertySet(JexlUberspect uber, Object obj, Object identifier, Object arg);
}
@@ -183,7 +183,7 @@ public interface JexlUberspect {
*
* @param operator the property access operator, can be null
* @param obj the instance we seek to obtain a property setter/getter from, cannot be null
- * @return the ordered list of resolver types, cannot be null
+ * @return The ordered list of resolver types, cannot be null
*/
List<PropertyResolver> apply(JexlOperator operator, Object obj);
}
@@ -254,7 +254,7 @@ public interface JexlUberspect {
* Gets an arithmetic operator resolver for a given arithmetic instance.
*
* @param arithmetic the arithmetic instance
- * @return the arithmetic uberspect or null if no operator method were overridden
+ * @return The arithmetic uberspect or null if no operator method were overridden
* @since 3.0
* @see #getOperator(JexlArithmetic)
*/
@@ -275,7 +275,7 @@ public interface JexlUberspect {
* Seeks a class by name using this uberspect class-loader.
*
* @param className the class name
- * @return the class instance or null if the class cannot be located by this uberspect class loader or if
+ * @return The class instance or null if the class cannot be located by this uberspect class loader or if
* permissions deny access to the class
*/
default Class<?> getClassByName(final String className) {
@@ -289,7 +289,7 @@ public interface JexlUberspect {
/**
* Gets the current class loader.
*
- * @return the class loader
+ * @return The class loader
*/
ClassLoader getClassLoader();
@@ -378,14 +378,14 @@ public interface JexlUberspect {
*
* @param op the operator
* @param obj the object
- * @return the applied strategy resolver list
+ * @return The applied strategy resolver list
*/
List<PropertyResolver> getResolvers(JexlOperator op, Object obj);
/**
* Gets this uberspect version.
*
- * @return the class loader modification count
+ * @return The class loader modification count
*/
int getVersion();
diff --git a/src/main/java/org/apache/commons/jexl3/parser/ASTIdentifier.java b/src/main/java/org/apache/commons/jexl3/parser/ASTIdentifier.java
index b077a3b6..8c2caa5a 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/ASTIdentifier.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/ASTIdentifier.java
@@ -45,7 +45,7 @@ public class ASTIdentifier extends JexlNode {
*
* @param ordinal the flag ordinal
* @param mask the flags mask
- * @return the mask value with this flag or-ed in
+ * @return The mask value with this flag or-ed in
*/
private static boolean isSet(final int ordinal, final int mask) {
return (mask & 1 << ordinal) != 0;
@@ -57,7 +57,7 @@ public class ASTIdentifier extends JexlNode {
* @param ordinal the flag ordinal
* @param mask the flags mask
* @param value true or false
- * @return the new flags mask value
+ * @return The new flags mask value
*/
private static int set(final int ordinal, final int mask, final boolean value) {
return value? mask | 1 << ordinal : mask & ~(1 << ordinal);
diff --git a/src/main/java/org/apache/commons/jexl3/parser/ASTJexlScript.java b/src/main/java/org/apache/commons/jexl3/parser/ASTJexlScript.java
index 38402874..10a8f170 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/ASTJexlScript.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/ASTJexlScript.java
@@ -52,7 +52,7 @@ public class ASTJexlScript extends JexlLexicalNode {
*
* @param caller the calling frame
* @param values the argument values
- * @return the arguments array
+ * @return The arguments array
*/
public Frame createFrame(final Frame caller, final Object... values) {
return scope != null ? scope.createFrame(features.supportsReferenceCapture(), caller, values) : null;
@@ -62,7 +62,7 @@ public class ASTJexlScript extends JexlLexicalNode {
* Creates an array of arguments by copying values up to the number of parameters.
*
* @param values the argument values
- * @return the arguments array
+ * @return The arguments array
*/
public Frame createFrame(final Object... values) {
return createFrame(null, values);
@@ -71,7 +71,7 @@ public class ASTJexlScript extends JexlLexicalNode {
/**
* Gets the (maximum) number of arguments this script expects.
*
- * @return the number of parameters
+ * @return The number of parameters
*/
public int getArgCount() {
return scope != null ? scope.getArgCount() : 0;
@@ -80,7 +80,7 @@ public class ASTJexlScript extends JexlLexicalNode {
/**
* Gets this script captured variable, i.e. symbols captured from outer scopes.
*
- * @return the captured variable names
+ * @return The captured variable names
*/
public String[] getCapturedVariables() {
return scope != null ? scope.getCapturedVariables() : new String[0];
@@ -96,7 +96,7 @@ public class ASTJexlScript extends JexlLexicalNode {
/**
* Gets this script local variable, i.e. symbols assigned to local variables.
*
- * @return the local variable names
+ * @return The local variable names
*/
public String[] getLocalVariables() {
return scope != null ? scope.getLocalVariables() : new String[0];
@@ -105,7 +105,7 @@ public class ASTJexlScript extends JexlLexicalNode {
/**
* Gets this script parameters, i.e. symbols assigned before creating local variables.
*
- * @return the parameter names
+ * @return The parameter names
*/
public String[] getParameters() {
return scope != null ? scope.getParameters() : new String[0];
@@ -128,7 +128,7 @@ public class ASTJexlScript extends JexlLexicalNode {
/**
* Gets this script symbols, i.e. parameters and local variables.
*
- * @return the symbol names
+ * @return The symbol names
*/
public String[] getSymbols() {
return scope != null ? scope.getSymbols() : null;
@@ -152,7 +152,7 @@ public class ASTJexlScript extends JexlLexicalNode {
/**
* Consider script with no parameters that return lambda as parametric-scripts.
*
- * @return the script
+ * @return The script
*/
public ASTJexlScript script() {
if (scope == null && jjtGetNumChildren() == 1 && jjtGetChild(0) instanceof ASTJexlLambda) {
diff --git a/src/main/java/org/apache/commons/jexl3/parser/ASTJxltLiteral.java b/src/main/java/org/apache/commons/jexl3/parser/ASTJxltLiteral.java
index 4ee58536..f9892a0b 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/ASTJxltLiteral.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/ASTJxltLiteral.java
@@ -52,7 +52,7 @@ public final class ASTJxltLiteral extends JexlNode implements JexlNode.JxltHandl
/**
* Gets the literal value.
*
- * @return the string literal
+ * @return The string literal
*/
public String getLiteral() {
return this.literal;
diff --git a/src/main/java/org/apache/commons/jexl3/parser/ASTRegexLiteral.java b/src/main/java/org/apache/commons/jexl3/parser/ASTRegexLiteral.java
index 18cda645..e6dd45a0 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/ASTRegexLiteral.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/ASTRegexLiteral.java
@@ -36,7 +36,7 @@ public final class ASTRegexLiteral extends JexlNode implements JexlNode.Constant
/**
* Gets the literal value.
*
- * @return the Pattern literal
+ * @return The Pattern literal
*/
@Override
public Pattern getLiteral() {
diff --git a/src/main/java/org/apache/commons/jexl3/parser/ASTStringLiteral.java b/src/main/java/org/apache/commons/jexl3/parser/ASTStringLiteral.java
index 918214fc..57f58c77 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/ASTStringLiteral.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/ASTStringLiteral.java
@@ -32,7 +32,7 @@ public final class ASTStringLiteral extends JexlNode implements JexlNode.Constan
/**
* Gets the literal value.
*
- * @return the string literal
+ * @return The string literal
*/
@Override
public String getLiteral() {
diff --git a/src/main/java/org/apache/commons/jexl3/parser/FeatureController.java b/src/main/java/org/apache/commons/jexl3/parser/FeatureController.java
index d61613b2..ca08f9ee 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/FeatureController.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/FeatureController.java
@@ -63,7 +63,7 @@ public class FeatureController extends ScriptVisitor {
}
/**
- * @return the controlled features
+ * @return The controlled features
*/
public JexlFeatures getFeatures() {
return features;
diff --git a/src/main/java/org/apache/commons/jexl3/parser/JavaccError.java b/src/main/java/org/apache/commons/jexl3/parser/JavaccError.java
index c7e577e8..7ec61ef9 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/JavaccError.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/JavaccError.java
@@ -24,14 +24,14 @@ public interface JavaccError {
/**
* Gets the last correct input.
*
- * @return the string after which the error occurred
+ * @return The string after which the error occurred
*/
String getAfter();
/**
* Gets the column number.
*
- * @return the column.
+ * @return The column.
*/
int getColumn();
diff --git a/src/main/java/org/apache/commons/jexl3/parser/JexlNode.java b/src/main/java/org/apache/commons/jexl3/parser/JexlNode.java
index ecc77a09..7d0c7b89 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/JexlNode.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/JexlNode.java
@@ -51,10 +51,10 @@ public abstract class JexlNode extends SimpleNode implements JexlCache.Reference
*/
public interface JxltHandle {
- /** @return the expression source. */
+ /** @return The expression source. */
String getExpressionSource();
- /**@return the expression instance, should be a TemplateEngine.TemplateExpression. */
+ /**@return The expression instance, should be a TemplateEngine.TemplateExpression. */
JxltEngine.Expression getExpression();
/**
@@ -126,7 +126,7 @@ public abstract class JexlNode extends SimpleNode implements JexlCache.Reference
}
/**
- * @return the node this info is bound to
+ * @return The node this info is bound to
*/
public JexlNode getNode() {
return node;
@@ -322,7 +322,7 @@ public abstract class JexlNode extends SimpleNode implements JexlCache.Reference
/**
* Gets the associated JexlInfo instance.
*
- * @return the info
+ * @return The info
*/
public JexlInfo jexlInfo() {
return jexlInfo(null);
@@ -332,7 +332,7 @@ public abstract class JexlNode extends SimpleNode implements JexlCache.Reference
* Gets the associated JexlInfo instance.
*
* @param name the source name
- * @return the info
+ * @return The info
*/
public JexlInfo jexlInfo(final String name) {
JexlInfo info = null;
diff --git a/src/main/java/org/apache/commons/jexl3/parser/JexlParser.java b/src/main/java/org/apache/commons/jexl3/parser/JexlParser.java
index 732725f5..43626096 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/JexlParser.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/JexlParser.java
@@ -63,12 +63,12 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
boolean declareSymbol(int symbol);
/**
- * @return the set of symbols identifiers declared in this unit
+ * @return The set of symbols identifiers declared in this unit
*/
LexicalScope getLexicalScope();
/**
- * @return the number of local variables declared in this unit
+ * @return The number of local variables declared in this unit
*/
int getSymbolCount();
@@ -133,7 +133,7 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
* Pick the most significant token for error reporting.
*
* @param tokens the tokens to choose from
- * @return the token
+ * @return The token
*/
protected static Token errorToken(final Token... tokens) {
for (final Token token : tokens) {
@@ -149,7 +149,7 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
*
* @param src the source token, if null, the destination token is returned
* @param dest the destination token, if null, the source token is returned
- * @return the destination token with the content of the source token
+ * @return The destination token with the content of the source token
*/
static Token assignToken(final Token src, final Token dest) {
if (dest == null) {
@@ -173,7 +173,7 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
*
* @param src the source
* @param lineno the line number
- * @return the line
+ * @return The line
*/
protected static String readSourceLine(final String src, final int lineno) {
String msg = "";
@@ -194,7 +194,7 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
* Utility function to create '.' separated string from a list of string.
*
* @param lstr the list of strings
- * @return the dotted version
+ * @return The dotted version
*/
protected static String stringify(final Iterable<String> lstr) {
return String.join(".", lstr);
@@ -387,7 +387,7 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
* Encode a value to a switch predicate.
*
* @param value the value.
- * @return the encoded value, which is either the value itself, or NAN (for NaN) or NIL (for null).
+ * @return The encoded value, which is either the value itself, or NAN (for NaN) or NIL (for null).
*/
static Object switchCode(final Object value) {
if (value == null) {
@@ -466,7 +466,7 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
*
* @param identifier the identifier.
* @param name the identifier name.
- * @return the image.
+ * @return The image.
*/
protected String checkVariable(final ASTIdentifier identifier, final String name) {
final Scope scope = scopeReference.get();
@@ -736,7 +736,7 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
/**
* Gets the current set of features active during parsing.
*
- * @return the current set of features active during parsing.
+ * @return The current set of features active during parsing.
*/
protected JexlFeatures getFeatures() {
return featureController.getFeatures();
@@ -749,7 +749,7 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
* regain access after parsing to known which / how-many registers are needed.
* </p>
*
- * @return the named register map
+ * @return The named register map
*/
protected Scope getScope() {
return scopeReference.get();
@@ -759,14 +759,14 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
* Overridden in actual parser to access tokens stack.
*
* @param index 0 to get current token.
- * @return the token on the stack.
+ * @return The token on the stack.
*/
protected abstract Token getToken(int index);
/**
* Gets the lexical unit used by this parser.
*
- * @return the named register map.
+ * @return The named register map.
*/
protected LexicalUnit getUnit() {
return blockReference.get();
@@ -981,7 +981,7 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
*
* @param info the JexlInfo
* @param src the source to parse
- * @return the parsed tree
+ * @return The parsed tree
*/
@Override
public ASTJexlScript jxltParse(final JexlInfo info, final JexlFeatures features, final String src, final Scope scope) {
@@ -1001,7 +1001,7 @@ public abstract class JexlParser extends StringParser implements JexlScriptParse
* @param info the JexlInfo
* @param src the source to parse
* @param scope the scope
- * @return the expression
+ * @return The expression
*/
static JxltEngine.Expression parseInterpolation(final JexlInfo info, final String src, final Scope scope) {
final JexlEngine jexl = JexlEngine.getThreadEngine();
diff --git a/src/main/java/org/apache/commons/jexl3/parser/JexlScriptParser.java b/src/main/java/org/apache/commons/jexl3/parser/JexlScriptParser.java
index fb94a18d..a34b2c39 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/JexlScriptParser.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/JexlScriptParser.java
@@ -35,7 +35,7 @@ public interface JexlScriptParser {
* @param features the set of parsing features
* @param src the expression to parse
* @param scope the script frame
- * @return the parsed tree
+ * @return The parsed tree
* @throws JexlException if any error occurred during parsing
*/
ASTJexlScript parse(final JexlInfo info, final JexlFeatures features, final String src, final Scope scope);
@@ -47,7 +47,7 @@ public interface JexlScriptParser {
* @param features the set of parsing features
* @param src the expression to parse
* @param scope the script frame
- * @return the parsed tree
+ * @return The parsed tree
* @throws JexlException if any error occurred during parsing
*/
default ASTJexlScript jxltParse(final JexlInfo info, final JexlFeatures features, final String src, final Scope scope) {
diff --git a/src/main/java/org/apache/commons/jexl3/parser/SimpleNode.java b/src/main/java/org/apache/commons/jexl3/parser/SimpleNode.java
index 0f11b315..90ddf850 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/SimpleNode.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/SimpleNode.java
@@ -151,7 +151,7 @@ public class SimpleNode implements Node {
* Gets a child of this node.
*
* @param i the child offset
- * @return the child node
+ * @return The child node
*/
@Override
public JexlNode jjtGetChild(final int i) {
@@ -161,7 +161,7 @@ public class SimpleNode implements Node {
/**
* Gets this node number of children.
*
- * @return the number of children
+ * @return The number of children
*/
@Override
public int jjtGetNumChildren() {
@@ -171,7 +171,7 @@ public class SimpleNode implements Node {
/**
* Gets this node's parent.
*
- * @return the parent node
+ * @return The parent node
*/
@Override
public JexlNode jjtGetParent() {
diff --git a/src/main/java/org/apache/commons/jexl3/parser/StringParser.java b/src/main/java/org/apache/commons/jexl3/parser/StringParser.java
index c418c695..a00eb946 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/StringParser.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/StringParser.java
@@ -56,7 +56,7 @@ public class StringParser {
* Builds a regex pattern string, handles escaping '/' through '\/' syntax.
*
* @param str the string to build from
- * @return the built string
+ * @return The built string
*/
public static String buildRegex(final CharSequence str) {
return buildString(str.subSequence(1, str.length()), true);
@@ -67,7 +67,7 @@ public class StringParser {
*
* @param str the string to build from
* @param eatsep whether the separator, the first character, should be considered
- * @return the built string
+ * @return The built string
*/
public static String buildString(final CharSequence str, final boolean eatsep) {
return buildString(str, eatsep, true);
@@ -79,7 +79,7 @@ public class StringParser {
* @param str the string to build from
* @param eatsep whether the separator, the first character, should be considered
* @param esc whether escape characters are interpreted or escaped
- * @return the built string
+ * @return The built string
*/
private static String buildString(final CharSequence str, final boolean eatsep, final boolean esc) {
final StringBuilder strb = new StringBuilder(str.length());
@@ -95,7 +95,7 @@ public class StringParser {
*
* @param str the string to build from
* @param eatsep whether the separator, the first character, should be considered
- * @return the built string
+ * @return The built string
*/
public static String buildTemplate(final CharSequence str, final boolean eatsep) {
return buildString(str, eatsep, false);
@@ -105,7 +105,7 @@ public class StringParser {
* Adds a escape char ('\') where needed in a string form of an ide
*
* @param str the identifier un-escaped string
- * @return the string with added backslash character before space, quote, double-quote and backslash
+ * @return The string with added backslash character before space, quote, double-quote and backslash
*/
public static String escapeIdentifier(final String str) {
StringBuilder strb = null;
@@ -143,7 +143,7 @@ public class StringParser {
*
* @param delim the delimiter character (if 0, no delimiter is added)
* @param str the string to escape
- * @return the escaped representation
+ * @return The escaped representation
*/
public static String escapeString(final CharSequence str, final char delim) {
if (str == null) {
@@ -220,7 +220,7 @@ public class StringParser {
* @param end the relative offset in str to end reading
* @param sep the separator, single or double quote, marking end of string
* @param esc whether escape characters are interpreted or escaped
- * @return the last character offset handled in origin
+ * @return The last character offset handled in origin
*/
private static int read(final StringBuilder strb, final CharSequence str, final int begin, final int end, final char sep, final boolean esc) {
boolean escape = false;
@@ -286,7 +286,7 @@ public class StringParser {
* @param str the origin
* @param index the offset into the origin
* @param sep the separator, single or double quote, marking end of string
- * @return the offset in origin
+ * @return The offset in origin
*/
public static int readString(final StringBuilder strb, final CharSequence str, final int index, final char sep) {
return read(strb, str, index, str.length(), sep, true);
@@ -326,7 +326,7 @@ public class StringParser {
* Remove escape char ('\') from an identifier.
*
* @param str the identifier escaped string, ie with a backslash before space, quote, double-quote and backslash
- * @return the string with no '\\' character
+ * @return The string with no '\\' character
*/
public static String unescapeIdentifier(final String str) {
StringBuilder strb = null;
diff --git a/src/main/java/org/apache/commons/jexl3/parser/TokenMgrException.java b/src/main/java/org/apache/commons/jexl3/parser/TokenMgrException.java
index 37580a23..84b798e5 100644
--- a/src/main/java/org/apache/commons/jexl3/parser/TokenMgrException.java
+++ b/src/main/java/org/apache/commons/jexl3/parser/TokenMgrException.java
@@ -186,7 +186,7 @@ public class TokenMgrException extends RuntimeException implements JavaccError {
* Returns a detailed message for the Error when it is thrown by the
* token manager to indicate a lexical error.
*
- * @return the message
+ * @return The message
*/
@Override
public String getMessage() {
diff --git a/src/main/java/org/apache/commons/jexl3/scripting/JexlScriptEngine.java b/src/main/java/org/apache/commons/jexl3/scripting/JexlScriptEngine.java
index c98114f2..c26a5f7c 100644
--- a/src/main/java/org/apache/commons/jexl3/scripting/JexlScriptEngine.java
+++ b/src/main/java/org/apache/commons/jexl3/scripting/JexlScriptEngine.java
@@ -242,7 +242,7 @@ public class JexlScriptEngine extends AbstractScriptEngine implements Compilable
* for <strong>all</strong> JexlScriptEngine instances, you probably should only do so
* if you are in strict control and sole user of the JEXL scripting feature.</p>
*
- * @return the shared underlying JEXL engine
+ * @return The shared underlying JEXL engine
*/
public JexlEngine getEngine() {
return jexlEngine;
@@ -251,7 +251,7 @@ public class JexlScriptEngine extends AbstractScriptEngine implements Compilable
/**
* Gives access to the engine scope error writer (defaults to System.err).
*
- * @return the engine error writer
+ * @return The engine error writer
*/
public PrintWriter getErr() {
final Writer error = context.getErrorWriter();
@@ -267,7 +267,7 @@ public class JexlScriptEngine extends AbstractScriptEngine implements Compilable
/**
* Gives access to the engine scope input reader (defaults to System.in).
*
- * @return the engine input reader
+ * @return The engine input reader
*/
public Reader getIn() {
return context.getReader();
@@ -276,7 +276,7 @@ public class JexlScriptEngine extends AbstractScriptEngine implements Compilable
/**
* Gives access to the engine logger.
*
- * @return the JexlScriptEngine logger
+ * @return The JexlScriptEngine logger
*/
public Log getLogger() {
return LOG;
@@ -285,7 +285,7 @@ public class JexlScriptEngine extends AbstractScriptEngine implements Compilable
/**
* Gives access to the engine scope output writer (defaults to System.out).
*
- * @return the engine output writer
+ * @return The engine output writer
*/
public PrintWriter getOut() {
final Writer out = context.getWriter();
@@ -329,7 +329,7 @@ public class JexlScriptEngine extends AbstractScriptEngine implements Compilable
* the contents of the reader.
*
* @param scriptReader to be read.
- * @return the contents of the reader as a String.
+ * @return The contents of the reader as a String.
* @throws ScriptException on any error reading the reader.
*/
private static String readerToString(final Reader scriptReader) throws ScriptException {
diff --git a/src/main/java/org/apache/commons/jexl3/scripting/JexlScriptEngineFactory.java b/src/main/java/org/apache/commons/jexl3/scripting/JexlScriptEngineFactory.java
index 7ddc549c..ca1dce80 100644
--- a/src/main/java/org/apache/commons/jexl3/scripting/JexlScriptEngineFactory.java
+++ b/src/main/java/org/apache/commons/jexl3/scripting/JexlScriptEngineFactory.java
@@ -82,7 +82,7 @@ public class JexlScriptEngineFactory implements ScriptEngineFactory {
/**
* Creates an engine.
- * @return the JexlEngine instance, create it if necessary
+ * @return The JexlEngine instance, create it if necessary
*/
protected JexlEngine getEngine() {
return createJexlEngine();
diff --git a/src/main/java/org/apache/commons/jexl3/scripting/Main.java b/src/main/java/org/apache/commons/jexl3/scripting/Main.java
index 99990a01..6dd05466 100644
--- a/src/main/java/org/apache/commons/jexl3/scripting/Main.java
+++ b/src/main/java/org/apache/commons/jexl3/scripting/Main.java
@@ -91,7 +91,7 @@ public class Main {
* Reads an input.
*
* @param path the file path or null for stdin
- * @return the reader
+ * @return The reader
* @throws IOException if anything goes wrong
*/
static BufferedReader read(final Path path) throws IOException {
diff --git a/src/test/java/org/apache/commons/jexl3/Arithmetic360.java b/src/test/java/org/apache/commons/jexl3/Arithmetic360.java
index 8c9705ad..d83f4bc4 100644
--- a/src/test/java/org/apache/commons/jexl3/Arithmetic360.java
+++ b/src/test/java/org/apache/commons/jexl3/Arithmetic360.java
@@ -66,7 +66,7 @@ public class Arithmetic360 extends JexlArithmetic {
/**
* Casts to Long if possible.
* @param value the Long or else
- * @return the Long or null
+ * @return The Long or null
*/
protected Long castLongNumber(final Object value) {
return value instanceof Long ? (Long) value : null;
diff --git a/src/test/java/org/apache/commons/jexl3/ArithmeticTest.java b/src/test/java/org/apache/commons/jexl3/ArithmeticTest.java
index c2291468..09433b28 100644
--- a/src/test/java/org/apache/commons/jexl3/ArithmeticTest.java
+++ b/src/test/java/org/apache/commons/jexl3/ArithmeticTest.java
@@ -505,7 +505,7 @@ class ArithmeticTest extends JexlTestCase {
/**
* Returns the Java version as an int value.
- * @return the Java version as an int value (8, 9, etc.)
+ * @return The Java version as an int value (8, 9, etc.)
*/
private static int getJavaVersion() {
String version = SystemProperties.getJavaVersion();
diff --git a/src/test/java/org/apache/commons/jexl3/CacheTest.java b/src/test/java/org/apache/commons/jexl3/CacheTest.java
index 41ef5974..1978b3f9 100644
--- a/src/test/java/org/apache/commons/jexl3/CacheTest.java
+++ b/src/test/java/org/apache/commons/jexl3/CacheTest.java
@@ -463,7 +463,7 @@ class CacheTest extends JexlTestCase {
* things up around 2x.
* </p>
* @param value the argument value to control
- * @return the number of loops performed
+ * @return The number of loops performed
*/
public Integer runAssign(final Object value) {
args.value = new Object[]{value};
diff --git a/src/test/java/org/apache/commons/jexl3/Issues300Test.java b/src/test/java/org/apache/commons/jexl3/Issues300Test.java
index 0aaa2818..d2fe5fd5 100644
--- a/src/test/java/org/apache/commons/jexl3/Issues300Test.java
+++ b/src/test/java/org/apache/commons/jexl3/Issues300Test.java
@@ -131,7 +131,7 @@ class Issues300Test {
*
* @param stream the stream
* @param filter the lambda to use as filter
- * @return the filtered stream
+ * @return The filtered stream
*/
public Stream<?> filter(final Stream<?> stream, final JexlScript filter) {
return stream.filter(x -> Boolean.TRUE.equals(filter.execute(this, x)));
diff --git a/src/test/java/org/apache/commons/jexl3/Issues400Test.java b/src/test/java/org/apache/commons/jexl3/Issues400Test.java
index 7aa3826f..fe21a39f 100644
--- a/src/test/java/org/apache/commons/jexl3/Issues400Test.java
+++ b/src/test/java/org/apache/commons/jexl3/Issues400Test.java
@@ -682,7 +682,7 @@ public class Issues400Test {
* Transcodes a SQL-inspired expression to a JEXL expression.
*
* @param expr the expression to transcode
- * @return the resulting expression
+ * @return The resulting expression
*/
private static String transcodeSQLExpr(final CharSequence expr) {
final StringBuilder strb = new StringBuilder(expr.length());
diff --git a/src/test/java/org/apache/commons/jexl3/LexicalTest.java b/src/test/java/org/apache/commons/jexl3/LexicalTest.java
index 5321e02f..fa2782a2 100644
--- a/src/test/java/org/apache/commons/jexl3/LexicalTest.java
+++ b/src/test/java/org/apache/commons/jexl3/LexicalTest.java
@@ -87,7 +87,7 @@ class LexicalTest {
* @param tryFn the lambda to call
* @param catchFn the lambda catching the exception
* @param args the arguments to the lambda
- * @return the tryFn result or the catchFn if an exception was raised
+ * @return The tryFn result or the catchFn if an exception was raised
*/
public Object tryCatch(final JexlScript tryFn, final JexlScript catchFn, final Object... args) {
Object result;
diff --git a/src/test/java/org/apache/commons/jexl3/ScriptTest.java b/src/test/java/org/apache/commons/jexl3/ScriptTest.java
index a02a92d8..f08c501f 100644
--- a/src/test/java/org/apache/commons/jexl3/ScriptTest.java
+++ b/src/test/java/org/apache/commons/jexl3/ScriptTest.java
@@ -75,7 +75,7 @@ class ScriptTest extends JexlTestCase {
/**
* Creates a simple local http server.
* <p>Only handles POST request on /test</p>
- * @return the server
+ * @return The server
* @throws IOException
*/
static HttpServer createJsonServer(final Function<HttpExchange, String> responder) throws IOException {
@@ -114,7 +114,7 @@ class ScriptTest extends JexlTestCase {
* HTTP post.
* @param sURL the url
* @param jsonData some json data
- * @return the result
+ * @return The result
* @throws IOException
*/
private static String httpPostRequest(final String sURL, final String jsonData) throws IOException {
diff --git a/src/test/java/org/apache/commons/jexl3/SpreadCache.java b/src/test/java/org/apache/commons/jexl3/SpreadCache.java
index 014811c4..2ea30e6d 100644
--- a/src/test/java/org/apache/commons/jexl3/SpreadCache.java
+++ b/src/test/java/org/apache/commons/jexl3/SpreadCache.java
@@ -30,7 +30,7 @@ import org.apache.commons.jexl3.internal.SoftCache;
*
* @param <K> The cached element"s key
* @param <V> The cached element"s value
- * @return the cache instance
+ * @return The cache instance
*/
public class SpreadCache<K, V> extends SoftCache<K, V> {
@@ -65,7 +65,7 @@ class SpreadMap<K, V> extends AbstractMap<K, V> {
* Returns a power of two for the given target capacity.
*
* @param cap capacity
- * @return the smallest power of 2 greater or equal to argument
+ * @return The smallest power of 2 greater or equal to argument
*/
private static int closestPowerOf2(final int cap) {
return cap > 1 ? Integer.highestOneBit(cap - 1) << 1 : 1;
@@ -117,7 +117,7 @@ class SpreadMap<K, V> extends AbstractMap<K, V> {
* Gets the map storing a given key.
*
* @param key the key
- * @return the map
+ * @return The map
*/
private final Map<K, V> getMap(final Object key) {
int h = key.hashCode();
diff --git a/src/test/java/org/apache/commons/jexl3/SynchronizedArithmetic.java b/src/test/java/org/apache/commons/jexl3/SynchronizedArithmetic.java
index 63ed86b5..4ead37c5 100644
--- a/src/test/java/org/apache/commons/jexl3/SynchronizedArithmetic.java
+++ b/src/test/java/org/apache/commons/jexl3/SynchronizedArithmetic.java
@@ -229,7 +229,7 @@ public class SynchronizedArithmetic extends JexlArithmetic {
* <p>synchronized(map) { return map.get(key); }
* @param map the map
* @param key the key
- * @return the value associated to the key in the map
+ * @return The value associated to the key in the map
*/
public Object arrayGet(final Map<?, ?> map, final Object key) {
abstractMonitor.monitorEnter(map);
@@ -259,7 +259,7 @@ public class SynchronizedArithmetic extends JexlArithmetic {
/**
* Creates an iterator on the map values that executes under the map monitor.
* @param map the map
- * @return the iterator
+ * @return The iterator
*/
public Iterator<Object> forEach(final Map<Object, Object> map) {
return new SynchronizedIterator(map, map.values().iterator());
@@ -271,7 +271,7 @@ public class SynchronizedArithmetic extends JexlArithmetic {
*
* @param map the map
* @param key the key
- * @return the value associated to the key in the map
+ * @return The value associated to the key in the map
*/
public Object propertyGet(final Map<?, ?> map, final Object key) {
abstractMonitor.monitorEnter(map);
diff --git a/src/test/java/org/apache/commons/jexl3/SynchronizedContext.java b/src/test/java/org/apache/commons/jexl3/SynchronizedContext.java
index 74edf0dc..2115be3b 100644
--- a/src/test/java/org/apache/commons/jexl3/SynchronizedContext.java
+++ b/src/test/java/org/apache/commons/jexl3/SynchronizedContext.java
@@ -32,7 +32,7 @@ public class SynchronizedContext extends MapContext implements JexlContext.Annot
* Calls a script synchronized by an object monitor.
* @param var the object used for sync
* @param script the script
- * @return the script value
+ * @return The script value
*/
public Object call(final Object var, final JexlScript script) {
final String[] parms = script.getParameters();
diff --git a/src/test/java/org/apache/commons/jexl3/VarTest.java b/src/test/java/org/apache/commons/jexl3/VarTest.java
index fffbd605..19e55249 100644
--- a/src/test/java/org/apache/commons/jexl3/VarTest.java
+++ b/src/test/java/org/apache/commons/jexl3/VarTest.java
@@ -94,7 +94,7 @@ class VarTest extends JexlTestCase {
/**
* Gets a list of properties.
* @param keys the property names
- * @return the property values
+ * @return The property values
*/
public List<String> get(final List<String> keys) {
final List<String> values = new ArrayList<>();
@@ -112,7 +112,7 @@ class VarTest extends JexlTestCase {
* <p>Uses each map key as a property name and each value as an alias
* used to key the resulting property value.
* @param map a map of property name to alias
- * @return the alia map
+ * @return The alia map
*/
public Map<String,Object> get(final Map<String,String> map) {
final Map<String,Object> values = new LinkedHashMap<>();
@@ -128,7 +128,7 @@ class VarTest extends JexlTestCase {
/**
* Gets a date property
* @param property yyyy or MM or dd
- * @return the string representation of year, month or day
+ * @return The string representation of year, month or day
*/
public String get(final String property) {
switch (property) {
@@ -147,7 +147,7 @@ class VarTest extends JexlTestCase {
/**
* Gets a list of properties.
* @param keys the property names
- * @return the property values
+ * @return The property values
*/
public List<String> get(final String[] keys) {
return get(Arrays.asList(keys));
@@ -165,7 +165,7 @@ class VarTest extends JexlTestCase {
/**
* Getting properties from an array, set or map.
* @param str the stringified source
- * @return the properties array
+ * @return The properties array
*/
private static String[] readIdentifiers(final String str) {
final List<String> ids = new ArrayList<>();
@@ -233,7 +233,7 @@ class VarTest extends JexlTestCase {
/**
* Creates a variable reference set from an array of array of strings.
* @param refs the variable reference set
- * @return the set of variables
+ * @return The set of variables
*/
Set<List<String>> mkref(final String[][] refs) {
final Set<List<String>> set = new HashSet<>();
diff --git a/src/test/java/org/apache/commons/jexl3/examples/StreamTest.java b/src/test/java/org/apache/commons/jexl3/examples/StreamTest.java
index fd9c58f3..99c2a3a4 100644
--- a/src/test/java/org/apache/commons/jexl3/examples/StreamTest.java
+++ b/src/test/java/org/apache/commons/jexl3/examples/StreamTest.java
@@ -63,7 +63,7 @@ public class StreamTest {
*
* @param collection the collection
* @param filter the lambda to use as filter
- * @return the filtered result as a list
+ * @return The filtered result as a list
*/
public List<?> filter(final Collection<?> collection, final JexlScript filter) {
return collection.stream()
@@ -76,7 +76,7 @@ public class StreamTest {
*
* @param collection the collection
* @param mapper the lambda to use as mapper
- * @return the mapped result as a list
+ * @return The mapped result as a list
*/
public List<?> map(final Collection<?> collection, final JexlScript mapper) {
return collection.stream()
@@ -96,7 +96,7 @@ public class StreamTest {
*
* @param stream the stream
* @param filter the lambda to use as filter
- * @return the filtered stream
+ * @return The filtered stream
*/
public Stream<?> filter(final Stream<?> stream, final JexlScript filter) {
return stream.filter(x -> x != null && TRUE.equals(filter.execute(this, x)));
@@ -107,7 +107,7 @@ public class StreamTest {
*
* @param stream the stream
* @param mapper the lambda to use as mapper
- * @return the mapped stream
+ * @return The mapped stream
*/
public Stream<?> map(final Stream<?> stream, final JexlScript mapper) {
return stream.map(x -> mapper.execute(this, x));
diff --git a/src/test/java/org/apache/commons/jexl3/internal/Util.java b/src/test/java/org/apache/commons/jexl3/internal/Util.java
index 2cbd0908..8223048c 100644
--- a/src/test/java/org/apache/commons/jexl3/internal/Util.java
+++ b/src/test/java/org/apache/commons/jexl3/internal/Util.java
@@ -129,7 +129,7 @@ public class Util {
/**
* Creates a list of all descendants of a script including itself.
* @param node the script to flatten
- * @return the descendants-and-self list
+ * @return The descendants-and-self list
*/
protected static ArrayList<JexlNode> flatten(final JexlNode node) {
final ArrayList<JexlNode> list = new ArrayList<>();
diff --git a/src/test/java/org/apache/commons/jexl3/jexl342/OptionalArithmetic.java b/src/test/java/org/apache/commons/jexl3/jexl342/OptionalArithmetic.java
index 14552c29..c69f7d6b 100644
--- a/src/test/java/org/apache/commons/jexl3/jexl342/OptionalArithmetic.java
+++ b/src/test/java/org/apache/commons/jexl3/jexl342/OptionalArithmetic.java
@@ -197,7 +197,7 @@ public class OptionalArithmetic extends JexlArithmetic {
/**
* Dereferences an Optional, a Reference or an AtomicReference, leave other as is.
* @param ref the reference
- * @return the referenced object
+ * @return The referenced object
*/
protected Object star(final Object ref) {
if (ref instanceof Optional<?>) {
diff --git a/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceGetExecutor.java b/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceGetExecutor.java
index ce9b7d82..53e8f555 100644
--- a/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceGetExecutor.java
+++ b/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceGetExecutor.java
@@ -48,7 +48,7 @@ public class ReferenceGetExecutor implements JexlPropertyGet {
* Dereference an expected optional or reference.
*
* @param ref the reference
- * @return the reference value or the reference
+ * @return The reference value or the reference
*/
protected Object getReference(final Object ref) {
return handler.callGet(ref);
diff --git a/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceMethodExecutor.java b/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceMethodExecutor.java
index f709c382..db529eab 100644
--- a/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceMethodExecutor.java
+++ b/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceMethodExecutor.java
@@ -49,7 +49,7 @@ public class ReferenceMethodExecutor implements JexlMethod {
* Dereference an expected optional or reference.
*
* @param opt the reference
- * @return the reference value
+ * @return The reference value
*/
protected Object getReference(final Object opt) {
return handler.callGet(opt);
diff --git a/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceSetExecutor.java b/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceSetExecutor.java
index 4e68cb21..770ccb03 100644
--- a/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceSetExecutor.java
+++ b/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceSetExecutor.java
@@ -49,7 +49,7 @@ public class ReferenceSetExecutor implements JexlPropertySet {
* Dereference an expected optional or reference.
*
* @param opt the reference
- * @return the reference value, TRY_FAILED if null
+ * @return The reference value, TRY_FAILED if null
*/
protected Object getReference(final Object opt) {
return handler.callGet(opt);
diff --git a/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceUberspect.java b/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceUberspect.java
index d66deae8..0ff390fd 100644
--- a/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceUberspect.java
+++ b/src/test/java/org/apache/commons/jexl3/jexl342/ReferenceUberspect.java
@@ -51,7 +51,7 @@ public class ReferenceUberspect implements JexlUberspect {
/**
* Performs a call to get().
* @param ref the reference
- * @return the value pointed by the reference
+ * @return The value pointed by the reference
*/
Object callGet(Object ref);
}
@@ -66,7 +66,7 @@ public class ReferenceUberspect implements JexlUberspect {
* @param is the uberspector
* @param clazz the class to find the get method from
* @param property the property name to find
- * @return the executor if found, null otherwise
+ * @return The executor if found, null otherwise
*/
private static JexlPropertyGet discoverFind(final JexlUberspect is, final Class<?> clazz, final String property) {
if (property == null || property.isEmpty()) {
@@ -118,7 +118,7 @@ public class ReferenceUberspect implements JexlUberspect {
/**
* Find a reference handler for a given instance.
* @param ref the reference
- * @return the handler or null if object cannot be handled
+ * @return The handler or null if object cannot be handled
*/
private static ReferenceHandler discoverHandler(final Object ref) {
// optional support
@@ -140,7 +140,7 @@ public class ReferenceUberspect implements JexlUberspect {
/**
* Cast ref to atomic reference, call get().
* @param ref the reference
- * @return the get() result if not null, ref otherwise
+ * @return The get() result if not null, ref otherwise
*/
static Object handleAtomic(final Object ref) {
final Object obj = ((AtomicReference<?>) ref).get();
@@ -150,7 +150,7 @@ public class ReferenceUberspect implements JexlUberspect {
/**
* Cast ref to optional, call isPresent()/get().
* @param ref the reference
- * @return the get() result
+ * @return The get() result
*/
static Object handleOptional(final Object ref) {
// optional support
@@ -161,7 +161,7 @@ public class ReferenceUberspect implements JexlUberspect {
/**
* Cast ref to reference, call get().
* @param ref the reference
- * @return the get() result if not null, ref otherwise
+ * @return The get() result if not null, ref otherwise
*/
static Object handleReference(final Object ref) {
final Object obj = ((Reference<?>) ref).get();
diff --git a/src/test/java/org/apache/commons/jexl3/junit/Asserter.java b/src/test/java/org/apache/commons/jexl3/junit/Asserter.java
index 2adf3a5d..830be557 100644
--- a/src/test/java/org/apache/commons/jexl3/junit/Asserter.java
+++ b/src/test/java/org/apache/commons/jexl3/junit/Asserter.java
@@ -118,7 +118,7 @@ public class Asserter {
/**
* Gets the underlying JEXL context.
- * @return the JEXL context
+ * @return The JEXL context
*/
public JexlContext getContext() {
return context;
@@ -126,7 +126,7 @@ public class Asserter {
/**
* Gets the underlying JEXL engine.
- * @return the JEXL engine
+ * @return The JEXL engine
*/
public JexlEngine getEngine() {
return engine;
@@ -143,7 +143,7 @@ public class Asserter {
}
/**
- * @return the variables map
+ * @return The variables map
*/
public Map<String, Object> getVariables() {
return variables;