You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by or...@apache.org on 2024/05/14 07:50:49 UTC
(camel) 01/02: (chores) camel-test: documentation fixes
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit bffc6a3cbeb3d4ea3ea1c6a041e965050e280239
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Fri May 10 14:43:46 2024 +0200
(chores) camel-test: documentation fixes
- fixed typos
- minor documentation cleanups
---
.../src/main/java/org/apache/camel/test/junit5/CamelTestSupport.java | 4 ++--
.../org/apache/camel/test/junit5/EndpointUriFactoryTestSupport.java | 2 +-
.../java/org/apache/camel/test/junit5/patterns/DebugJUnit5Test.java | 2 +-
.../camel/test/junit5/patterns/DebugNoLazyTypeConverterTest.java | 2 +-
.../test/java/org/apache/camel/test/junit5/patterns/DebugTest.java | 2 +-
.../main/java/org/apache/camel/test/main/junit5/CamelMainTest.java | 4 ++--
.../java/org/apache/camel/test/main/junit5/CamelMainTestSupport.java | 4 ++--
.../camel/test/spring/junit5/CamelSpringBootExecutionListener.java | 2 +-
.../apache/camel/test/spring/junit5/CamelSpringTestContextLoader.java | 3 +--
.../junit5/CamelSpringTestContextLoaderTestExecutionListener.java | 2 +-
.../src/main/java/org/apache/camel/test/spring/junit5/DisableJmx.java | 2 +-
.../camel/test/spring/junit5/StopWatchTestExecutionListener.java | 2 +-
.../src/test/java/org/apache/camel/test/patterns/DebugSpringTest.java | 2 +-
.../camel/test/spring/CamelSpringTestSupportActiveProfileTest.java | 2 +-
14 files changed, 17 insertions(+), 18 deletions(-)
diff --git a/components/camel-test/camel-test-junit5/src/main/java/org/apache/camel/test/junit5/CamelTestSupport.java b/components/camel-test/camel-test-junit5/src/main/java/org/apache/camel/test/junit5/CamelTestSupport.java
index 53bc6fe693a..a7f486d0ccd 100644
--- a/components/camel-test/camel-test-junit5/src/main/java/org/apache/camel/test/junit5/CamelTestSupport.java
+++ b/components/camel-test/camel-test-junit5/src/main/java/org/apache/camel/test/junit5/CamelTestSupport.java
@@ -642,7 +642,7 @@ public abstract class CamelTestSupport
}
/**
- * Whether or not JMX should be used during testing.
+ * Whether JMX should be used during testing.
*
* @return <tt>false</tt> by default.
*/
@@ -858,7 +858,7 @@ public abstract class CamelTestSupport
* mock:foo and mock:foo?retainFirst=5 would match as the queue name is foo.
*
* @param uri the URI which typically starts with "mock:" and has some name
- * @param create whether or not to allow the endpoint to be created if it doesn't exist
+ * @param create whether to allow the endpoint to be created if it doesn't exist
* @return the mock endpoint or an {@link NoSuchEndpointException} is thrown if it could not
* be resolved
* @throws NoSuchEndpointException is the mock endpoint does not exist
diff --git a/components/camel-test/camel-test-junit5/src/main/java/org/apache/camel/test/junit5/EndpointUriFactoryTestSupport.java b/components/camel-test/camel-test-junit5/src/main/java/org/apache/camel/test/junit5/EndpointUriFactoryTestSupport.java
index 7823afac9ec..a3b0013be53 100644
--- a/components/camel-test/camel-test-junit5/src/main/java/org/apache/camel/test/junit5/EndpointUriFactoryTestSupport.java
+++ b/components/camel-test/camel-test-junit5/src/main/java/org/apache/camel/test/junit5/EndpointUriFactoryTestSupport.java
@@ -26,7 +26,7 @@ public abstract class EndpointUriFactoryTestSupport extends CamelTestSupport {
@Test
public void buildUri() {
- // let's just see if the route starts successfully
+ // let's see if the route starts successfully
}
protected abstract String scheme();
diff --git a/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugJUnit5Test.java b/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugJUnit5Test.java
index 979ce8bf48d..510d8f20094 100644
--- a/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugJUnit5Test.java
+++ b/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugJUnit5Test.java
@@ -42,7 +42,7 @@ public class DebugJUnit5Test extends CamelTestSupport {
Exchange exchange, Processor processor, ProcessorDefinition<?> definition, String id, String shortName) {
// this method is invoked before we are about to enter the given
// processor
- // from your Java editor you can just add a breakpoint in the code line
+ // from your Java editor you can add a breakpoint in the code line
// below
LOG.info("Before {} with body {}", definition, exchange.getIn().getBody());
}
diff --git a/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugNoLazyTypeConverterTest.java b/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugNoLazyTypeConverterTest.java
index 1bacdf34ad8..7d00bf5c690 100644
--- a/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugNoLazyTypeConverterTest.java
+++ b/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugNoLazyTypeConverterTest.java
@@ -42,7 +42,7 @@ public class DebugNoLazyTypeConverterTest extends CamelTestSupport {
Exchange exchange, Processor processor, ProcessorDefinition<?> definition, String id, String shortName) {
// this method is invoked before we are about to enter the given
// processor
- // from your Java editor you can just add a breakpoint in the code line
+ // from your Java editor you can add a breakpoint in the code line
// below
LOG.info("Before {} with body {}", definition, exchange.getIn().getBody());
}
diff --git a/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugTest.java b/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugTest.java
index b39681e3a68..bd28f4ad521 100644
--- a/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugTest.java
+++ b/components/camel-test/camel-test-junit5/src/test/java/org/apache/camel/test/junit5/patterns/DebugTest.java
@@ -42,7 +42,7 @@ public class DebugTest extends CamelTestSupport {
Exchange exchange, Processor processor, ProcessorDefinition<?> definition, String id, String shortName) {
// this method is invoked before we are about to enter the given
// processor
- // from your Java editor you can just add a breakpoint in the code line
+ // from your Java editor you can add a breakpoint in the code line
// below
LOG.info("Before {} with body {}", definition, exchange.getIn().getBody());
}
diff --git a/components/camel-test/camel-test-main-junit5/src/main/java/org/apache/camel/test/main/junit5/CamelMainTest.java b/components/camel-test/camel-test-main-junit5/src/main/java/org/apache/camel/test/main/junit5/CamelMainTest.java
index 954f64f22f7..c88d0234000 100644
--- a/components/camel-test/camel-test-main-junit5/src/main/java/org/apache/camel/test/main/junit5/CamelMainTest.java
+++ b/components/camel-test/camel-test-main-junit5/src/main/java/org/apache/camel/test/main/junit5/CamelMainTest.java
@@ -58,8 +58,8 @@ import org.junit.jupiter.api.extension.ExtendWith;
public @interface CamelMainTest {
/**
- * Allows to specify the main class of the application to test if needed in order to simulate the same behavior as
- * with {@link org.apache.camel.main.Main#Main(Class)}.
+ * Allows to specify the main class of the application to test if needed to simulate the same behavior as with
+ * {@link org.apache.camel.main.Main#Main(Class)}.
* <p/>
* <b>Note:</b> This attribute can be set from a {@code @Nested} test classes. The value of this attribute set on
* the innermost class is used.
diff --git a/components/camel-test/camel-test-main-junit5/src/main/java/org/apache/camel/test/main/junit5/CamelMainTestSupport.java b/components/camel-test/camel-test-main-junit5/src/main/java/org/apache/camel/test/main/junit5/CamelMainTestSupport.java
index e881930c129..e3bd561e6aa 100644
--- a/components/camel-test/camel-test-main-junit5/src/main/java/org/apache/camel/test/main/junit5/CamelMainTestSupport.java
+++ b/components/camel-test/camel-test-main-junit5/src/main/java/org/apache/camel/test/main/junit5/CamelMainTestSupport.java
@@ -121,8 +121,8 @@ public abstract class CamelMainTestSupport extends CamelTestSupport {
}
/**
- * Allows to specify the main class of the application to test if needed in order to simulate the same behavior as
- * with {@link org.apache.camel.main.Main#Main(Class)}.
+ * Allows specifying the main class of the application to test if needed to simulate the same behavior as with
+ * {@link org.apache.camel.main.Main#Main(Class)}.
*
* @return the main class of the application to test if any. {@code null} by default indicating that there is no
* specific main class.
diff --git a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringBootExecutionListener.java b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringBootExecutionListener.java
index cf19b82c11e..f3a1864270f 100644
--- a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringBootExecutionListener.java
+++ b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringBootExecutionListener.java
@@ -31,7 +31,7 @@ public class CamelSpringBootExecutionListener extends AbstractTestExecutionListe
private static final String PROPERTY_SKIP_STARTING_CAMEL_CONTEXT = "skipStartingCamelContext";
/**
- * Returns the precedence that is used by Spring to choose the appropriate execution order of test listeners.
+ * Returns the precedence used by Spring to choose the appropriate execution order of test listeners.
*
* See {@link SpringTestExecutionListenerSorter#getPrecedence(Class)} for more.
*/
diff --git a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringTestContextLoader.java b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringTestContextLoader.java
index 3795eb88c1c..9fa6c0e3c49 100644
--- a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringTestContextLoader.java
+++ b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringTestContextLoader.java
@@ -233,8 +233,7 @@ public class CamelSpringTestContextLoader extends AbstractContextLoader {
}
/**
- * Returns the class under test in order to enable inspection of annotations while the Spring context is being
- * created.
+ * Returns the class under test to enable inspection of annotations while the Spring context is being created.
*
* @return the test class that is being executed
* @see CamelSpringTestHelper
diff --git a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringTestContextLoaderTestExecutionListener.java b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringTestContextLoaderTestExecutionListener.java
index 310349d6c4c..c1ce699a877 100644
--- a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringTestContextLoaderTestExecutionListener.java
+++ b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/CamelSpringTestContextLoaderTestExecutionListener.java
@@ -29,7 +29,7 @@ import org.springframework.test.context.support.AbstractTestExecutionListener;
public class CamelSpringTestContextLoaderTestExecutionListener extends AbstractTestExecutionListener {
/**
- * Returns the precedence that is used by Spring to choose the appropriate execution order of test listeners.
+ * Returns the precedence used by Spring to choose the appropriate execution order of test listeners.
*
* See {@link SpringTestExecutionListenerSorter#getPrecedence(Class)} for more.
*/
diff --git a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/DisableJmx.java b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/DisableJmx.java
index 0ea3d9b16cc..a076959a35c 100644
--- a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/DisableJmx.java
+++ b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/DisableJmx.java
@@ -26,7 +26,7 @@ import java.lang.annotation.Target;
/**
* Indicates if JMX should be globally disabled in the {@code CamelContext}s that are bootstrapped during the test
* through the use of Spring Test loaded application contexts. Note that the presence of this annotation will result in
- * the manipulation of System Properties that will affect Camel contexts constructed outside of the Spring Test loaded
+ * the manipulation of System Properties that will affect Camel contexts constructed outside the Spring Test loaded
* application contexts.
*/
@Documented
diff --git a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/StopWatchTestExecutionListener.java b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/StopWatchTestExecutionListener.java
index 58ef8ada46f..aacc85942c8 100644
--- a/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/StopWatchTestExecutionListener.java
+++ b/components/camel-test/camel-test-spring-junit5/src/main/java/org/apache/camel/test/spring/junit5/StopWatchTestExecutionListener.java
@@ -32,7 +32,7 @@ public class StopWatchTestExecutionListener extends AbstractTestExecutionListene
protected static ThreadLocal<StopWatch> threadStopWatch = new ThreadLocal<>();
/**
- * Returns the precedence that is used by Spring to choose the appropriate execution order of test listeners.
+ * Returns the precedence used by Spring to choose the appropriate execution order of test listeners.
*
* See {@link SpringTestExecutionListenerSorter#getPrecedence(Class)} for more.
*/
diff --git a/components/camel-test/camel-test-spring-junit5/src/test/java/org/apache/camel/test/patterns/DebugSpringTest.java b/components/camel-test/camel-test-spring-junit5/src/test/java/org/apache/camel/test/patterns/DebugSpringTest.java
index 3c45bf5fc53..abc7a2feeb4 100644
--- a/components/camel-test/camel-test-spring-junit5/src/test/java/org/apache/camel/test/patterns/DebugSpringTest.java
+++ b/components/camel-test/camel-test-spring-junit5/src/test/java/org/apache/camel/test/patterns/DebugSpringTest.java
@@ -46,7 +46,7 @@ public class DebugSpringTest extends CamelSpringTestSupport {
Exchange exchange, Processor processor,
ProcessorDefinition<?> definition, String id, String shortName) {
// this method is invoked before we are about to enter the given processor
- // from your Java editor you can just add a breakpoint in the code line below
+ // from your Java editor you can add a breakpoint in the code line below
LOG.info("Before {} with body {}", definition, exchange.getIn().getBody());
debugged = true;
}
diff --git a/components/camel-test/camel-test-spring-junit5/src/test/java/org/apache/camel/test/spring/CamelSpringTestSupportActiveProfileTest.java b/components/camel-test/camel-test-spring-junit5/src/test/java/org/apache/camel/test/spring/CamelSpringTestSupportActiveProfileTest.java
index 4467c6bf132..636f7441a39 100644
--- a/components/camel-test/camel-test-spring-junit5/src/test/java/org/apache/camel/test/spring/CamelSpringTestSupportActiveProfileTest.java
+++ b/components/camel-test/camel-test-spring-junit5/src/test/java/org/apache/camel/test/spring/CamelSpringTestSupportActiveProfileTest.java
@@ -25,7 +25,7 @@ import org.springframework.context.support.ClassPathXmlApplicationContext;
// START SNIPPET: e1
/**
- * Just extend the CamelSpringTestSupport and use Camel test kit for easy Camel based unit testing.
+ * Extend the CamelSpringTestSupport and use Camel test kit for easy Camel based unit testing.
*/
public class CamelSpringTestSupportActiveProfileTest extends CamelSpringTestSupport {