1 package org.apache.maven.doxia.docrenderer; 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 java.io.File; 23 import java.io.IOException; 24 25 /** 26 * Base renderer interface for the <code>document</code> 27 * 28 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a> 29 * @version $Id: DocRenderer.java 1072376 2011-02-19 16:28:01Z hboutemy $ 30 * @deprecated Since 1.1, use {@link DocumentRenderer} instead. 31 */ 32 public interface DocRenderer 33 { 34 /** Plexus lookup. */ 35 String ROLE = DocRenderer.class.getName(); 36 37 /** 38 * Render all files from a site directory to an output directory 39 * 40 * @param siteDirectory the input directory contains files to be generated 41 * @param outputDirectory the output directory where files are generated 42 * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any 43 * @throws java.io.IOException if any 44 */ 45 void render( File siteDirectory, File outputDirectory ) 46 throws DocumentRendererException, IOException; 47 48 /** 49 * Render a document depending a context and a document descriptor 50 * 51 * @param siteDirectory the input directory contains files to be generated 52 * @param outputDirectory the output directory where file are generated 53 * @param documentDescriptor the document descriptor 54 * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any 55 * @throws java.io.IOException if any 56 */ 57 void render( File siteDirectory, File outputDirectory, File documentDescriptor ) 58 throws DocumentRendererException, IOException; 59 60 /** 61 * Get the output extension supported 62 * 63 * @return the ouput extension supported 64 */ 65 String getOutputExtension(); 66 }