01: // This file is part of KeY - Integrated Deductive Software Design
02: // Copyright (C) 2001-2007 Universitaet Karlsruhe, Germany
03: // Universitaet Koblenz-Landau, Germany
04: // Chalmers University of Technology, Sweden
05: //
06: // The KeY system is protected by the GNU General Public License.
07: // See LICENSE.TXT for details.
08: package de.uka.ilkd.key.util.keydoc.html;
09:
10: import java.io.File;
11:
12: /** Class containing the HTML representation of the .Key files documentation as processed by the KeyToHTMLBuilder and some other usefull information for the Director.
13: It stores the three attributes fileName, shortDescription and the processed html file.
14: */
15: class BoxedFile {
16: private File file;
17: private int firstLength;
18: private int firstOffset;
19: private HTMLFile htmlFile;
20:
21: /** Boxedfile Constructor.
22: * Boxes a HTMLFile
23: * @param fileName The name of the .key file
24: * @param shortDescription Short description of the purpose of the .key file
25: * @param htmlFile The processed .key file
26: */
27: public BoxedFile(File file, int firstLength, int firstOffset,
28: HTMLFile htmlFile) {
29: this .file = file;
30: this .firstLength = firstLength;
31: this .firstOffset = firstOffset;
32: this .htmlFile = htmlFile;
33: }
34:
35: protected File getFile() {
36: return file;
37: }
38:
39: protected int getFirstOffset() {
40: return firstOffset;
41: }
42:
43: protected HTMLFile getHtmlFile() {
44: return htmlFile;
45: }
46:
47: protected int getFirstLength() {
48: return firstLength;
49: }
50: }
|