KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > schema > model > Documentation


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.xml.schema.model;
21
22 import java.io.IOException JavaDoc;
23 import org.w3c.dom.Element JavaDoc;
24
25 /**
26  * The interface represents human-readable documentation in plain text.
27  * @author Chris Webster
28  */
29 public interface Documentation extends SchemaComponent {
30     
31     public static final String JavaDoc LANGUAGE_PROPERTY = "language";
32     public static final String JavaDoc SOURCE_PROPERTY = "source";
33     public static final String JavaDoc CONTENT_PROPERTY = "content";
34     
35     String JavaDoc getSource();
36     void setSource(String JavaDoc uri);
37     
38     //TODO low priority create enum for languages
39 String JavaDoc getLanguage();
40     void setLanguage(String JavaDoc lang);
41         
42     /**
43      * @return text representation of the documentation element content.
44      */
45     String JavaDoc getContent();
46     
47     /**
48      * Set the documentation element content to a text node with the given
49      * string value.
50      */
51     void setContent(String JavaDoc content);
52     
53     /**
54      * @return XML fragment text of documentation element content.
55      */
56     String JavaDoc getContentFragment();
57     
58     /**
59      * Sets the XML fragment text of documentation element content.
60      * The XML fragment will be parsed and the resulting nodes will
61      * replace the current children of this documentation element.
62      * @param text XML fragment text.
63      * @exception IOException if the fragment text is not well-form.
64      */
65     void setContentFragment(String JavaDoc text) throws IOException JavaDoc;
66     
67     /**
68      * @return a mutable clone of the documentation element itself.
69      */
70     Element getDocumentationElement();
71     
72     /**
73      * Sets the documentation element to the given element.
74      */
75     void setDocumentationElement(Element documentationElement);
76 }
77
Popular Tags