001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.fukurou.xml;
017
018/**
019 * JSP/XMLファイルを読み取って、構築される最上位の OGDocument オブジェクト を処理する フィルタインターフェースです。
020 *
021 * JspSaxParser での copyDirectry されるときに、このフィルターが呼ばれるように設定できます。
022 *
023 * @og.rev 5.1.9.0 (2010/08/01) 新規作成
024 *
025 * @version  5.0
026 * @author   Kazuhiko Hasegawa
027 * @since    JDK6.0,
028 */
029@FunctionalInterface
030public interface JspParserFilter {
031
032        /**
033         * ドキュメントオブジェクト を変換します。
034         *
035         * 引数に null が設定された場合も、正常に処理を行います。(return null とする)
036         * 後続処理を行いたくない場合にも、null を返します。
037         *
038         * @param       doc     処理を行うドキュメントオブジェクト
039         *
040         * @return      処理した結果のドキュメントオブジェクト
041         */
042        OGDocument filter( final OGDocument doc );
043}