View Javadoc

1   /*
2    * $Id: SnippetHtmlFile.java 2993 2011-11-24 19:51:48Z andrewinkler $
3    * ============================================================================
4    * Project gluehloch-homepage-core
5    * Copyright (c) 2004-2010 by Andre Winkler. All rights reserved.
6    * ============================================================================
7    *          GNU LESSER GENERAL PUBLIC LICENSE
8    *  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
9    *
10   *  This library is free software; you can redistribute it and/or
11   *  modify it under the terms of the GNU Lesser General Public
12   *  License as published by the Free Software Foundation; either
13   *  version 2.1 of the License, or (at your option) any later version.
14   *
15   *  This library is distributed in the hope that it will be useful,
16   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
17   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18   *  Lesser General Public License for more details.
19   *
20   *  You should have received a copy of the GNU Lesser General Public
21   *  License along with this library; if not, write to the Free Software
22   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23   *
24   */
25  
26  package de.awtools.homegen.directory.snippet;
27  
28  import de.awtools.homegen.directory.GHFile;
29  
30  /**
31   * Schnittstelle für die Verwaltung einer Homepage-Datei. Ein Snippet ist als
32   * XML Datei im Filesystem unter <code>target/www-prep</code> angelegt. Dieses
33   * Snippet entspricht der aus dem ersten Schritt generierten 'quasi' HTML Datei.
34   *
35   * @version $LastChangedRevision: 2993 $ $LastChangedDate: 2011-11-24 20:51:48 +0100 (Thu, 24 Nov 2011) $
36   * @author by Andre Winkler, $LastChangedBy: andrewinkler $
37   *
38   * @since 1.3
39   */
40  public interface SnippetHtmlFile extends GHFile {
41  
42      /**
43       * Liefert ein Array der zu importierenden Stylesheet Dateien.
44       *
45       * @return Die zu importierenden CSS Dateien.
46       */
47      public String[] getCSSFiles();
48  
49      /**
50       * Liefert den Titel.
51       *
52       * @return Der Titel.
53       */
54      public String getTitle();
55  
56      /**
57       * Liefert den Body.
58       *
59       * @param encoding Die Zeichensatzkodierung.
60       * @return Der Body.
61       */
62      public String getBody(String encoding);
63  
64  }