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.util.List;
22
23 /**
24 * Document content, that will be merged into a site template.
25 *
26 * @since 1.8
27 */
28 public interface DocumentContent {
29 /**
30 * Get the title of the document.
31 * @return the document title
32 */
33 String getTitle();
34
35 /**
36 * Get the date of the document.
37 * @return the document date
38 */
39 String getDate();
40
41 /**
42 * Get the authors of the document.
43 * @return the document authors
44 */
45 List<String> getAuthors();
46
47 /**
48 * Get the html head of the document.
49 * @return the document html head
50 */
51 String getHead();
52
53 /**
54 * Get the html body of the document.
55 * @return the document body head
56 */
57 String getBody();
58
59 /**
60 * Get the document rendering context.
61 * @return the document rendering context
62 */
63 DocumentRenderingContext getRenderingContext();
64 }