001    /* 
002        Licensed to the Apache Software Foundation (ASF) under one
003        or more contributor license agreements.  See the NOTICE file
004        distributed with this work for additional information
005        regarding copyright ownership.  The ASF licenses this file
006        to you under the Apache License, Version 2.0 (the
007        "License"); you may not use this file except in compliance
008        with the License.  You may obtain a copy of the License at
009    
010           http://www.apache.org/licenses/LICENSE-2.0
011    
012        Unless required by applicable law or agreed to in writing,
013        software distributed under the License is distributed on an
014        "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015        KIND, either express or implied.  See the License for the
016        specific language governing permissions and limitations
017        under the License.  
018     */
019    package org.apache.wiki.api.plugin;
020    
021    import java.util.Map;
022    
023    import org.apache.wiki.WikiContext;
024    import org.apache.wiki.parser.PluginContent;
025    
026    /**
027     *  Implements a Plugin interface for the parser stage.  Please see org.apache.wiki.api.PluginManager
028     *  for further documentation.
029     */
030    public interface ParserStagePlugin
031    {
032        
033        /**
034         *  Method which is executed during parsing.
035         *  
036         *  @param element The JDOM element which has already been connected to the Document.
037         *  @param context WikiContext, as usual.
038         *  @param params  Parsed parameters for the plugin.
039         */
040        void executeParser( PluginContent element, WikiContext context, Map< String, String > params );
041        
042    }