camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jstrac...@apache.org
Subject svn commit: r701059 - in /activemq/camel/trunk/camel-core/src/main/java/org/apache/camel: ./ component/bean/ impl/ model/ model/dataformat/ processor/ processor/resequencer/
Date Thu, 02 Oct 2008 09:44:27 GMT
Author: jstrachan
Date: Thu Oct  2 02:44:26 2008
New Revision: 701059

URL: http://svn.apache.org/viewvc?rev=701059&view=rev
Log:
fixed up javadoc warnings for CAMEL-956

Modified:
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/component/bean/ProxyHelper.java
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultComponent.java
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultHeaderFilterStrategy.java
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorType.java
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/SplitterType.java
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/processor/MulticastProcessor.java
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/processor/resequencer/ResequencerEngine.java

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java?rev=701059&r1=701058&r2=701059&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java (original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java Thu Oct
 2 02:44:26 2008
@@ -16,15 +16,9 @@
  */
 package org.apache.camel;
 
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
-import java.util.concurrent.Callable;
-
 import org.apache.camel.builder.ErrorHandlerBuilder;
 import org.apache.camel.model.RouteType;
 import org.apache.camel.model.dataformat.DataFormatType;
-import org.apache.camel.spi.DataFormat;
 import org.apache.camel.spi.ExchangeConverter;
 import org.apache.camel.spi.Injector;
 import org.apache.camel.spi.InterceptStrategy;
@@ -32,6 +26,11 @@
 import org.apache.camel.spi.LifecycleStrategy;
 import org.apache.camel.spi.Registry;
 
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.Callable;
+
 /**
  * Interface used to represent the context used to configure routes and the
  * policies to use during message exchanges between endpoints.
@@ -295,7 +294,8 @@
 
     /**
      * Gets the data formats that can be referenced in the routes.
-     * @param dataFormats the data formats
-     */     
+     *
+     * @return the data formats available
+     */
     Map<String, DataFormatType> getDataFormats();
 }

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/component/bean/ProxyHelper.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/component/bean/ProxyHelper.java?rev=701059&r1=701058&r2=701059&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/component/bean/ProxyHelper.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/component/bean/ProxyHelper.java
Thu Oct  2 02:44:26 2008
@@ -89,7 +89,7 @@
     /**
      * Returns the class loader of the first interface or throws {@link IllegalArgumentException}
if there are no interfaces specified
      *
-     * @return
+     * @return the class loader
      */
     protected static ClassLoader getClassLoader(Class... interfaces) {
         if (interfaces == null || interfaces.length < 1) {

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultComponent.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultComponent.java?rev=701059&r1=701058&r2=701059&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultComponent.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultComponent.java
Thu Oct  2 02:44:26 2008
@@ -27,6 +27,8 @@
 import org.apache.camel.Endpoint;
 import org.apache.camel.Exchange;
 import org.apache.camel.ResolveEndpointFailedException;
+import org.apache.camel.spi.Injector;
+import org.apache.camel.spi.Registry;
 import org.apache.camel.util.CamelContextHelper;
 import org.apache.camel.util.IntrospectionSupport;
 import org.apache.camel.util.ObjectHelper;

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultHeaderFilterStrategy.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultHeaderFilterStrategy.java?rev=701059&r1=701058&r2=701059&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultHeaderFilterStrategy.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultHeaderFilterStrategy.java
Thu Oct  2 02:44:26 2008
@@ -97,8 +97,6 @@
     /**
      * Sets the "out" direction filter set.  The "out" direction is referred to 
      * copying headers from a Camel message to an external message.
-     * 
-     * @return a set that contains headers names that should be excluded.
      */
     public void setOutFilter(Set<String> value) {
         outFilter = value;
@@ -149,8 +147,6 @@
     /**
      * Sets the "in" direction filter set.  The "in" direction is referred to 
      * copying headers from an external message to a Camel message.
-     * 
-     * @return a set that contains headers names that should be excluded.
      */
     public void setInFilter(Set<String> value) {
         inFilter = value;

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorType.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorType.java?rev=701059&r1=701058&r2=701059&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorType.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorType.java
Thu Oct  2 02:44:26 2008
@@ -1022,7 +1022,8 @@
      * Trace logs the exchange before it goes to the next processing step using
      * the {@link #DEFAULT_TRACE_CATEGORY} logging category.
      * 
-     * @deprecated Please use {@link http://activemq.apache.org/camel/tracer.html} instead.
Will be removed in Camel 2.0.
+     * @deprecated Please use <a href="http://activemq.apache.org/camel/tracer.html>Tracer
Support</a>
+     * instead. Will be removed in Camel 2.0.
      */
     public Type trace() {
         return trace(DEFAULT_TRACE_CATEGORY);
@@ -1034,7 +1035,8 @@
      *
      * @param category the logging category trace messages will sent to.
      * 
-     * @deprecated Please use {@link http://activemq.apache.org/camel/tracer.html} instead.
Will be removed in Camel 2.0.
+     * @deprecated Please use <a href="http://activemq.apache.org/camel/tracer.html>Tracer
Support</a>
+     * instead. Will be removed in Camel 2.0.
      */
     public Type trace(String category) {
         final Log log = LogFactory.getLog(category);

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/SplitterType.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/SplitterType.java?rev=701059&r1=701058&r2=701059&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/SplitterType.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/SplitterType.java
Thu Oct  2 02:44:26 2008
@@ -106,9 +106,9 @@
      * This improves throughput and memory usage, but it has a drawback: 
      * - the sent exchanges will no longer contain the {@link Splitter#SPLIT_SIZE} header
property 
      * 
-     * @return 
+     * @return whether or not streaming should be used
      */
-    public boolean getStreaming() {
+    public boolean isStreaming() {
         return streaming != null ? streaming : false;
     }
 

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java?rev=701059&r1=701058&r2=701059&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java
Thu Oct  2 02:44:26 2008
@@ -23,9 +23,8 @@
 import org.apache.camel.spi.DataFormat;
 
 /**
- * Represents a Flatpack {@link org.apache.camel.spi.DataFormat}.
- *
- * @see <a href="http://activemq.apache.org/camel/flatpack.html">Flatpack documentation</a>.
+ * Represents a <a href="http://activemq.apache.org/camel/flatpack.html">Flatpack</a>
{@link org.apache.camel.spi.DataFormat}.
+ * 
  * @version $Revision$
  */
 @XmlRootElement(name = "flatpack")

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java?rev=701059&r1=701058&r2=701059&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java
Thu Oct  2 02:44:26 2008
@@ -23,9 +23,8 @@
 import org.apache.camel.spi.DataFormat;
 
 /**
- * Represents a HL7 {@link org.apache.camel.spi.DataFormat}.
+ * Represents a <a href="http://activemq.apache.org/camel/hl7.html">HL7</a> {@link
org.apache.camel.spi.DataFormat}.
  *
- * @see <a href="http://activemq.apache.org/camel/hl7.html">HL7 documentation</a>.
  * @version $Revision$
  */
 @XmlRootElement(name = "hl7")

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/processor/MulticastProcessor.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/processor/MulticastProcessor.java?rev=701059&r1=701058&r2=701059&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/processor/MulticastProcessor.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/processor/MulticastProcessor.java
Thu Oct  2 02:44:26 2008
@@ -198,11 +198,10 @@
     }
 
     /**
-     * Aggregate the {@link Exchange} with the current {@link Result}
-     * @param result the current result 
+     * Aggregate the {@link Exchange} with the current result
+     *
+     * @param result the current result
      * @param exchange the exchange to be added to the result
-     * 
-     * @return the new exchange, consisting of the aggregated information
      */
     protected synchronized void doAggregate(AtomicExchange result, Exchange exchange) {
         if (aggregationStrategy != null) {
@@ -257,7 +256,7 @@
      * <ul>
      * <li>we use {@link Iterable} to ensure we can send messages as soon as the data
becomes available</li>
      * <li>for parallel processing, we start aggregating responses as they get send
back to the processor;
-     * this means the {@link AggregatorStrategy} has to take care of handling out-of-order
arrival of exchanges</li>
+     * this means the {@link org.apache.camel.processor.aggregate.AggregationStrategy} has
to take care of handling out-of-order arrival of exchanges</li>
      * </ul>
      */
     protected boolean isStreaming() {

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/processor/resequencer/ResequencerEngine.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/processor/resequencer/ResequencerEngine.java?rev=701059&r1=701058&r2=701059&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/processor/resequencer/ResequencerEngine.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/processor/resequencer/ResequencerEngine.java
Thu Oct  2 02:44:26 2008
@@ -94,7 +94,6 @@
      * milliseconds.
      *
      * @param comparator a sequence element comparator.
-     * @param capacity the capacity of this resequencer.
      */
     public ResequencerEngine(SequenceElementComparator<E> comparator) {
         this.sequence = createSequence(comparator);
@@ -214,9 +213,9 @@
     /**
      * Delivers all elements which are currently ready to deliver.
      *
-     * @throws exception thrown by {@link SequenceSender#sendElement(Object)}.
+     * @throws Exception thrown by {@link SequenceSender#sendElement(Object)}.
      *
-     * @see #deliverNext();
+     * @see ResequencerEngine#deliverNext() 
      */
     public void deliver() throws Exception {
         while (deliverNext()) {
@@ -233,7 +232,7 @@
      * @return <code>true</code> if the element has been delivered
      *         <code>false</code> otherwise.
      *
-     * @throws exception thrown by {@link SequenceSender#sendElement(Object)}.
+     * @throws Exception thrown by {@link SequenceSender#sendElement(Object)}.
      *
      */
     public boolean deliverNext() throws Exception {



Mime
View raw message