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.
28 *
29 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
30 * @version $Id: DocumentRenderer.java 1588724 2014-04-20 08:13:14Z hboutemy $
31 */
32 public interface DocumentRenderer
33 {
34 /**
35 * Render a document.
36 *
37 * @param writer the Writer.
38 * @param renderer the Renderer.
39 * @param siteRenderingContext the SiteRenderingContext.
40 * @throws org.apache.maven.doxia.siterenderer.RendererException if it bombs.
41 * @throws java.io.FileNotFoundException if it bombs.
42 * @throws java.io.UnsupportedEncodingException if it bombs.
43 */
44 void renderDocument( Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext )
45 throws RendererException, FileNotFoundException, UnsupportedEncodingException;
46
47 /**
48 * The name of the output document.
49 *
50 * @return the name of the output document.
51 */
52 String getOutputName();
53
54 /**
55 * Return the RenderingContext of the document.
56 *
57 * @return RenderingContext.
58 */
59 RenderingContext getRenderingContext();
60
61 /**
62 * Whether to always overwrite the document, or only do so when it is changed.
63 *
64 * @return whether to overwrite
65 */
66 boolean isOverwrite();
67 }