KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > dom4j > ElementHandler


1 /*
2  * Copyright 2001-2005 (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
8 package org.dom4j;
9
10 /**
11  * <p>
12  * <code>ElementHandler</code> interface defines a handler of
13  * <code>Element</code> objects. It is used primarily in event based
14  * processing models such as for processing large XML documents as they are
15  * being parsed rather than waiting until the whole document is parsed.
16  * </p>
17  *
18  * @author <a HREF="mailto:james.strachan@metastuff.com">James Strachan </a>
19  * @version $Revision: 1.8 $
20  */
21 public interface ElementHandler {
22     /**
23      * Called by an event based processor when an elements openning tag is
24      * encountered.
25      *
26      * @param elementPath
27      * is the current <code>ElementPath</code> to process
28      */
29     void onStart(ElementPath elementPath);
30
31     /**
32      * Called by an event based processor when an elements closing tag is
33      * encountered.
34      *
35      * @param elementPath
36      * is the current <code>ElementPath</code> to process
37      */
38     void onEnd(ElementPath elementPath);
39 }
40
41 /*
42  * Redistribution and use of this software and associated documentation
43  * ("Software"), with or without modification, are permitted provided that the
44  * following conditions are met:
45  *
46  * 1. Redistributions of source code must retain copyright statements and
47  * notices. Redistributions must also contain a copy of this document.
48  *
49  * 2. Redistributions in binary form must reproduce the above copyright notice,
50  * this list of conditions and the following disclaimer in the documentation
51  * and/or other materials provided with the distribution.
52  *
53  * 3. The name "DOM4J" must not be used to endorse or promote products derived
54  * from this Software without prior written permission of MetaStuff, Ltd. For
55  * written permission, please contact dom4j-info@metastuff.com.
56  *
57  * 4. Products derived from this Software may not be called "DOM4J" nor may
58  * "DOM4J" appear in their names without prior written permission of MetaStuff,
59  * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
60  *
61  * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
62  *
63  * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
64  * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
65  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
66  * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
67  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
68  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
69  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
70  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
71  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
72  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
73  * POSSIBILITY OF SUCH DAMAGE.
74  *
75  * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
76  */
77
Popular Tags