Repository: camel Updated Branches: refs/heads/master 2f54bbb2d -> 2ad84753e
Polished javadoc. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/2ad84753 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/2ad84753 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/2ad84753 Branch: refs/heads/master Commit: 2ad84753e3e67fdc5e6a01ab66a85c0348f99874 Parents: 2f54bbb Author: Claus Ibsen <davscl...@apache.org> Authored: Sat Dec 3 12:45:25 2016 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Sat Dec 3 12:46:57 2016 +0100 ---------------------------------------------------------------------- .../java/org/apache/camel/CamelContext.java | 68 ++++++++++---------- 1 file changed, 34 insertions(+), 34 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/2ad84753/camel-core/src/main/java/org/apache/camel/CamelContext.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/CamelContext.java b/camel-core/src/main/java/org/apache/camel/CamelContext.java index 8c687b2..dab1471 100644 --- a/camel-core/src/main/java/org/apache/camel/CamelContext.java +++ b/camel-core/src/main/java/org/apache/camel/CamelContext.java @@ -78,10 +78,10 @@ import org.apache.camel.spi.UuidGenerator; import org.apache.camel.util.LoadPropertiesException; /** - * Interface used to represent the context used to configure routes and the + * Interface used to represent the CamelContext used to configure routes and the * policies to use during message exchanges between endpoints. * <p/> - * The context offers the following methods to control the lifecycle: + * The CamelContext offers the following methods to control the lifecycle: * <ul> * <li>{@link #start()} - to start (<b>important:</b> the start method is not blocked, see more details * <a href="http://camel.apache.org/running-camel-standalone-and-have-it-keep-running.html";>here</a>)</li> @@ -140,7 +140,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { void stop() throws Exception; /** - * Gets the name (id) of the this context. + * Gets the name (id) of the this CamelContext. * * @return the name */ @@ -186,14 +186,14 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { String getManagementName(); /** - * Gets the version of the this context. + * Gets the version of the this CamelContext. * * @return the version */ String getVersion(); /** - * Get the status of this context + * Get the status of this CamelContext * * @return the status */ @@ -217,8 +217,8 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { //----------------------------------------------------------------------- /** - * Adds a service to this context, which allows this context to control the lifecycle, ensuring - * the service is stopped when the context stops. + * Adds a service to this CamelContext, which allows this CamelContext to control the lifecycle, ensuring + * the service is stopped when the CamelContext stops. * <p/> * The service will also have {@link CamelContext} injected if its {@link CamelContextAware}. * The service will also be enlisted in JMX for management (if JMX is enabled). @@ -230,15 +230,15 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { void addService(Object object) throws Exception; /** - * Adds a service to this context. + * Adds a service to this CamelContext. * <p/> * The service will also have {@link CamelContext} injected if its {@link CamelContextAware}. * The service will also be enlisted in JMX for management (if JMX is enabled). * The service will be started, if its not already started. * <p/> - * If the option <tt>closeOnShutdown</tt> is <tt>true</tt> then this context will control the lifecycle, ensuring - * the service is stopped when the context stops. - * If the option <tt>closeOnShutdown</tt> is <tt>false</tt> then this context will not stop the service when the context stops. + * If the option <tt>closeOnShutdown</tt> is <tt>true</tt> then this CamelContext will control the lifecycle, ensuring + * the service is stopped when the CamelContext stops. + * If the option <tt>closeOnShutdown</tt> is <tt>false</tt> then this CamelContext will not stop the service when the CamelContext stops. * * @param object the service * @param stopOnShutdown whether to stop the service when this CamelContext shutdown. @@ -247,15 +247,15 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { void addService(Object object, boolean stopOnShutdown) throws Exception; /** - * Adds a service to this context. + * Adds a service to this CamelContext. * <p/> * The service will also have {@link CamelContext} injected if its {@link CamelContextAware}. * The service will also be enlisted in JMX for management (if JMX is enabled). * The service will be started, if its not already started. * <p/> - * If the option <tt>closeOnShutdown</tt> is <tt>true</tt> then this context will control the lifecycle, ensuring - * the service is stopped when the context stops. - * If the option <tt>closeOnShutdown</tt> is <tt>false</tt> then this context will not stop the service when the context stops. + * If the option <tt>closeOnShutdown</tt> is <tt>true</tt> then this CamelContext will control the lifecycle, ensuring + * the service is stopped when the CamelContext stops. + * If the option <tt>closeOnShutdown</tt> is <tt>false</tt> then this CamelContext will not stop the service when the CamelContext stops. * * @param object the service * @param stopOnShutdown whether to stop the service when this CamelContext shutdown. @@ -266,7 +266,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { void addService(Object object, boolean stopOnShutdown, boolean forceStart) throws Exception; /** - * Removes a service from this context. + * Removes a service from this CamelContext. * <p/> * The service is assumed to have been previously added using {@link #addService(Object)} method. * This method will <b>not</b> change the service lifecycle. @@ -278,7 +278,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { boolean removeService(Object object) throws Exception; /** - * Has the given service already been added to this context? + * Has the given service already been added to this CamelContext? * * @param object the service * @return <tt>true</tt> if already added, <tt>false</tt> if not. @@ -286,7 +286,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { boolean hasService(Object object); /** - * Has the given service type already been added to this context? + * Has the given service type already been added to this CamelContext? * * @param type the class type * @return the service instance or <tt>null</tt> if not already added. @@ -300,7 +300,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { * * @param object the service * @param stopOnShutdown whether to stop the service when this CamelContext shutdown. Setting this to <tt>true</tt> will keep a reference to the service in - * this {@link CamelContext} until the context is stopped. So do not use it for short lived services. + * this {@link CamelContext} until the CamelContext is stopped. So do not use it for short lived services. * @throws Exception can be thrown when starting the service, which is only attempted if {@link CamelContext} has already been started when calling this method. */ void deferStartService(Object object, boolean stopOnShutdown) throws Exception; @@ -338,7 +338,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { Component hasComponent(String componentName); /** - * Gets a component from the context by name. + * Gets a component from the CamelContext by name. * <p/> * Notice the returned component will be auto-started. If you do not intend to do that * then use {@link #getComponent(String, boolean, boolean)}. @@ -349,7 +349,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { Component getComponent(String componentName); /** - * Gets a component from the context by name. + * Gets a component from the CamelContext by name. * <p/> * Notice the returned component will be auto-started. If you do not intend to do that * then use {@link #getComponent(String, boolean, boolean)}. @@ -362,7 +362,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { Component getComponent(String name, boolean autoCreateComponents); /** - * Gets a component from the context by name. + * Gets a component from the CamelContext by name. * * @param name the name of the component * @param autoCreateComponents whether or not the component should @@ -373,7 +373,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { Component getComponent(String name, boolean autoCreateComponents, boolean autoStart); /** - * Gets a component from the context by name and specifying the expected type of component. + * Gets a component from the CamelContext by name and specifying the expected type of component. * * @param name the name to lookup * @param componentType the expected type @@ -603,7 +603,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { List<RouteStartupOrder> getRouteStartupOrder(); /** - * Returns the current routes in this context + * Returns the current routes in this CamelContext * * @return the current routes */ @@ -656,7 +656,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { <T extends ManagedRouteMBean> T getManagedRoute(String routeId, Class<T> type); /** - * Gets the managed Camel context client api + * Gets the managed Camel CamelContext client api */ ManagedCamelContextMBean getManagedCamelContext(); @@ -679,7 +679,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { <T extends ProcessorDefinition> T getProcessorDefinition(String id, Class<T> type); /** - * Adds a collection of routes to this context using the given builder + * Adds a collection of routes to this CamelContext using the given builder * to build them. * <p/> * <b>Important:</b> The added routes will <b>only</b> be started, if {@link CamelContext} @@ -690,7 +690,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { * If you use the API from {@link org.apache.camel.CamelContext} or {@link org.apache.camel.model.ModelCamelContext} to add routes, then any * new routes which has a route id that matches an old route, then the old route is replaced by the new route. * - * @param builder the builder which will create the routes and add them to this context + * @param builder the builder which will create the routes and add them to this CamelContext * @throws Exception if the routes could not be created for whatever reason */ void addRoutes(RoutesBuilder builder) throws Exception; @@ -730,7 +730,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { void addRouteDefinition(RouteDefinition routeDefinition) throws Exception; /** - * Removes a collection of route definitions from the context - stopping any previously running + * Removes a collection of route definitions from the CamelContext - stopping any previously running * routes if any of them are actively running * * @param routeDefinitions route(s) definitions to remove @@ -739,7 +739,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { void removeRouteDefinitions(Collection<RouteDefinition> routeDefinitions) throws Exception; /** - * Removes a route definition from the context - stopping any previously running + * Removes a route definition from the CamelContext - stopping any previously running * routes if any of them are actively running * * @param routeDefinition route definition to remove @@ -1015,7 +1015,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { String resolvePropertyPlaceholders(String text) throws Exception; /** - * Returns the configured property placeholder prefix token if and only if the context has + * Returns the configured property placeholder prefix token if and only if the CamelContext has * property placeholder abilities, otherwise returns {@code null}. * * @return the prefix token or {@code null} @@ -1023,7 +1023,7 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { String getPropertyPrefixToken(); /** - * Returns the configured property placeholder suffix token if and only if the context has + * Returns the configured property placeholder suffix token if and only if the CamelContext has * property placeholder abilities, otherwise returns {@code null}. * * @return the suffix token or {@code null} @@ -1482,14 +1482,14 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { void setAsyncProcessorAwaitManager(AsyncProcessorAwaitManager manager); /** - * Gets the the application context class loader which may be helpful for running camel in other containers + * Gets the the application CamelContext class loader which may be helpful for running camel in other containers * - * @return the application context class loader + * @return the application CamelContext class loader */ ClassLoader getApplicationContextClassLoader(); /** - * Sets the application context class loader + * Sets the application CamelContext class loader * * @param classLoader the class loader */
