    001// Copyright 2012 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.
    014
    015package org.apache.tapestry5.ioc.annotations;
    016
    017import java.lang.annotation.*;
    018
    019/**
    020 * Describes a method as one that should be operation tracked. Operation tracking is useful when an exception in deeply nested code occurs,
    021 * as it is possible to identify (using human readable descriptions) the path to the code that failed.
    022 *
    023 * @see org.apache.tapestry5.ioc.OperationTracker
    024 * @since 5.4
    025 */
    026@Target(ElementType.METHOD)
    027@Retention(RetentionPolicy.RUNTIME)
    028@Documented
    029@UseWith({AnnotationUseContext.SERVICE, AnnotationUseContext.COMPONENT, AnnotationUseContext.PAGE})
    030public @interface Operation
    031{
    032    /**
    033     * The message to pass to {@link org.apache.tapestry5.ioc.OperationTracker#invoke(String, org.apache.tapestry5.ioc.Invokable)}. If the message contains
    034     * the '%' character, it is interpreted to be a {@linkplain java.util.Formatter format string}, passed the method's parameters.
    035     *
    036     * @see org.apache.tapestry5.ioc.services.OperationAdvisor#createAdvice(String)
    037     */
    038    String value();
    039}