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