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