Mercurial > repos > pfrommolt > ngsrich

comparison NGSrich_0.5.5/src/org/jdom/adapters/DOMAdapter.java @ 0:89ad0a9cca52 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author pfrommolt
date Mon, 21 Nov 2011 08:12:19 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:89ad0a9cca52
1 /*--
2
3 $Id: DOMAdapter.java,v 1.22 2007/11/10 05:28:59 jhunter Exp $
4
5 Copyright (C) 2000-2007 Jason Hunter & Brett McLaughlin.
6 All rights reserved.
7
8 Redistribution and use in source and binary forms, with or without
9 modification, are permitted provided that the following conditions
10 are met:
11
12 1. Redistributions of source code must retain the above copyright
13 notice, this list of conditions, and the following disclaimer.
14
15 2. Redistributions in binary form must reproduce the above copyright
16 notice, this list of conditions, and the disclaimer that follows
17 these conditions in the documentation and/or other materials
18 provided with the distribution.
19
20 3. The name "JDOM" must not be used to endorse or promote products
21 derived from this software without prior written permission. For
22 written permission, please contact <request_AT_jdom_DOT_org>.
23
24 4. Products derived from this software may not be called "JDOM", nor
25 may "JDOM" appear in their name, without prior written permission
26 from the JDOM Project Management <request_AT_jdom_DOT_org>.
27
28 In addition, we request (but do not require) that you include in the
29 end-user documentation provided with the redistribution and/or in the
30 software itself an acknowledgement equivalent to the following:
31 "This product includes software developed by the
32 JDOM Project (http://www.jdom.org/)."
33 Alternatively, the acknowledgment may be graphical using the logos
34 available at http://www.jdom.org/images/logos.
35
36 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39 DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
40 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 SUCH DAMAGE.
48
49 This software consists of voluntary contributions made by many
50 individuals on behalf of the JDOM Project and was originally
51 created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
52 Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
53 on the JDOM Project, please see <http://www.jdom.org/>.
54
55 */
56
57 package org.jdom.adapters;
58
59 import java.io.*;
60
61 import org.jdom.*;
62 import org.w3c.dom.Document;
63
64 /**
65 * Defines a standard set of adapter methods for interfacing with a DOM parser
66 * and obtaining a DOM {@link org.w3c.dom.Document org.w3c.dom.Document} object.
67 * Implementing classes map these calls to DOM parser-specific calls, allowing
68 * any third-party parser to be used with JDOM.
69 *
70 * @version $Revision: 1.22 $, $Date: 2007/11/10 05:28:59 $
71 * @author Brett McLaughlin
72 * @author Jason Hunter
73 */
74 public interface DOMAdapter {
75
76 /**
77 * This creates a new <code>Document</code> from a
78 * given filename by letting a DOM parser handle parsing from the file.
79 *
80 * @param filename file to parse.
81 * @param validate <code>boolean</code> to indicate if validation
82 * should occur.
83 * @return <code>Document</code> - instance ready for use.
84 * @throws IOException when I/O error occurs.
85 * @throws JDOMException when errors occur in parsing.
86 */
87 public Document getDocument(File filename, boolean validate)
88 throws IOException, JDOMException;
89
90 /**
91 * This creates a new <code>Document</code> from an
92 * existing <code>InputStream</code> by letting a DOM
93 * parser handle parsing using the supplied stream.
94 *
95 * @param in <code>InputStream</code> to parse.
96 * @param validate <code>boolean</code> to indicate if validation
97 * should occur.
98 * @return <code>Document</code> - instance ready for use.
99 * @throws IOException when I/O error occurs.
100 * @throws JDOMException when errors occur in parsing.
101 */
102 public Document getDocument(InputStream in, boolean validate)
103 throws IOException, JDOMException;
104
105 /**
106 * This creates an empty <code>Document</code> object based
107 * on a specific parser implementation.
108 *
109 * @return <code>Document</code> - created DOM Document.
110 * @throws JDOMException when errors occur.
111 */
112 public Document createDocument() throws JDOMException;
113
114 /**
115 * This creates an empty <code>Document</code> object based
116 * on a specific parser implementation with the given DOCTYPE.
117 *
118 * @param doctype Initial <code>DocType</code> of the document.
119 * @return <code>Document</code> - created DOM Document.
120 * @throws JDOMException when errors occur.
121 */
122 public Document createDocument(DocType doctype) throws JDOMException;
123 }