001package org.apache.maven.doxia.macro; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import org.apache.maven.doxia.logging.LogEnabled; 023import org.apache.maven.doxia.sink.Sink; 024 025/** 026 * Base interface of a macro. 027 * 028 * @author <a href="mailto:jason@maven.org">Jason van Zyl</a> 029 * @since 1.0 030 */ 031public interface Macro 032 extends LogEnabled 033{ 034 /** The Plexus lookup role. */ 035 String ROLE = Macro.class.getName(); 036 037 /** The vm line separator */ 038 String EOL = System.getProperty( "line.separator" ); 039 040 /** 041 * Execute the current macro using the given MacroRequest, 042 * and emit events into the given sink. 043 * 044 * @param sink The sink to receive the events. 045 * @param request The corresponding MacroRequest. 046 * @throws org.apache.maven.doxia.macro.MacroExecutionException if an error occurred during execution. 047 */ 048 void execute( Sink sink, MacroRequest request ) 049 throws MacroExecutionException; 050}