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 2023/08/07 10:55:31 UTC

[camel] branch main updated: (chores) camel-mock: documentation cleanup (#11022)

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


The following commit(s) were added to refs/heads/main by this push:
     new 1df4ddfabb6 (chores) camel-mock: documentation cleanup (#11022)
1df4ddfabb6 is described below

commit 1df4ddfabb671dee09529242e233d3fc763356c6
Author: Otavio Rodolfo Piske <or...@users.noreply.github.com>
AuthorDate: Mon Aug 7 12:55:25 2023 +0200

    (chores) camel-mock: documentation cleanup (#11022)
    
    - cleanup typos
    - fix other minor documentation issues
---
 .../apache/camel/component/mock/MockEndpoint.java  | 26 +++++++++++-----------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/components/camel-mock/src/main/java/org/apache/camel/component/mock/MockEndpoint.java b/components/camel-mock/src/main/java/org/apache/camel/component/mock/MockEndpoint.java
index a7369e2298a..cc3f189a51b 100644
--- a/components/camel-mock/src/main/java/org/apache/camel/component/mock/MockEndpoint.java
+++ b/components/camel-mock/src/main/java/org/apache/camel/component/mock/MockEndpoint.java
@@ -645,7 +645,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
     }
 
     /**
-     * Adds an expectation that the given header values are received by this endpoint in any order.
+     * Adds an expectation that this endpoint receives the given header values in any order.
      * <p/>
      * <b>Important:</b> The number of values must match the expected number of messages, so if you expect 3 messages,
      * then there must be 3 values.
@@ -679,7 +679,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
     }
 
     /**
-     * Adds an expectation that the given header values are received by this endpoint in any order
+     * Adds an expectation that this endpoint receives the given header values in any order
      * <p/>
      * <b>Important:</b> The number of values must match the expected number of messages, so if you expect 3 messages,
      * then there must be 3 values.
@@ -733,7 +733,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
     }
 
     /**
-     * Adds an expectation that the given property values are received by this endpoint in any order.
+     * Adds an expectation that this endpoint receives the given property values in any order.
      * <p/>
      * <b>Important:</b> The number of values must match the expected number of messages, so if you expect 3 messages,
      * then there must be 3 values.
@@ -767,7 +767,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
     }
 
     /**
-     * Adds an expectation that the given property values are received by this endpoint in any order
+     * Adds an expectation that this endpoint receives the given property values in any order
      * <p/>
      * <b>Important:</b> The number of values must match the expected number of messages, so if you expect 3 messages,
      * then there must be 3 values.
@@ -780,7 +780,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
     }
 
     /**
-     * Adds an expectation that the given body values are received by this endpoint in the specified order
+     * Adds an expectation that this endpoint receives the given body values in the specified order
      * <p/>
      * <b>Important:</b> The number of values must match the expected number of messages, so if you expect 3 messages,
      * then there must be 3 values.
@@ -896,7 +896,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
     }
 
     /**
-     * Adds an expectation that the given body values are received by this endpoint in any order
+     * Adds an expectation that this endpoint receives the given body values in any order
      * <p/>
      * <b>Important:</b> The number of bodies must match the expected number of messages, so if you expect 3 messages,
      * then there must be 3 bodies.
@@ -921,7 +921,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
     }
 
     /**
-     * Adds an expectation that the given body values are received by this endpoint in any order
+     * Adds an expectation that this endpoint receives the given body values in any order
      * <p/>
      * <b>Important:</b> The number of bodies must match the expected number of messages, so if you expect 3 messages,
      * then there must be 3 bodies.
@@ -1421,7 +1421,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
      * is done routing some messages, before you call the {@link #assertIsSatisfied()} method on the mocks. This allows
      * you to not use a fixed assert period, to speedup testing times.
      * <p/>
-     * If you want to assert that <b>exactly</b> n'th message arrives to this mock endpoint, then see also the
+     * If you want to assert that <b>exactly</b> nth message arrives to this mock endpoint, then see also the
      * {@link #setAssertPeriod(long)} method for further details.
      *
      * @param expectedCount the number of message exchanges that should be expected by this endpoint
@@ -1473,7 +1473,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
     }
 
     /**
-     * Specifies to only retain the first n'th number of received {@link Exchange}s.
+     * Specifies to only retain the first nth number of received {@link Exchange}s.
      * <p/>
      * This is used when testing with big data, to reduce memory consumption by not storing copies of every
      * {@link Exchange} this mock endpoint receives.
@@ -1503,7 +1503,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
     }
 
     /**
-     * Specifies to only retain the last n'th number of received {@link Exchange}s.
+     * Specifies to only retain the last nth number of received {@link Exchange}s.
      * <p/>
      * This is used when testing with big data, to reduce memory consumption by not storing copies of every
      * {@link Exchange} this mock endpoint receives.
@@ -1606,7 +1606,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
             performAssertions(exchange, copy);
 
             if (failFast) {
-                // fail fast mode so check n'th expectations as soon as possible
+                // fail fast mode so check nth expectations as soon as possible
                 int index = getReceivedCounter() - 1;
                 for (Runnable test : tests) {
                     // only assertion tasks can support fail fast mode
@@ -1656,7 +1656,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
                 if (factory != null) {
                     actualHeaderValues = factory.newMap();
                 } else {
-                    // should not really happen but some tests dont start camel context
+                    // should not really happen but some tests don't start camel context
                     actualHeaderValues = new HashMap<>();
                 }
             }
@@ -1739,7 +1739,7 @@ public class MockEndpoint extends DefaultEndpoint implements BrowsableEndpoint,
                         receivedExchanges.remove(index);
                     }
                 }
-                // store a copy of the last n'th received
+                // store a copy of the last nth received
                 receivedExchanges.add(copy);
             }
         }