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 2023/11/26 20:56:55 UTC
(commons-ognl) branch master updated: Javadoc spelling
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-ognl.git
The following commit(s) were added to refs/heads/master by this push:
new 98c48bb Javadoc spelling
98c48bb is described below
commit 98c48bb36c1e996cd93f10f945c3ef86aa7f0a71
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Nov 26 15:56:51 2023 -0500
Javadoc spelling
---
src/main/java/org/apache/commons/ognl/JavaSource.java | 10 +++++-----
src/main/java/org/apache/commons/ognl/Ognl.java | 2 +-
src/main/java/org/apache/commons/ognl/OgnlRuntime.java | 4 ++--
src/main/java/org/apache/commons/ognl/PropertyAccessor.java | 4 ++--
.../org/apache/commons/ognl/enhance/ExpressionAccessor.java | 4 ++--
.../org/apache/commons/ognl/enhance/ExpressionCompiler.java | 10 +++++-----
.../apache/commons/ognl/enhance/OgnlExpressionCompiler.java | 6 +++---
.../commons/ognl/enhance/UnsupportedCompilationException.java | 2 +-
src/test/java/org/apache/commons/ognl/test/GenericsTest.java | 2 +-
.../java/org/apache/commons/ognl/test/objects/BaseGeneric.java | 2 +-
10 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/src/main/java/org/apache/commons/ognl/JavaSource.java b/src/main/java/org/apache/commons/ognl/JavaSource.java
index bb37115..ec2174a 100644
--- a/src/main/java/org/apache/commons/ognl/JavaSource.java
+++ b/src/main/java/org/apache/commons/ognl/JavaSource.java
@@ -21,26 +21,26 @@ package org.apache.commons.ognl;
/**
* Defines an object that can return a representation of itself and any objects it contains in the form of a
- * {@link String} embedded with literal java statements.
+ * {@link String} embedded with literal Java statements.
*/
public interface JavaSource
{
/**
- * Expected to return a java source representation of itself such that it could be turned into a literal java
+ * Expected to return a java source representation of itself such that it could be turned into a literal Java
* expression to be compiled and executed for
* {@link org.apache.commons.ognl.enhance.ExpressionAccessor#get(OgnlContext, Object)} calls.
*
- * @return Literal java string representation of an object get.
+ * @return Literal Java string representation of an object get.
*/
String toGetSourceString( OgnlContext context, Object target );
/**
- * Expected to return a java source representation of itself such that it could be turned into a literal java
+ * Expected to return a java source representation of itself such that it could be turned into a literal Java
* expression to be compiled and executed for
* {@link org.apache.commons.ognl.enhance.ExpressionAccessor#get(OgnlContext, Object)} calls.
*
- * @return Literal java string representation of an object get.
+ * @return Literal Java string representation of an object get.
*/
String toSetSourceString( OgnlContext context, Object target );
diff --git a/src/main/java/org/apache/commons/ognl/Ognl.java b/src/main/java/org/apache/commons/ognl/Ognl.java
index 6d1394b..8d3e8a7 100644
--- a/src/main/java/org/apache/commons/ognl/Ognl.java
+++ b/src/main/java/org/apache/commons/ognl/Ognl.java
@@ -307,7 +307,7 @@ public abstract class Ognl
}
/**
- * Configures the type converter to use for a given context. This will be used to convert into / out of various java
+ * Configures the type converter to use for a given context. This will be used to convert into / out of various Java
* class types.
*
* @param context The context to configure it for.
diff --git a/src/main/java/org/apache/commons/ognl/OgnlRuntime.java b/src/main/java/org/apache/commons/ognl/OgnlRuntime.java
index 2e58fb4..7eacf43 100644
--- a/src/main/java/org/apache/commons/ognl/OgnlRuntime.java
+++ b/src/main/java/org/apache/commons/ognl/OgnlRuntime.java
@@ -2015,7 +2015,7 @@ public class OgnlRuntime
}
/**
- * Attempts to get the java source string represented by the specific child expression via the
+ * Attempts to get the Java source string represented by the specific child expression via the
* {@link JavaSource#toGetSourceString(OgnlContext, Object)} interface method.
*
* @param context The ognl context to pass to the child.
@@ -2032,7 +2032,7 @@ public class OgnlRuntime
}
/**
- * Attempts to get the java source string represented by the specific child expression via the
+ * Attempts to get the Java source string represented by the specific child expression via the
* {@link JavaSource#toGetSourceString(OgnlContext, Object)} interface method.
*
* @param context The ognl context to pass to the child.
diff --git a/src/main/java/org/apache/commons/ognl/PropertyAccessor.java b/src/main/java/org/apache/commons/ognl/PropertyAccessor.java
index c4840fa..f3bd10d 100644
--- a/src/main/java/org/apache/commons/ognl/PropertyAccessor.java
+++ b/src/main/java/org/apache/commons/ognl/PropertyAccessor.java
@@ -63,7 +63,7 @@ public interface PropertyAccessor
throws OgnlException;
/**
- * Returns a java string representing the textual method that should be called to access a particular element. (ie
+ * Returns a Java string representing the textual method that should be called to access a particular element. (ie
* "get")
*
* @param context The current execution context.
@@ -74,7 +74,7 @@ public interface PropertyAccessor
String getSourceAccessor( OgnlContext context, Object target, Object index );
/**
- * Returns a java string representing the textual method that should be called to set a particular element. (ie
+ * Returns a Java string representing the textual method that should be called to set a particular element. (ie
* "set")
*
* @param context The current execution context.
diff --git a/src/main/java/org/apache/commons/ognl/enhance/ExpressionAccessor.java b/src/main/java/org/apache/commons/ognl/enhance/ExpressionAccessor.java
index 6905516..aaff236 100644
--- a/src/main/java/org/apache/commons/ognl/enhance/ExpressionAccessor.java
+++ b/src/main/java/org/apache/commons/ognl/enhance/ExpressionAccessor.java
@@ -23,8 +23,8 @@ import org.apache.commons.ognl.Node;
import org.apache.commons.ognl.OgnlContext;
/**
- * Provides pure java expression paths to get/set values from an ognl expression. This is achieved by taking an existing
- * {@link Node} parsed expression and using bytecode enhancements to do the same work using pure java vs the ognl
+ * Provides pure Java expression paths to get/set values from an ognl expression. This is achieved by taking an existing
+ * {@link Node} parsed expression and using bytecode enhancements to do the same work using pure Java vs the ognl
* interpreter.
*/
public interface ExpressionAccessor
diff --git a/src/main/java/org/apache/commons/ognl/enhance/ExpressionCompiler.java b/src/main/java/org/apache/commons/ognl/enhance/ExpressionCompiler.java
index e915ed8..bdd4c4f 100644
--- a/src/main/java/org/apache/commons/ognl/enhance/ExpressionCompiler.java
+++ b/src/main/java/org/apache/commons/ognl/enhance/ExpressionCompiler.java
@@ -59,7 +59,7 @@ import java.util.Set;
import static java.lang.String.format;
/**
- * Responsible for managing/providing functionality related to compiling generated java source expressions via bytecode
+ * Responsible for managing/providing functionality related to compiling generated Java source expressions via bytecode
* enhancements for a given ognl expression.
*/
public class ExpressionCompiler
@@ -67,7 +67,7 @@ public class ExpressionCompiler
{
/**
- * Key used to store any java source string casting statements in the {@link OgnlContext} during class compilation.
+ * Key used to store any Java source string casting statements in the {@link OgnlContext} during class compilation.
*/
public static final String PRE_CAST = "_preCast";
@@ -85,12 +85,12 @@ public class ExpressionCompiler
/**
* Used by {@link #castExpression(org.apache.commons.ognl.OgnlContext, org.apache.commons.ognl.Node, String)} to
- * store the cast java source string in to the current {@link org.apache.commons.ognl.OgnlContext}. This will either
+ * store the cast Java source string in to the current {@link org.apache.commons.ognl.OgnlContext}. This will either
* add to the existing string present if it already exists or create a new instance and store it using the static
* key of {@link #PRE_CAST}.
*
* @param context The current execution context.
- * @param cast The java source string to store in to the context.
+ * @param cast The Java source string to store in to the context.
*/
public static void addCastString( OgnlContext context, String cast )
{
@@ -136,7 +136,7 @@ public class ExpressionCompiler
* @param expression The node to check and generate a root expression to if necessary.
* @param root The root object for this execution.
* @param context The current execution context.
- * @return Either an empty string or a root path java source string compatible with javassist compilations from the
+ * @return Either an empty string or a root path Java source string compatible with javassist compilations from the
* root object up to the specified {@link Node}.
*/
public static String getRootExpression( Node expression, Object root, OgnlContext context )
diff --git a/src/main/java/org/apache/commons/ognl/enhance/OgnlExpressionCompiler.java b/src/main/java/org/apache/commons/ognl/enhance/OgnlExpressionCompiler.java
index 55b1421..3922feb 100644
--- a/src/main/java/org/apache/commons/ognl/enhance/OgnlExpressionCompiler.java
+++ b/src/main/java/org/apache/commons/ognl/enhance/OgnlExpressionCompiler.java
@@ -100,13 +100,13 @@ public interface OgnlExpressionCompiler
*
* @param context The current execution context.
* @param expression The node being checked for casting.
- * @param body The java source string generated by the given node.
+ * @param body The Java source string generated by the given node.
* @return The body string parameter plus any additional casting syntax needed to make the expression resolvable.
*/
String castExpression( OgnlContext context, Node expression, String body );
/**
- * Method is used for expressions where multiple inner parameter method calls in generated java source strings cause
+ * Method is used for expressions where multiple inner parameter method calls in generated Java source strings cause
* javassit failures. It is hacky and cumbersome to have to generate expressions this way but it's the only current
* known way to make javassist happy.
* <p>
@@ -116,7 +116,7 @@ public interface OgnlExpressionCompiler
* </p>
*
* @param context The current execution context.
- * @param expression The java source expression to dump in to a seperate method reference.
+ * @param expression The Java source expression to dump in to a seperate method reference.
* @param type The return type that should be specified for the new method.
* @return The method name that will be used to reference the sub expression in place of the actual sub expression
* itself.
diff --git a/src/main/java/org/apache/commons/ognl/enhance/UnsupportedCompilationException.java b/src/main/java/org/apache/commons/ognl/enhance/UnsupportedCompilationException.java
index 9639799..1d15521 100644
--- a/src/main/java/org/apache/commons/ognl/enhance/UnsupportedCompilationException.java
+++ b/src/main/java/org/apache/commons/ognl/enhance/UnsupportedCompilationException.java
@@ -21,7 +21,7 @@ package org.apache.commons.ognl.enhance;
/**
* Thrown during bytecode enhancement conversions of ognl expressions to indicate that a certain expression isn't
- * currently supported as a pure java bytecode enhanced version.
+ * currently supported as a pure Java bytecode enhanced version.
* <p>
* If this exception is thrown it is expected that ognl will fall back to default ognl evaluation of the expression.
* </p>
diff --git a/src/test/java/org/apache/commons/ognl/test/GenericsTest.java b/src/test/java/org/apache/commons/ognl/test/GenericsTest.java
index 4ffb377..412bcbc 100644
--- a/src/test/java/org/apache/commons/ognl/test/GenericsTest.java
+++ b/src/test/java/org/apache/commons/ognl/test/GenericsTest.java
@@ -30,7 +30,7 @@ import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests java >= 1.5 generics support in ognl.
+ * Tests Java >= 1.5 generics support in ognl.
*/
@RunWith(value = Parameterized.class)
public class GenericsTest
diff --git a/src/test/java/org/apache/commons/ognl/test/objects/BaseGeneric.java b/src/test/java/org/apache/commons/ognl/test/objects/BaseGeneric.java
index 622f7a2..9164e12 100644
--- a/src/test/java/org/apache/commons/ognl/test/objects/BaseGeneric.java
+++ b/src/test/java/org/apache/commons/ognl/test/objects/BaseGeneric.java
@@ -21,7 +21,7 @@ package org.apache.commons.ognl.test.objects;
import java.io.Serializable;
/**
- * Used to test ognl handling of java generics.
+ * Used to test ognl handling of Java generics.
*/
public class BaseGeneric<E extends GenericObject, I extends Serializable>
{