View Javadoc
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   * Renders a page with Doxia.
28   *
29   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
30   * @version $Id: DoxiaDocumentRenderer.java 1588724 2014-04-20 08:13:14Z hboutemy $
31   */
32  public class DoxiaDocumentRenderer
33      implements DocumentRenderer
34  {
35      private RenderingContext renderingContext;
36  
37      /**
38       * Constructor.
39       *
40       * @param renderingContext the document's RenderingContext to use.
41       */
42      public DoxiaDocumentRenderer( RenderingContext renderingContext )
43      {
44          this.renderingContext = renderingContext;
45      }
46  
47      /** {@inheritDoc} */
48      public void renderDocument( Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext )
49          throws RendererException, FileNotFoundException, UnsupportedEncodingException
50      {
51          renderer.renderDocument( writer, renderingContext, siteRenderingContext );
52      }
53  
54      /** {@inheritDoc} */
55      public String getOutputName()
56      {
57          return renderingContext.getOutputName();
58      }
59  
60      /** {@inheritDoc} */
61      public RenderingContext getRenderingContext()
62      {
63          return renderingContext;
64      }
65  
66      /** {@inheritDoc} */
67      public boolean isOverwrite()
68      {
69          return false;
70      }
71  
72  }