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