1 package org.apache.maven.doxia.siterenderer; 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.FileNotFoundException; 23 import java.io.UnsupportedEncodingException; 24 import java.io.Writer; 25 26 /** 27 * Renderer for a document that has a source file to be parsed by Doxia. 28 * Details about the source file are in {@link RenderingContext}, which is expected to have 29 * a non-null parserId and extension. 30 * 31 * @author <a href="mailto:brett@apache.org">Brett Porter</a> 32 * @version $Id: DoxiaDocumentRenderer.java 1720924 2015-12-19 13:44:56Z hboutemy $ 33 */ 34 public class DoxiaDocumentRenderer 35 implements DocumentRenderer 36 { 37 private RenderingContext renderingContext; 38 39 /** 40 * Constructor. 41 * 42 * @param renderingContext the document's RenderingContext to use. 43 */ 44 public DoxiaDocumentRenderer( RenderingContext renderingContext ) 45 { 46 this.renderingContext = renderingContext; 47 } 48 49 /** {@inheritDoc} */ 50 public void renderDocument( Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext ) 51 throws RendererException, FileNotFoundException, UnsupportedEncodingException 52 { 53 renderer.renderDocument( writer, renderingContext, siteRenderingContext ); 54 } 55 56 /** {@inheritDoc} */ 57 public String getOutputName() 58 { 59 return renderingContext.getOutputName(); 60 } 61 62 /** {@inheritDoc} */ 63 public RenderingContext getRenderingContext() 64 { 65 return renderingContext; 66 } 67 68 /** {@inheritDoc} */ 69 public boolean isOverwrite() 70 { 71 return false; 72 } 73 74 public boolean isExternalReport() 75 { 76 return false; 77 } 78 79 }