    001    // Copyright 2006, 2007, 2009 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
    015    package org.apache.tapestry5.annotations;
    016
    017    import java.lang.annotation.Documented;
    018    import java.lang.annotation.ElementType;
    019    import java.lang.annotation.Retention;
    020    import static java.lang.annotation.RetentionPolicy.RUNTIME;
    021    import java.lang.annotation.Target;
    022
    023    import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
    024    import org.apache.tapestry5.ioc.annotations.UseWith;
    025
    026    /**
    027     * Marker annotation for component methods associated with the terminal phase for the component rendering state machine.
    028     * Methods may optionally take a {@link org.apache.tapestry5.MarkupWriter} annotation. Generally, methods marked with
    029     * this annotation are used to perform post-render cleanup. In addition, a method may return false to return to the
    030     * {@link org.apache.tapestry5.annotations.SetupRender} phase. Returning void or true (the default), is the normal
    031     * course.
    032     */
    033    @Target(ElementType.METHOD)
    034    @Retention(RUNTIME)
    035    @Documented
    036    @UseWith({COMPONENT,MIXIN,PAGE})
    037    public @interface CleanupRender
    038    {
    039
    040    }