RouteAware.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel;

/**
 * An interface to represent an object which wishes to be injected with
 * a {@link Route} such as {@link Consumer} which is the consumer for a route.
 */
public interface RouteAware {

    /**
     * Injects the {@link Route}
     *
     * @param route the route
     */
    void setRoute(Route route);

    /**
     * Gets the {@link Route}
     *
     * @return the route, or <tt>null</tt> if no route has been set.
     */
    Route getRoute();

}