IterationProcessor.java

/*
 * Copyright 2004-2012 the Seasar Foundation and the Others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.seasar.mayaa.engine.processor;

/**
 * TemplateProcessorの拡張インターフェイス。処理のイテレート機能。
 * @author Masataka Kurihara (Gluegent, Inc.)
 */
public interface IterationProcessor extends TemplateProcessor {

    /**
     * イテレート実行するかどうかを返す。JSPのIterationTagやBodyTagをホスト
     * している場合に利用する。デフォルトではfalseを返す。trueだと、子プロセッサ
     * の実行後にdoAfterChildProcess()メソッドがコンテナより呼び出される。
     * @return イテレート実行する場合、true。普通はfalse。
     */
    boolean isIteration();

    /**
     * イテレート実行する場合、子プロセッサの実行後にコンテナより呼び出される。
     * @return リターンフラグ。EVAL_BODY_AGAINで再イテレート。SKIP_BODYで中止。
     */
    ProcessStatus doAfterChildProcess();

}