Polished javadoc
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/f71d4ecb Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f71d4ecb Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f71d4ecb Branch: refs/heads/master Commit: f71d4ecb3d5520b8ed55d77d4ccf80d2a20322e8 Parents: a65a3c3 Author: Claus Ibsen <davscl...@apache.org> Authored: Tue Aug 12 20:59:57 2014 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Tue Aug 12 20:59:57 2014 +0200 ---------------------------------------------------------------------- .../java/org/apache/camel/api/management/ManagedInstance.java | 2 ++ .../org/apache/camel/api/management/ManagedNotification.java | 3 +++ .../org/apache/camel/api/management/ManagedNotifications.java | 3 +++ .../java/org/apache/camel/converter/TimePatternConverter.java | 3 +++ .../main/java/org/apache/camel/converter/jaxp/StaxSource.java | 4 +++- .../java/org/apache/camel/converter/jaxp/XmlErrorListener.java | 3 +++ .../main/java/org/apache/camel/impl/ActiveMQUuidGenerator.java | 2 +- .../org/apache/camel/impl/DefaultExecutorServiceManager.java | 2 ++ .../main/java/org/apache/camel/impl/DefaultMessageHistory.java | 3 +++ .../camel/impl/DefaultScheduledPollConsumerScheduler.java | 3 +++ .../java/org/apache/camel/impl/DefaultTracedRouteNodes.java | 2 ++ .../java/org/apache/camel/impl/DefaultUnitOfWorkFactory.java | 3 +++ .../src/main/java/org/apache/camel/impl/DoCatchRouteNode.java | 2 ++ .../main/java/org/apache/camel/impl/DoFinallyRouteNode.java | 2 ++ .../src/main/java/org/apache/camel/impl/GzipDataFormat.java | 3 +++ .../org/apache/camel/impl/HeaderFilterStrategyComponent.java | 3 +++ .../main/java/org/apache/camel/impl/OnCompletionRouteNode.java | 2 ++ .../main/java/org/apache/camel/impl/OnExceptionRouteNode.java | 4 +++- .../src/main/java/org/apache/camel/main/MainSupport.java | 2 ++ .../camel/management/DefaultManagementObjectStrategy.java | 2 +- .../org/apache/camel/management/NotificationSenderAdapter.java | 3 +++ .../src/main/java/org/apache/camel/processor/AOPProcessor.java | 1 + .../org/apache/camel/processor/ExchangePatternProcessor.java | 3 +++ .../java/org/apache/camel/processor/OnCompletionProcessor.java | 2 ++ .../src/main/java/org/apache/camel/spi/ExceptionHandler.java | 2 +- camel-core/src/main/java/org/apache/camel/spi/Policy.java | 2 +- .../src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java | 3 +++ .../java/org/apache/camel/support/ChildServiceSupport.java | 3 +++ .../org/apache/camel/util/ExpressionToPredicateAdapter.java | 3 +++ .../src/main/java/org/apache/camel/util/MessageDump.java | 6 ++++++ .../org/apache/camel/util/PredicateToExpressionAdapter.java | 3 +++ .../src/main/java/org/apache/camel/util/UnitOfWorkHelper.java | 2 ++ .../main/java/org/apache/camel/view/GraphGeneratorSupport.java | 1 + .../src/main/java/org/apache/camel/view/GraphSupport.java | 1 + .../main/java/org/apache/camel/view/ModelFileGenerator.java | 1 + camel-core/src/main/java/org/apache/camel/view/NodeData.java | 1 + .../src/main/java/org/apache/camel/view/RouteDotGenerator.java | 1 + .../src/main/java/org/apache/camel/view/XmlGraphGenerator.java | 1 + camel-core/src/main/java/org/apache/camel/view/package.html | 1 + 39 files changed, 87 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/api/management/ManagedInstance.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/api/management/ManagedInstance.java b/camel-core/src/main/java/org/apache/camel/api/management/ManagedInstance.java index 2599da9..821741e 100644 --- a/camel-core/src/main/java/org/apache/camel/api/management/ManagedInstance.java +++ b/camel-core/src/main/java/org/apache/camel/api/management/ManagedInstance.java @@ -17,6 +17,8 @@ package org.apache.camel.api.management; /** + * Holds the instance being managed. + * * @version */ public interface ManagedInstance { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/api/management/ManagedNotification.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/api/management/ManagedNotification.java b/camel-core/src/main/java/org/apache/camel/api/management/ManagedNotification.java index 203f465..f4d0a2d 100644 --- a/camel-core/src/main/java/org/apache/camel/api/management/ManagedNotification.java +++ b/camel-core/src/main/java/org/apache/camel/api/management/ManagedNotification.java @@ -23,6 +23,9 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * A class level annotation to define the mbean emits this JMX notification + */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Inherited http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/api/management/ManagedNotifications.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/api/management/ManagedNotifications.java b/camel-core/src/main/java/org/apache/camel/api/management/ManagedNotifications.java index 5d8d3f1..4dd76ab 100644 --- a/camel-core/src/main/java/org/apache/camel/api/management/ManagedNotifications.java +++ b/camel-core/src/main/java/org/apache/camel/api/management/ManagedNotifications.java @@ -23,6 +23,9 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * A class level annotation to define the mbean emits a set of JMX notifications + */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Inherited http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/converter/TimePatternConverter.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/converter/TimePatternConverter.java b/camel-core/src/main/java/org/apache/camel/converter/TimePatternConverter.java index 8a02843..82bc4bd 100644 --- a/camel-core/src/main/java/org/apache/camel/converter/TimePatternConverter.java +++ b/camel-core/src/main/java/org/apache/camel/converter/TimePatternConverter.java @@ -23,6 +23,9 @@ import org.apache.camel.Converter; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * Converter from String syntax to milli seconds. + */ @Converter public final class TimePatternConverter { private static final Logger LOG = LoggerFactory.getLogger(TimePatternConverter.class); http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/converter/jaxp/StaxSource.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/converter/jaxp/StaxSource.java b/camel-core/src/main/java/org/apache/camel/converter/jaxp/StaxSource.java index 27bc0f6..d8d764a 100644 --- a/camel-core/src/main/java/org/apache/camel/converter/jaxp/StaxSource.java +++ b/camel-core/src/main/java/org/apache/camel/converter/jaxp/StaxSource.java @@ -14,7 +14,6 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - package org.apache.camel.converter.jaxp; import javax.xml.stream.XMLStreamConstants; @@ -36,6 +35,9 @@ import org.xml.sax.XMLReader; import org.xml.sax.ext.LexicalHandler; import org.xml.sax.helpers.AttributesImpl; +/** + * A streaming {@link javax.xml.transform.sax.SAXSource} + */ public class StaxSource extends SAXSource implements XMLReader { private XMLStreamReader streamReader; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/converter/jaxp/XmlErrorListener.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/converter/jaxp/XmlErrorListener.java b/camel-core/src/main/java/org/apache/camel/converter/jaxp/XmlErrorListener.java index 140c8b3..4c50d8a 100644 --- a/camel-core/src/main/java/org/apache/camel/converter/jaxp/XmlErrorListener.java +++ b/camel-core/src/main/java/org/apache/camel/converter/jaxp/XmlErrorListener.java @@ -22,6 +22,9 @@ import javax.xml.transform.TransformerException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * A {@link javax.xml.transform.ErrorListener} that logs the errors. + */ public class XmlErrorListener implements ErrorListener { private static final Logger LOG = LoggerFactory.getLogger(XmlErrorListener.class); http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/ActiveMQUuidGenerator.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/ActiveMQUuidGenerator.java b/camel-core/src/main/java/org/apache/camel/impl/ActiveMQUuidGenerator.java index 4ba7849..c75d2d3 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/ActiveMQUuidGenerator.java +++ b/camel-core/src/main/java/org/apache/camel/impl/ActiveMQUuidGenerator.java @@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory; /** * {@link org.apache.camel.spi.UuidGenerator} which is a fast implementation based on - * how <a href="http://activemq.apache.org/>Apache ActiveMQ</a> generates its UUID. + * how <a href="http://activemq.apache.org/";>Apache ActiveMQ</a> generates its UUID. * <p/> * This implementation is not synchronized but it leverages API which may not be accessible * in the cloud (such as Google App Engine). http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/DefaultExecutorServiceManager.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultExecutorServiceManager.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultExecutorServiceManager.java index a673382..b86e091 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultExecutorServiceManager.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultExecutorServiceManager.java @@ -53,6 +53,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** + * Default {@link org.apache.camel.spi.ExecutorServiceManager}. + * * @version */ public class DefaultExecutorServiceManager extends ServiceSupport implements ExecutorServiceManager { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/DefaultMessageHistory.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultMessageHistory.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultMessageHistory.java index b7b1f73..1549ace 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultMessageHistory.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultMessageHistory.java @@ -22,6 +22,9 @@ import org.apache.camel.MessageHistory; import org.apache.camel.NamedNode; import org.apache.camel.util.StopWatch; +/** + * Default {@link org.apache.camel.MessageHistory}. + */ public class DefaultMessageHistory implements MessageHistory { private final String routeId; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/DefaultScheduledPollConsumerScheduler.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultScheduledPollConsumerScheduler.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultScheduledPollConsumerScheduler.java index 13ed058..c132cad 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultScheduledPollConsumerScheduler.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultScheduledPollConsumerScheduler.java @@ -28,6 +28,9 @@ import org.apache.camel.util.ObjectHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * Default {@link org.apache.camel.impl.ScheduledBatchPollingConsumer}. + */ public class DefaultScheduledPollConsumerScheduler extends org.apache.camel.support.ServiceSupport implements ScheduledPollConsumerScheduler { private static final Logger LOG = LoggerFactory.getLogger(DefaultScheduledPollConsumerScheduler.class); http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/DefaultTracedRouteNodes.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultTracedRouteNodes.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultTracedRouteNodes.java index 575a17a..5312b01 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultTracedRouteNodes.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultTracedRouteNodes.java @@ -29,6 +29,8 @@ import org.apache.camel.model.ProcessorDefinition; import org.apache.camel.spi.TracedRouteNodes; /** + * Default {@link org.apache.camel.spi.TracedRouteNodes} + * * @version */ public class DefaultTracedRouteNodes implements TracedRouteNodes { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/DefaultUnitOfWorkFactory.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultUnitOfWorkFactory.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultUnitOfWorkFactory.java index f36b9b4..3679388 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultUnitOfWorkFactory.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultUnitOfWorkFactory.java @@ -20,6 +20,9 @@ import org.apache.camel.Exchange; import org.apache.camel.spi.UnitOfWork; import org.apache.camel.spi.UnitOfWorkFactory; +/** + * Default {@link org.apache.camel.spi.UnitOfWorkFactory} + */ public class DefaultUnitOfWorkFactory implements UnitOfWorkFactory { @Override http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/DoCatchRouteNode.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DoCatchRouteNode.java b/camel-core/src/main/java/org/apache/camel/impl/DoCatchRouteNode.java index 6032545..1de6b80 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DoCatchRouteNode.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DoCatchRouteNode.java @@ -22,6 +22,8 @@ import org.apache.camel.RouteNode; import org.apache.camel.model.ProcessorDefinition; /** + * {@link org.apache.camel.RouteNode} representing do catch. + * * @version */ public class DoCatchRouteNode implements RouteNode { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/DoFinallyRouteNode.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DoFinallyRouteNode.java b/camel-core/src/main/java/org/apache/camel/impl/DoFinallyRouteNode.java index cc9f978..d1cad28 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DoFinallyRouteNode.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DoFinallyRouteNode.java @@ -22,6 +22,8 @@ import org.apache.camel.RouteNode; import org.apache.camel.model.ProcessorDefinition; /** + * {@link org.apache.camel.RouteNode} representing do finally. + * * @version */ public class DoFinallyRouteNode implements RouteNode { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/GzipDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/GzipDataFormat.java b/camel-core/src/main/java/org/apache/camel/impl/GzipDataFormat.java index 29ecb8b..236bd91 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/GzipDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/impl/GzipDataFormat.java @@ -26,6 +26,9 @@ import org.apache.camel.Exchange; import org.apache.camel.spi.DataFormat; import org.apache.camel.util.IOHelper; +/** + * GZip {@link org.apache.camel.spi.DataFormat} for reading/writing data using gzip. + */ public class GzipDataFormat implements DataFormat { public void marshal(Exchange exchange, Object graph, OutputStream stream) throws Exception { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/HeaderFilterStrategyComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/HeaderFilterStrategyComponent.java b/camel-core/src/main/java/org/apache/camel/impl/HeaderFilterStrategyComponent.java index cabfe44..55e53d8 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/HeaderFilterStrategyComponent.java +++ b/camel-core/src/main/java/org/apache/camel/impl/HeaderFilterStrategyComponent.java @@ -21,6 +21,9 @@ import org.apache.camel.Endpoint; import org.apache.camel.spi.HeaderFilterStrategy; import org.apache.camel.spi.HeaderFilterStrategyAware; +/** + * Base class for components to support configuring a {@link org.apache.camel.spi.HeaderFilterStrategy}. + */ public abstract class HeaderFilterStrategyComponent extends UriEndpointComponent implements HeaderFilterStrategyAware { private HeaderFilterStrategy headerFilterStrategy; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/OnCompletionRouteNode.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/OnCompletionRouteNode.java b/camel-core/src/main/java/org/apache/camel/impl/OnCompletionRouteNode.java index a120516..1b24cc9 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/OnCompletionRouteNode.java +++ b/camel-core/src/main/java/org/apache/camel/impl/OnCompletionRouteNode.java @@ -22,6 +22,8 @@ import org.apache.camel.RouteNode; import org.apache.camel.model.ProcessorDefinition; /** + * {@link org.apache.camel.RouteNode} representing onCompletion. + * * @version */ public class OnCompletionRouteNode implements RouteNode { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/impl/OnExceptionRouteNode.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/OnExceptionRouteNode.java b/camel-core/src/main/java/org/apache/camel/impl/OnExceptionRouteNode.java index 04fb1d1..85c058a 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/OnExceptionRouteNode.java +++ b/camel-core/src/main/java/org/apache/camel/impl/OnExceptionRouteNode.java @@ -22,7 +22,9 @@ import org.apache.camel.RouteNode; import org.apache.camel.model.ProcessorDefinition; /** - * @version + * {@link org.apache.camel.RouteNode} representing onException. + * + * @version */ public class OnExceptionRouteNode implements RouteNode { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/main/MainSupport.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/main/MainSupport.java b/camel-core/src/main/java/org/apache/camel/main/MainSupport.java index 381f302..ba9f8ef 100644 --- a/camel-core/src/main/java/org/apache/camel/main/MainSupport.java +++ b/camel-core/src/main/java/org/apache/camel/main/MainSupport.java @@ -45,6 +45,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** + * Base class for main implementations to allow starting up a JVM with Camel embedded. + * * @version */ public abstract class MainSupport extends ServiceSupport { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/management/DefaultManagementObjectStrategy.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/management/DefaultManagementObjectStrategy.java b/camel-core/src/main/java/org/apache/camel/management/DefaultManagementObjectStrategy.java index 08f9c62..e4bff8b 100644 --- a/camel-core/src/main/java/org/apache/camel/management/DefaultManagementObjectStrategy.java +++ b/camel-core/src/main/java/org/apache/camel/management/DefaultManagementObjectStrategy.java @@ -65,7 +65,7 @@ import org.apache.camel.spi.ManagementObjectStrategy; import org.apache.camel.spi.RouteContext; /** - * + * Default {@link org.apache.camel.spi.ManagementObjectStrategy}. */ public class DefaultManagementObjectStrategy implements ManagementObjectStrategy { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/management/NotificationSenderAdapter.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/management/NotificationSenderAdapter.java b/camel-core/src/main/java/org/apache/camel/management/NotificationSenderAdapter.java index 6359601..7547645 100644 --- a/camel-core/src/main/java/org/apache/camel/management/NotificationSenderAdapter.java +++ b/camel-core/src/main/java/org/apache/camel/management/NotificationSenderAdapter.java @@ -21,6 +21,9 @@ import javax.management.modelmbean.ModelMBeanNotificationBroadcaster; import org.apache.camel.api.management.NotificationSender; +/** + * Can be used to broadcast JMX notifications. + */ public final class NotificationSenderAdapter implements NotificationSender { ModelMBeanNotificationBroadcaster broadcaster; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/processor/AOPProcessor.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/processor/AOPProcessor.java b/camel-core/src/main/java/org/apache/camel/processor/AOPProcessor.java index 2ac5ca3..45dff46 100644 --- a/camel-core/src/main/java/org/apache/camel/processor/AOPProcessor.java +++ b/camel-core/src/main/java/org/apache/camel/processor/AOPProcessor.java @@ -23,6 +23,7 @@ import org.apache.camel.Processor; /** * @version */ +@Deprecated public class AOPProcessor extends TryProcessor { public AOPProcessor(Processor tryProcessor, List<Processor> catchClauses, Processor finallyProcessor) { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/processor/ExchangePatternProcessor.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/processor/ExchangePatternProcessor.java b/camel-core/src/main/java/org/apache/camel/processor/ExchangePatternProcessor.java index 8ab40a6..3d151b9 100644 --- a/camel-core/src/main/java/org/apache/camel/processor/ExchangePatternProcessor.java +++ b/camel-core/src/main/java/org/apache/camel/processor/ExchangePatternProcessor.java @@ -23,6 +23,9 @@ import org.apache.camel.ExchangePattern; import org.apache.camel.support.ServiceSupport; import org.apache.camel.util.AsyncProcessorHelper; +/** + * Processor to set {@link org.apache.camel.ExchangePattern} on the {@link org.apache.camel.Exchange}. + */ public class ExchangePatternProcessor extends ServiceSupport implements AsyncProcessor { private ExchangePattern exchangePattern = ExchangePattern.InOnly; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/processor/OnCompletionProcessor.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/processor/OnCompletionProcessor.java b/camel-core/src/main/java/org/apache/camel/processor/OnCompletionProcessor.java index 35b0a52..b3cf250 100644 --- a/camel-core/src/main/java/org/apache/camel/processor/OnCompletionProcessor.java +++ b/camel-core/src/main/java/org/apache/camel/processor/OnCompletionProcessor.java @@ -41,6 +41,8 @@ import org.slf4j.LoggerFactory; import static org.apache.camel.util.ObjectHelper.notNull; /** + * Processor implementing <a href="http://camel.apache.org/oncompletion.html";>onCompletion</a>. + * * @version */ public class OnCompletionProcessor extends ServiceSupport implements AsyncProcessor, Traceable { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/spi/ExceptionHandler.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/spi/ExceptionHandler.java b/camel-core/src/main/java/org/apache/camel/spi/ExceptionHandler.java index 6425e90..284833b 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/ExceptionHandler.java +++ b/camel-core/src/main/java/org/apache/camel/spi/ExceptionHandler.java @@ -19,7 +19,7 @@ package org.apache.camel.spi; import org.apache.camel.Exchange; /** - * A Strategy pattern for handling exceptions; particularly in asynchronous processes such as consumers + * A Strategy pattern for handling exceptions; particularly in asynchronous processes such as consumers. * <p/> * Its important to <b>not</b> throw any exceptions when handling exceptions as they handler * is often invoked in a try .. catch logic already http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/spi/Policy.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/spi/Policy.java b/camel-core/src/main/java/org/apache/camel/spi/Policy.java index 1dddcaf..aa806f6 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/Policy.java +++ b/camel-core/src/main/java/org/apache/camel/spi/Policy.java @@ -20,7 +20,7 @@ import org.apache.camel.Processor; import org.apache.camel.model.ProcessorDefinition; /** - * A strategy capable of applying interceptors to a processor + * A strategy capable of applying interceptors to a processor. * <p/> * Its <b>strongly</b> advised to use an {@link org.apache.camel.AsyncProcessor} as the returned wrapped * {@link Processor} which ensures the policy works well with the asynchronous routing engine. http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java b/camel-core/src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java index a11618c..2ef089a 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java +++ b/camel-core/src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java @@ -18,6 +18,9 @@ package org.apache.camel.spi; import org.apache.camel.Exchange; +/** + * Factory to create {@link org.apache.camel.spi.UnitOfWork}. + */ public interface UnitOfWorkFactory { /** http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/support/ChildServiceSupport.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/support/ChildServiceSupport.java b/camel-core/src/main/java/org/apache/camel/support/ChildServiceSupport.java index f34eb2b..b4861ff 100644 --- a/camel-core/src/main/java/org/apache/camel/support/ChildServiceSupport.java +++ b/camel-core/src/main/java/org/apache/camel/support/ChildServiceSupport.java @@ -21,6 +21,9 @@ import java.util.Set; import org.apache.camel.util.ServiceHelper; +/** + * Base class to control lifecycle for a set of child {@link org.apache.camel.Service}s. + */ public abstract class ChildServiceSupport extends ServiceSupport { private Set<Object> childServices; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/util/ExpressionToPredicateAdapter.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/ExpressionToPredicateAdapter.java b/camel-core/src/main/java/org/apache/camel/util/ExpressionToPredicateAdapter.java index f4de369..b81d665 100644 --- a/camel-core/src/main/java/org/apache/camel/util/ExpressionToPredicateAdapter.java +++ b/camel-core/src/main/java/org/apache/camel/util/ExpressionToPredicateAdapter.java @@ -20,6 +20,9 @@ import org.apache.camel.Exchange; import org.apache.camel.Expression; import org.apache.camel.Predicate; +/** + * To adapt {@link org.apache.camel.Expression} as a {@link Predicate} + */ public final class ExpressionToPredicateAdapter implements Predicate { private final Expression expression; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/util/MessageDump.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/MessageDump.java b/camel-core/src/main/java/org/apache/camel/util/MessageDump.java index 68dea63..a9edffc 100644 --- a/camel-core/src/main/java/org/apache/camel/util/MessageDump.java +++ b/camel-core/src/main/java/org/apache/camel/util/MessageDump.java @@ -34,6 +34,9 @@ import javax.xml.bind.annotation.XmlValue; @XmlAccessorType(XmlAccessType.FIELD) public final class MessageDump { + /** + * A model of a message dump header. + */ @XmlRootElement(name = "header") @XmlAccessorType(XmlAccessType.FIELD) public static class Header { @@ -72,6 +75,9 @@ public final class MessageDump { } } + /** + * A model of a message dump body. + */ @XmlRootElement(name = "body") @XmlAccessorType(XmlAccessType.FIELD) public static class Body { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/util/PredicateToExpressionAdapter.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/PredicateToExpressionAdapter.java b/camel-core/src/main/java/org/apache/camel/util/PredicateToExpressionAdapter.java index 8f76abf..029baaf 100644 --- a/camel-core/src/main/java/org/apache/camel/util/PredicateToExpressionAdapter.java +++ b/camel-core/src/main/java/org/apache/camel/util/PredicateToExpressionAdapter.java @@ -20,6 +20,9 @@ import org.apache.camel.Exchange; import org.apache.camel.Expression; import org.apache.camel.Predicate; +/** + * To adapt {@link Predicate} as an {@link org.apache.camel.Expression} + */ public final class PredicateToExpressionAdapter implements Expression { private final Predicate predicate; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/util/UnitOfWorkHelper.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/UnitOfWorkHelper.java b/camel-core/src/main/java/org/apache/camel/util/UnitOfWorkHelper.java index 0cd6d9f..3893ff0 100644 --- a/camel-core/src/main/java/org/apache/camel/util/UnitOfWorkHelper.java +++ b/camel-core/src/main/java/org/apache/camel/util/UnitOfWorkHelper.java @@ -29,6 +29,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** + * Utility methods for {@link org.apache.camel.spi.UnitOfWork} + * * @version */ public final class UnitOfWorkHelper { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/view/GraphGeneratorSupport.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/view/GraphGeneratorSupport.java b/camel-core/src/main/java/org/apache/camel/view/GraphGeneratorSupport.java index 17169bb..2249148 100644 --- a/camel-core/src/main/java/org/apache/camel/view/GraphGeneratorSupport.java +++ b/camel-core/src/main/java/org/apache/camel/view/GraphGeneratorSupport.java @@ -33,6 +33,7 @@ import org.apache.camel.model.RouteDefinition; /** * @version */ +@Deprecated public abstract class GraphGeneratorSupport extends GraphSupport { protected String dir; protected int clusterCounter; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/view/GraphSupport.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/view/GraphSupport.java b/camel-core/src/main/java/org/apache/camel/view/GraphSupport.java index 5e0cdc0..a097de0 100644 --- a/camel-core/src/main/java/org/apache/camel/view/GraphSupport.java +++ b/camel-core/src/main/java/org/apache/camel/view/GraphSupport.java @@ -38,6 +38,7 @@ import org.slf4j.LoggerFactory; * * @version */ +@Deprecated public class GraphSupport { protected final Logger log = LoggerFactory.getLogger(getClass()); protected final Map<Object, NodeData> nodeMap = new HashMap<Object, NodeData>(); http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/view/ModelFileGenerator.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/view/ModelFileGenerator.java b/camel-core/src/main/java/org/apache/camel/view/ModelFileGenerator.java index 2e82225..25d09de 100644 --- a/camel-core/src/main/java/org/apache/camel/view/ModelFileGenerator.java +++ b/camel-core/src/main/java/org/apache/camel/view/ModelFileGenerator.java @@ -48,6 +48,7 @@ import org.apache.camel.model.RouteDefinition; import org.apache.camel.model.RoutesDefinition; import org.apache.camel.util.ObjectHelper; +@Deprecated public class ModelFileGenerator { private static final String DEFAULT_ROOT_ELEMENT_NAME = "routes"; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/view/NodeData.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/view/NodeData.java b/camel-core/src/main/java/org/apache/camel/view/NodeData.java index 916d37a..88d3cff 100644 --- a/camel-core/src/main/java/org/apache/camel/view/NodeData.java +++ b/camel-core/src/main/java/org/apache/camel/view/NodeData.java @@ -43,6 +43,7 @@ import static org.apache.camel.util.ObjectHelper.isNotEmpty; * * @version */ +@Deprecated public class NodeData { public String id; public String image; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/view/RouteDotGenerator.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/view/RouteDotGenerator.java b/camel-core/src/main/java/org/apache/camel/view/RouteDotGenerator.java index a37b9c4..358f80d 100644 --- a/camel-core/src/main/java/org/apache/camel/view/RouteDotGenerator.java +++ b/camel-core/src/main/java/org/apache/camel/view/RouteDotGenerator.java @@ -32,6 +32,7 @@ import static org.apache.camel.util.ObjectHelper.isNotEmpty; * * @version */ +@Deprecated public class RouteDotGenerator extends GraphGeneratorSupport { public RouteDotGenerator(String dir) { http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/view/XmlGraphGenerator.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/view/XmlGraphGenerator.java b/camel-core/src/main/java/org/apache/camel/view/XmlGraphGenerator.java index d8e7567..7978ef7 100644 --- a/camel-core/src/main/java/org/apache/camel/view/XmlGraphGenerator.java +++ b/camel-core/src/main/java/org/apache/camel/view/XmlGraphGenerator.java @@ -31,6 +31,7 @@ import static org.apache.camel.util.StringHelper.xmlEncode; /** * @version */ +@Deprecated public class XmlGraphGenerator extends GraphGeneratorSupport { private boolean addUrl = true; http://git-wip-us.apache.org/repos/asf/camel/blob/f71d4ecb/camel-core/src/main/java/org/apache/camel/view/package.html ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/view/package.html b/camel-core/src/main/java/org/apache/camel/view/package.html index b548f03..c0236e3 100644 --- a/camel-core/src/main/java/org/apache/camel/view/package.html +++ b/camel-core/src/main/java/org/apache/camel/view/package.html @@ -19,6 +19,7 @@ </head> <body> +<b>Deprecated:</b> Helper class to help with the <a href="http://activemq.apache.org/visualisation.html";>Visualisation</a> of Routes </body>
