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