001// Licensed under the Apache License, Version 2.0 (the "License");
002// you may not use this file except in compliance with the License.
003// You may obtain a copy of the License at
004//
005// http://www.apache.org/licenses/LICENSE-2.0
006//
007// Unless required by applicable law or agreed to in writing, software
008// distributed under the License is distributed on an "AS IS" BASIS,
009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
010// See the License for the specific language governing permissions and
011// limitations under the License.
012
013package org.apache.tapestry5.annotations;
014
015import org.apache.tapestry5.ioc.annotations.UseWith;
016
017import java.lang.annotation.Documented;
018import java.lang.annotation.Retention;
019import java.lang.annotation.Target;
020
021import static java.lang.annotation.ElementType.METHOD;
022import static java.lang.annotation.RetentionPolicy.RUNTIME;
023import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
024
025/**
026 * Method annotation used for methods that should be invoked when the page is detached at the end of a request, before
027 * it is returned to the page pool for later reuse.
028 * <p/>
029 * PageDetached methods should take no parameters and return void. They must either have this annotation, or be named
030 * "pageDetached".
031 * <p/>
032 * To be clear: methods with this annotation (or name) are still invoked even in Tapestry 5.2, which does away with the
033 * page pool.
034 *
035 * @see PageAttached
036 */
037@Target(METHOD)
038@Retention(RUNTIME)
039@Documented
040@UseWith(
041        {COMPONENT, MIXIN, PAGE})
042public @interface PageDetached
043{
044
045}