Author: davsclaus
Date: Wed Oct 6 05:58:06 2010
New Revision: 1004899
URL: http://svn.apache.org/viewvc?rev=1004899&view=rev
Log:
Polished javadoc.
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/AsyncProcessor.java
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java
camel/trunk/camel-core/src/main/java/org/apache/camel/converter/IOConverter.java
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultHeaderFilterStrategy.java
camel/trunk/camel-core/src/main/java/org/apache/camel/model/OnExceptionDefinition.java
camel/trunk/camel-core/src/main/java/org/apache/camel/spi/TypeConverterAware.java
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionFromChoiceUseOriginalBodyTest.java
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionUseOriginalBodyTest.java
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/AsyncProcessor.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/AsyncProcessor.java?rev=1004899&r1=1004898&r2=1004899&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/AsyncProcessor.java
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/AsyncProcessor.java
Wed Oct 6 05:58:06 2010
@@ -44,7 +44,7 @@ public interface AsyncProcessor extends
* If the exchange is completed synchronously, then the
callback is also invoked synchronously.
* The callback should therefore be careful of starting
recursive loop.
* @return (doneSync) <tt>true</tt> to continue execute synchronously,
<tt>false</tt> to continue being executed asynchronously
- * @see {...@link
org.apache.camel.util.AsyncProcessorHelper#process(AsyncProcessor, Exchange,
AsyncCallback)}
+ * @see org.apache.camel.util.AsyncProcessorHelper#process(AsyncProcessor,
Exchange, AsyncCallback)
*/
boolean process(Exchange exchange, AsyncCallback callback);
}
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java?rev=1004899&r1=1004898&r2=1004899&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java Wed
Oct 6 05:58:06 2010
@@ -264,7 +264,7 @@ public interface CamelContext extends Su
* @param pattern an uri or pattern to match
* @return a collection of endpoints removed or null if there are no
endpoints for this URI
* @throws Exception if at least one endpoint could not be stopped
- * @see {...@link
org.apache.camel.util.EndpointHelper#matchEndpoint(String, String)} for pattern
+ * @see org.apache.camel.util.EndpointHelper#matchEndpoint(String, String)
for pattern
*/
Collection<Endpoint> removeEndpoints(String pattern) throws Exception;
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java?rev=1004899&r1=1004898&r2=1004899&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java Wed Oct
6 05:58:06 2010
@@ -53,15 +53,13 @@ import org.apache.camel.spi.UnitOfWork;
* you ensure all the information is kept for further processing. On the other
hand if you use the
* {...@link #getOut()} method to update the {...@link Message} then a
<b>new</b> message is created which
* means any headers, attachments or the likes from the {...@link #getIn()}
{...@link Message} is lost.
- * The {...@link #getOut()} method is often only used in special cases or
internally by Camel or specific
- * Camel components.
* <br/>
- * See also this <a
href="http://camel.apache.org/using-getin-or-getout-methods-on-exchange.html";>FAQ
entry</a> for more details.
+ * See this <a
href="http://camel.apache.org/using-getin-or-getout-methods-on-exchange.html";>FAQ
entry</a> for more details.
* <p/><br/>
* The {...@link ExchangePattern Message Exchange Pattern} and the {...@link
#getIn()} and {...@link #getOut()} methods
* are <b>not</b> strictly mapped. For example if the MEP is {...@link
org.apache.camel.ExchangePattern#InOnly} then
* you can still invoke the {...@link #getOut()} method. The {...@link
ExchangePattern Message Exchange Pattern} is
- * essentially just a flag to indicate the message pattern. That means you can
still set an out message using
+ * essentially just a flag to indicate the message pattern. That means you can
still set an OUT message using
* the {...@link #getOut()} method despite the pattern is {...@link
org.apache.camel.ExchangePattern#InOnly}.
*
* @version $Revision$
@@ -288,7 +286,8 @@ public interface Exchange {
* <p/>
* <br/>If you want to test whether an OUT message have been set or not,
use the {...@link #hasOut()} method.
* <p/>
- * See also the class java doc for this {...@link Exchange} for more
details.
+ * See also the class java doc for this {...@link Exchange} for more
details and this
+ * <a
href="http://camel.apache.org/using-getin-or-getout-methods-on-exchange.html";>FAQ
entry</a>.
*
* @return the response
* @see #getIn()
@@ -298,11 +297,14 @@ public interface Exchange {
/**
* Returns the outbound request message as the given type
* <p/>
- * <br/><b>Important:</b> If you want to change the current message, then
use {...@link #getIn(Class)} instead as it will
+ * <br/><b>Important:</b> If you want to change the current message, then
use {...@link #getIn()} instead as it will
* ensure headers etc. is kept and propagated when routing continues.
Bottom line end users should rarely use
* this method.
* <p/>
- * See also the class java doc for this {...@link Exchange} for more
details.
+ * <br/>If you want to test whether an OUT message have been set or not,
use the {...@link #hasOut()} method.
+ * <p/>
+ * See also the class java doc for this {...@link Exchange} for more
details and this
+ * <a
href="http://camel.apache.org/using-getin-or-getout-methods-on-exchange.html";>FAQ
entry</a>.
*
* @param type the given type
* @return the message as the given type or <tt>null</tt> if not possible
to covert to given type
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/converter/IOConverter.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/converter/IOConverter.java?rev=1004899&r1=1004898&r2=1004899&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/converter/IOConverter.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/converter/IOConverter.java
Wed Oct 6 05:58:06 2010
@@ -391,8 +391,6 @@ public final class IOConverter {
/**
* This method will take off the quotes and double quotes of the charset
- * @param charset
- * @return
*/
public static String normalizeCharset(String charset) {
if (charset != null) {
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java?rev=1004899&r1=1004898&r2=1004899&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
Wed Oct 6 05:58:06 2010
@@ -1630,7 +1630,7 @@ public class DefaultCamelContext extends
}
/**
- * @see
#safelyStartRouteServices(boolean,boolean,boolean,boolean,java.util.Collection
+ * @see
#safelyStartRouteServices(boolean,boolean,boolean,boolean,java.util.Collection)
*/
protected synchronized void safelyStartRouteServices(boolean
forceAutoStart, boolean checkClash, boolean startConsumer,
boolean
resumeConsumer, boolean addingRoutes, RouteService... routeServices) throws
Exception {
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultHeaderFilterStrategy.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultHeaderFilterStrategy.java?rev=1004899&r1=1004898&r2=1004899&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultHeaderFilterStrategy.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultHeaderFilterStrategy.java
Wed Oct 6 05:58:06 2010
@@ -27,7 +27,7 @@ import org.apache.camel.spi.HeaderFilter
* The default header filtering strategy. Users can configure filter by
* setting filter set and/or setting a regular expression. Subclass can
* add extended filter logic in
- * {...@link #extendedFilter(Direction, String, Object, Exchange)}
+ * {...@link
#extendedFilter(org.apache.camel.spi.HeaderFilterStrategy.Direction, String,
Object, org.apache.camel.Exchange)}
*
* Filters are associated with directions (in or out). "In" direction is
* referred to propagating headers "to" Camel message. The "out" direction
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/model/OnExceptionDefinition.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/model/OnExceptionDefinition.java?rev=1004899&r1=1004898&r2=1004899&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/model/OnExceptionDefinition.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/model/OnExceptionDefinition.java
Wed Oct 6 05:58:06 2010
@@ -517,28 +517,6 @@ public class OnExceptionDefinition exten
}
/**
- * Will use the original input body when an {...@link
org.apache.camel.Exchange} is moved to the dead letter queue.
- * <p/>
- * <b>Notice:</b> this only applies when all redeliveries attempt have
failed and the {...@link org.apache.camel.Exchange} is doomed for failure.
- * <br/>
- * Instead of using the current inprogress {...@link
org.apache.camel.Exchange} IN body we use the original IN body instead. This
allows
- * you to store the original input in the dead letter queue instead of the
inprogress snapshot of the IN body.
- * For instance if you route transform the IN body during routing and then
failed. With the original exchange
- * store in the dead letter queue it might be easier to manually re submit
the {...@link org.apache.camel.Exchange} again as the IN body
- * is the same as when Camel received it. So you should be able to send
the {...@link org.apache.camel.Exchange} to the same input.
- * <p/>
- * By default this feature is off.
- *
- * @Deprecated this method will be removed after Camel 2.4.0, please use
useOriginalMessage().
- * @return the builder
- */
- @Deprecated
- public OnExceptionDefinition useOriginalBody() {
- setUseOriginalMessagePolicy(Boolean.TRUE);
- return this;
- }
-
- /**
* Will use the original input message when an {...@link
org.apache.camel.Exchange} is moved to the dead letter queue.
* <p/>
* <b>Notice:</b> this only applies when all redeliveries attempt have
failed and the {...@link org.apache.camel.Exchange} is doomed for failure.
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/spi/TypeConverterAware.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/spi/TypeConverterAware.java?rev=1004899&r1=1004898&r2=1004899&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/spi/TypeConverterAware.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/spi/TypeConverterAware.java
Wed Oct 6 05:58:06 2010
@@ -22,8 +22,7 @@ import org.apache.camel.TypeConverter;
* An interface for an object which is interested in being injected with the
root {...@link TypeConverter}
* such as for implementing a fallback type converter
*
- * @see
org.apache.camel.impl.converter.DefaultTypeConverter#addFallbackTypeConverter(org.apache.camel.TypeConverter)
- * DefaultTypeConverter.addFallbackConverter
+ * @see
org.apache.camel.impl.converter.DefaultTypeConverter#addFallbackTypeConverter(org.apache.camel.TypeConverter,
boolean)
* @version $Revision$
*/
public interface TypeConverterAware {
Modified:
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionFromChoiceUseOriginalBodyTest.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionFromChoiceUseOriginalBodyTest.java?rev=1004899&r1=1004898&r2=1004899&view=diff
==============================================================================
---
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionFromChoiceUseOriginalBodyTest.java
(original)
+++
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionFromChoiceUseOriginalBodyTest.java
Wed Oct 6 05:58:06 2010
@@ -90,8 +90,8 @@ public class OnExceptionFromChoiceUseOri
public void configure() throws Exception {
errorHandler(deadLetterChannel("mock:error"));
-
onException(MyTechnicalException.class).useOriginalBody().maximumRedeliveries(0).handled(true).to("mock:tech");
-
onException(MyFunctionalException.class).useOriginalBody().maximumRedeliveries(0).handled(true).to("mock:func");
+
onException(MyTechnicalException.class).useOriginalMessage().maximumRedeliveries(0).handled(true).to("mock:tech");
+
onException(MyFunctionalException.class).useOriginalMessage().maximumRedeliveries(0).handled(true).to("mock:func");
from("direct:tech")
.setBody(constant("<order><type>myType</type><user>Tech</user></order>"))
Modified:
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionUseOriginalBodyTest.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionUseOriginalBodyTest.java?rev=1004899&r1=1004898&r2=1004899&view=diff
==============================================================================
---
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionUseOriginalBodyTest.java
(original)
+++
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/onexception/OnExceptionUseOriginalBodyTest.java
Wed Oct 6 05:58:06 2010
@@ -64,7 +64,7 @@ public class OnExceptionUseOriginalBodyT
// will use original exchange
onException(IllegalArgumentException.class)
- .maximumRedeliveries(2).useOriginalBody().handled(true)
+ .maximumRedeliveries(2).useOriginalMessage().handled(true)
.to("mock:a");
from("direct:a")
