001// Copyright 2007, 2009, 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.
014
015package org.apache.tapestry5.annotations;
016
017import org.apache.tapestry5.ioc.annotations.UseWith;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.Retention;
021import java.lang.annotation.Target;
022
023import static java.lang.annotation.ElementType.METHOD;
024import static java.lang.annotation.RetentionPolicy.RUNTIME;
025import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
026
027/**
028 * Method annotation used for methods that should be invoked when the page is detached at the end of a request, before
029 * it is returned to the page pool for later reuse.
030 * <p/>
031 * PageDetached methods should take no parameters and return void. They must either have this annotation, or be named
032 * "pageDetached".
033 * <p/>
034 * To be clear: methods with this annotation (or name) are still invoked even in Tapestry 5.2, which does away with the
035 * page pool.
036 *
037 * @see PageAttached
038 * @deprecated In Tapestry 5.3, with no replacement (detach logic no longer meaningful now that pages are singletons).
039 */
040@Target(METHOD)
041@Retention(RUNTIME)
042@Documented
043@UseWith(
044        {COMPONENT, MIXIN, PAGE})
045public @interface PageDetached
046{
047
048}