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