IterationCallback.java

/*
 * Copyright 2004-2015 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.extension.jdbc;

/**
 * 問い合わせ結果を一件ずつ反復するためのインターフェースです。
 * 
 * @author koichik
 * @param <ENTITY>
 *            反復するエンティティまたはDTOの型
 * @param <RESULT>
 *            戻り値の型
 */
public interface IterationCallback<ENTITY, RESULT> {

    /**
     * 問い合わせ結果に含まれるエンティティ(またはDTO)一件ごとに通知されます。
     * 
     * @param entity
     *            エンティティ(またはDTO)
     * @param context
     *            反復コンテキスト
     * @return 結果
     */
    RESULT iterate(ENTITY entity, IterationContext context);

}