1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.doxia.macro;
20
21 import org.apache.maven.doxia.sink.Sink;
22
23 /**
24 * Base interface of a macro.
25 *
26 * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
27 * @since 1.0
28 */
29 public interface Macro {
30
31 /** The vm line separator */
32 String EOL = System.getProperty("line.separator");
33
34 /**
35 * Execute the current macro using the given MacroRequest,
36 * and emit events into the given sink.
37 *
38 * @param sink The sink to receive the events.
39 * @param request The corresponding MacroRequest.
40 * @throws org.apache.maven.doxia.macro.MacroExecutionException if an error occurred during execution.
41 */
42 void execute(Sink sink, MacroRequest request) throws MacroExecutionException;
43 }