View Javadoc

1   /*
2    * Copyright 2001-2004 (C) MetaStuff, Ltd. All Rights Reserved.
3    * 
4    * This software is open source. 
5    * See the bottom of this file for the licence.
6    * 
7    * $Id: DocumentType.java,v 1.8 2004/06/25 12:34:46 maartenc Exp $
8    */
9   
10  package org.dom4j;
11  
12  import java.util.List;
13  
14  /*** <p><code>DocumentType</code> defines an XML DOCTYPE declaration.</p>
15    *
16    * @author <a href="mailto:james.strachan@metastuff.com">James Strachan</a>
17    * @version $Revision: 1.8 $
18    */
19  public interface DocumentType extends Node {
20  
21      /*** This method is the equivalent to the {@link #getName} 
22        * method. It is added for clarity.
23        *
24        * @return the root element name for the document type.
25        */
26      public String getElementName();
27      
28      /*** This method is the equivalent to the {@link #setName} 
29        * method. It is added for clarity.
30        */
31      public void setElementName(String elementName);
32  
33      public String getPublicID();
34      public void setPublicID(String publicID);
35  
36      public String getSystemID();
37      public void setSystemID(String systemID);
38  
39      /*** Returns a list of internal DTD declaration objects, 
40        * defined in the {@link org.dom4j.dtd} package 
41         */    
42      public List getInternalDeclarations();
43      
44      /*** Sets the list of internal DTD declaration objects, 
45        * defined in the {@link org.dom4j.dtd} package 
46        */    
47      public void setInternalDeclarations(List declarations);
48  
49      /*** Returns a list of internal DTD declaration objects, 
50        * defined in the {@link org.dom4j.dtd} package 
51         */    
52      public List getExternalDeclarations();
53      
54      /*** Sets the list of internal DTD declaration objects, 
55        * defined in the {@link org.dom4j.dtd} package 
56        */    
57      public void setExternalDeclarations(List declarations);
58  
59  }
60  
61  
62  
63  
64  
65  
66  
67  
68  
69  
70  
71  
72  
73  
74  /*
75   * Redistribution and use of this software and associated documentation
76   * ("Software"), with or without modification, are permitted provided
77   * that the following conditions are met:
78   *
79   * 1. Redistributions of source code must retain copyright
80   *    statements and notices.  Redistributions must also contain a
81   *    copy of this document.
82   *
83   * 2. Redistributions in binary form must reproduce the
84   *    above copyright notice, this list of conditions and the
85   *    following disclaimer in the documentation and/or other
86   *    materials provided with the distribution.
87   *
88   * 3. The name "DOM4J" must not be used to endorse or promote
89   *    products derived from this Software without prior written
90   *    permission of MetaStuff, Ltd.  For written permission,
91   *    please contact dom4j-info@metastuff.com.
92   *
93   * 4. Products derived from this Software may not be called "DOM4J"
94   *    nor may "DOM4J" appear in their names without prior written
95   *    permission of MetaStuff, Ltd. DOM4J is a registered
96   *    trademark of MetaStuff, Ltd.
97   *
98   * 5. Due credit should be given to the DOM4J Project - 
99   *    http://www.dom4j.org
100  *
101  * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS
102  * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
103  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
104  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
105  * METASTUFF, LTD. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
106  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
107  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
108  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
109  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
110  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
111  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
112  * OF THE POSSIBILITY OF SUCH DAMAGE.
113  *
114  * Copyright 2001-2004 (C) MetaStuff, Ltd. All Rights Reserved.
115  *
116  * $Id: DocumentType.java,v 1.8 2004/06/25 12:34:46 maartenc Exp $
117  */