KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > diagnostics > report > html > HTMLComponent


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */

23 package com.sun.enterprise.diagnostics.report.html;
24
25 import java.io.File JavaDoc;
26 import java.io.IOException JavaDoc;
27 import java.io.Writer JavaDoc;
28 /**
29  * This is the root interface for all HTML components.
30  */

31 public interface HTMLComponent {
32     
33     /**
34      * Return a string representation of this component.
35      * @return A string.
36      */

37     public String JavaDoc toString();
38     
39     
40     /**
41      * Write this HTML component to the specified stream.
42      * @param output An output writer.
43      * @return This component.
44      * @throws IOException An input / output error occurred.
45      */

46     public void write(Writer JavaDoc output) throws IOException JavaDoc;
47     
48     
49     /**
50      * Write this HTML component to the specified file.
51      * @param file A file.
52      * @return This component.
53      * @throws IOException An input / output error occurred.
54      */

55     public void write(File JavaDoc file) throws IOException JavaDoc;
56     
57 }
58
Popular Tags