← Back to branch summary

~ubuntu-branches/ubuntu/lucid/libjcommon-java/lucid

« back to all changes in this revision

Viewing changes to source/org/jfree/xml/parser/XmlReadHandler.java

  • Committer: Bazaar Package Importer
  • Author(s): Wolfgang Baer
  • Date: 2006-02-09 15:58:13 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20060209155813-fzi9zwh2rzedbllq
Tags: 1.0.0-1
http://bugs.debian.org/328574
* New stable upstream release (closes: #328574)
* Move to main - build with kaffe
* Use cdbs build system - added cdbs build-dependency
* Move package to pkg-java-maintainers for comaintenance, 
  added Christian Bayle and myself as uploaders
* Removed unneeded README.Debian
* Added README.Debian-source how the upstream tarball was cleaned
* Move big documentation in an own -doc package
* Register javadoc api with doc-base
* Standards-Version 3.6.2 (no changes)

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/org/jfree/xml/parser/XmlReadHandler.java
 
1
/* ========================================================================
 
2
 * JCommon : a free general purpose class library for the Java(tm) platform
 
3
 * ========================================================================
 
4
 *
 
5
 * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
 
6
 * 
 
7
 * Project Info:  http://www.jfree.org/jcommon/index.html
 
8
 *
 
9
 * This library is free software; you can redistribute it and/or modify it 
 
10
 * under the terms of the GNU Lesser General Public License as published by 
 
11
 * the Free Software Foundation; either version 2.1 of the License, or 
 
12
 * (at your option) any later version.
 
13
 *
 
14
 * This library is distributed in the hope that it will be useful, but 
 
15
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
 
16
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
 
17
 * License for more details.
 
18
 *
 
19
 * You should have received a copy of the GNU Lesser General Public
 
20
 * License along with this library; if not, write to the Free Software
 
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
 
22
 * USA.  
 
23
 *
 
24
 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
 
25
 * in the United States and other countries.]
 
26
 * 
 
27
 * -------------------
 
28
 * XmlReadHandler.java
 
29
 * -------------------
 
30
 * (C)opyright 2003, 2004, by Thomas Morgner and Contributors.
 
31
 *
 
32
 * Original Author:  Thomas Morgner;
 
33
 * Contributor(s):   David Gilbert (for Object Refinery Limited);
 
34
 *
 
35
 * $Id: XmlReadHandler.java,v 1.3 2005/10/18 13:32:52 mungady Exp $
 
36
 *
 
37
 * Changes (from 25-Nov-2003)
 
38
 * --------------------------
 
39
 * 25-Nov-2003 : Added Javadocs (DG);
 
40
 *  
 
41
 */
 
42
 
 
43
package org.jfree.xml.parser;
 
44
 
 
45
import org.xml.sax.Attributes;
 
46
import org.xml.sax.SAXException;
 
47
 
 
48
/**
 
49
 * A handler for reading an XML element.
 
50
 */
 
51
public interface XmlReadHandler {
 
52
    
 
53
    /**
 
54
     * This method is called at the start of an element.
 
55
     * 
 
56
     * @param tagName  the tag name.
 
57
     * @param attrs  the attributes.
 
58
     * 
 
59
     * @throws SAXException if there is a parsing error.
 
60
     * @throws XmlReaderException if there is a reader error.
 
61
     */
 
62
    public void startElement(String tagName, Attributes attrs)
 
63
        throws SAXException, XmlReaderException;
 
64
    
 
65
    /**
 
66
     * This method is called to process the character data between element tags.
 
67
     * 
 
68
     * @param ch  the character buffer.
 
69
     * @param start  the start index.
 
70
     * @param length  the length.
 
71
     * 
 
72
     * @throws SAXException if there is a parsing error.
 
73
     */
 
74
    public void characters(char[] ch, int start, int length)
 
75
        throws SAXException;
 
76
    
 
77
    /**
 
78
     * This method is called at the end of an element.
 
79
     * 
 
80
     * @param tagName  the tag name.
 
81
     * 
 
82
     * @throws SAXException if there is a parsing error.
 
83
     * @throws XmlReaderException if there is a reader error.
 
84
     */
 
85
    public void endElement(String tagName)
 
86
        throws SAXException, XmlReaderException;
 
87
    
 
88
    /**
 
89
     * Returns the object for this element or null, if this element does
 
90
     * not create an object.
 
91
     * 
 
92
     * @return the object.
 
93
     * 
 
94
     * @throws XmlReaderException if there is a parsing error.
 
95
     */
 
96
    public Object getObject() throws XmlReaderException;
 
97
    
 
98
    /**
 
99
     * Initialise.
 
100
     * 
 
101
     * @param rootHandler  the root handler.
 
102
     * @param tagName  the tag name.
 
103
     */
 
104
    public void init(RootXmlReadHandler rootHandler, String tagName);
 
105
 
 
106
}