001// Copyright 2010 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014package org.apache.tapestry5.ioc.annotations;
015
016import static java.lang.annotation.ElementType.METHOD;
017import static java.lang.annotation.RetentionPolicy.RUNTIME;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.Retention;
021import java.lang.annotation.Target;
022
023/**
024 * An annotation that may be placed on a advisor method of a module. The annotation may/should be used in combination with
025 * marker annotations to disambiguate the service to advise. This annotation was introduced as an alternative
026 * to the naming convention for advisor methods.
027 *
028 * @since 5.2.2
029 *
030 */
031@Target(METHOD)
032@Retention(RUNTIME)
033@Documented
034public @interface Advise
035{
036    /**
037     * Type of the service to advise.
038     */
039    Class serviceInterface() default Object.class;
040   
041    /**
042     * Id of the advisor.
043     */
044    String id() default "";
045}