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 */
019package org.apache.maven.doxia.macro;
020
021import org.apache.maven.doxia.macro.manager.MacroNotFoundException;
022import org.apache.maven.doxia.parser.Parser;
023import org.apache.maven.doxia.sink.Sink;
024
025/**
026 * Interface implemented by all parsers that support macros and which can be used to overwrite macro execution via {@link Parser#setMacroExecutor(MacroExecutor)}.
027 */
028public interface MacroExecutor {
029
030    /**
031     * Execute a macro on the given sink.
032     *
033     * @param macroId an id to lookup the macro
034     * @param request the corresponding MacroRequest
035     * @param sink the sink to receive the events
036     * @throws MacroExecutionException if an error occurred during execution
037     * @throws MacroNotFoundException if the macro could not be found
038     */
039    void executeMacro(String macroId, MacroRequest request, Sink sink)
040            throws MacroExecutionException, MacroNotFoundException;
041}