001// Copyright 2006, 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
015package org.apache.tapestry5.annotations;
016
017import java.lang.annotation.Documented;
018import java.lang.annotation.ElementType;
019import java.lang.annotation.Retention;
020import static java.lang.annotation.RetentionPolicy.RUNTIME;
021import java.lang.annotation.Target;
022import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
023import org.apache.tapestry5.ioc.annotations.UseWith;
024
025/**
026 * Marker annotation for methods that should be executed during the SetupRender phase. Such methods may optionally take
027 * a {@link org.apache.tapestry5.MarkupWriter} parameter, and may return void or boolean. Returning true or void will
028 * advance to the {@link org.apache.tapestry5.annotations.BeginRender} phase. Return false to skip the BeginRender phase
029 * and procede directly to the {@link org.apache.tapestry5.annotations.CleanupRender} phase.
030 */
031@Target(ElementType.METHOD)
032@Retention(RUNTIME)
033@Documented
034@UseWith({COMPONENT,MIXIN,PAGE})
035public @interface SetupRender
036{
037
038}