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.sink.Sink;
022
023/**
024 * Base interface of a macro.
025 *
026 * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
027 * @since 1.0
028 */
029public interface Macro {
030
031    /** The vm line separator */
032    String EOL = System.getProperty("line.separator");
033
034    /**
035     * Execute the current macro using the given MacroRequest,
036     * and emit events into the given sink.
037     *
038     * @param sink The sink to receive the events.
039     * @param request The corresponding MacroRequest.
040     * @throws org.apache.maven.doxia.macro.MacroExecutionException if an error occurred during execution.
041     */
042    void execute(Sink sink, MacroRequest request) throws MacroExecutionException;
043}