Minor polish, added utility methods for document generation
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/f037c2da Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f037c2da Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f037c2da Branch: refs/heads/master Commit: f037c2da57492eac1819e415752f9d2b6585d5d6 Parents: 1b0337e Author: Dhiraj Bokde <dhira...@yahoo.com> Authored: Fri Jun 13 14:55:54 2014 -0700 Committer: Dhiraj Bokde <dhira...@yahoo.com> Committed: Tue Jun 17 13:51:38 2014 -0700 ---------------------------------------------------------------------- .../apache/camel/util/component/AbstractApiConsumer.java | 4 +++- .../apache/camel/util/component/AbstractApiEndpoint.java | 4 ++-- .../apache/camel/util/component/AbstractApiProducer.java | 1 + .../org/apache/camel/util/component/ApiCollection.java | 10 +++++++++- .../org/apache/camel/util/component/ApiMethodHelper.java | 8 ++++++++ 5 files changed, 23 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/f037c2da/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiConsumer.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiConsumer.java b/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiConsumer.java index 9406f35..1d63339 100644 --- a/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiConsumer.java +++ b/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiConsumer.java @@ -110,6 +110,7 @@ public abstract class AbstractApiConsumer extends ScheduledPollConsumer { * Used to add any custom/hidden method arguments, which MUST be provided in getMethodArguments() override. * @param argNames argument names. */ + @SuppressWarnings("unused") protected void interceptArgumentNames(Set<String> argNames) { // do nothing by default } @@ -172,6 +173,7 @@ public abstract class AbstractApiConsumer extends ScheduledPollConsumer { * Derived classes can do additional result exchange processing, for example, adding custom headers. * @param resultExchange result as a Camel exchange. */ + @SuppressWarnings("unused") protected void doProcessResult(Exchange resultExchange) { // do nothing by default } @@ -190,7 +192,7 @@ public abstract class AbstractApiConsumer extends ScheduledPollConsumer { * Return method arguments to use in doInvokeMethod(). * Derived classes can override it to add custom arguments. * Overriding method MUST first call super.getMethodArguments() to get endpoint properties. - * @return + * @return argument names mapped to argument values */ protected Map<String, Object> getMethodArguments() { Map<String, Object> arguments = new HashMap<String, Object>(); http://git-wip-us.apache.org/repos/asf/camel/blob/f037c2da/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiEndpoint.java b/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiEndpoint.java index 6d09251..4217c4a 100644 --- a/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiEndpoint.java @@ -138,7 +138,7 @@ public abstract class AbstractApiEndpoint extends DefaultEndpoint { /** * Intercept initial endpoint arguments to add custom/hidden arguments for method calls, etc. - * @param arguments + * @param arguments argument names */ @SuppressWarnings("unused") protected void interceptEndpointArguments(Set<String> arguments) { @@ -148,7 +148,7 @@ public abstract class AbstractApiEndpoint extends DefaultEndpoint { /** * Returns endpoint configuration object. * One of the generated *EndpointConfiguration classes that extends component configuration class. - * @return + * @return endpoint configuration object */ public abstract Object getConfiguration(); http://git-wip-us.apache.org/repos/asf/camel/blob/f037c2da/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiProducer.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiProducer.java b/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiProducer.java index 817c63b..a9795f2 100644 --- a/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiProducer.java +++ b/camel-core/src/main/java/org/apache/camel/util/component/AbstractApiProducer.java @@ -134,6 +134,7 @@ public abstract class AbstractApiProducer extends DefaultAsyncProducer { * Do additional result processing, for example, add custom headers, etc. * @param resultExchange API method result as exchange. */ + @SuppressWarnings("unused") protected void doProcessResult(Exchange resultExchange) { // do nothing by default } http://git-wip-us.apache.org/repos/asf/camel/blob/f037c2da/camel-core/src/main/java/org/apache/camel/util/component/ApiCollection.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/component/ApiCollection.java b/camel-core/src/main/java/org/apache/camel/util/component/ApiCollection.java index 3d0fce8..2231ceb 100644 --- a/camel-core/src/main/java/org/apache/camel/util/component/ApiCollection.java +++ b/camel-core/src/main/java/org/apache/camel/util/component/ApiCollection.java @@ -29,7 +29,15 @@ import java.util.Set; public abstract class ApiCollection<T extends Enum & ApiName, C> { protected final Map<T, ApiMethodHelper> apis = new HashMap<T, ApiMethodHelper>(); - protected final Map<Class<? extends ApiMethod>, T> apiMethods = new HashMap<Class<? extends ApiMethod>, T>(); + protected final HashMap<Class<? extends ApiMethod>, T> apiMethods = new HashMap<Class<? extends ApiMethod>, T>(); + + public final Map<T, ApiMethodHelper> getApiHelpers() { + return Collections.unmodifiableMap(apis); + } + + public final Map<Class<? extends ApiMethod>, T> getApiMethods() { + return Collections.unmodifiableMap(apiMethods); + } /** * Returns a {@link ApiMethodHelper} for a particular API. http://git-wip-us.apache.org/repos/asf/camel/blob/f037c2da/camel-core/src/main/java/org/apache/camel/util/component/ApiMethodHelper.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/component/ApiMethodHelper.java b/camel-core/src/main/java/org/apache/camel/util/component/ApiMethodHelper.java index a698c1e..2561adc 100644 --- a/camel-core/src/main/java/org/apache/camel/util/component/ApiMethodHelper.java +++ b/camel-core/src/main/java/org/apache/camel/util/component/ApiMethodHelper.java @@ -273,6 +273,14 @@ public final class ApiMethodHelper<T extends Enum<T> & ApiMethod> { } /** + * Returns alias map. + * @return alias names mapped to method names. + */ + public Map<String, Set<String>> getAliases() { + return Collections.unmodifiableMap(ALIASES); + } + + /** * Get argument types and names used by all methods. * @return map with argument names as keys, and types as values */
