01: /*
02: * $Id: ExtendedXMLEvent.java,v 1.1 2004/07/05 23:08:10 cniles Exp $
03: *
04: * Copyright (c) 2004, Christian Niles, unit12.net
05: * All rights reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions are met:
09: *
10: * * Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: *
13: * * Redistributions in binary form must reproduce the above copyright
14: * notice, this list of conditions and the following disclaimer in the
15: * documentation and/or other materials provided with the distribution.
16: *
17: * * Neither the name of Christian Niles, Unit12, nor the names of its
18: * contributors may be used to endorse or promote products derived from
19: * this software without specific prior written permission.
20: *
21: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31: * POSSIBILITY OF SUCH DAMAGE.
32: *
33: */
34: package javanet.staxutils.events;
35:
36: import javax.xml.stream.XMLStreamException;
37: import javax.xml.stream.XMLStreamWriter;
38: import javax.xml.stream.events.XMLEvent;
39:
40: /**
41: * Extended {@link XMLEvent} interface that provides additional functionality.
42: *
43: * @author Christian Niles
44: * @version $Revision: 1.1 $
45: */
46: public interface ExtendedXMLEvent extends XMLEvent {
47:
48: /**
49: * Determines if this event matches another event, irrespective of document
50: * location.
51: *
52: * @param event The event to match against.
53: * @return <code>true</code> if the two events match, <code>false</code>
54: * otherwise.
55: */
56: public boolean matches(XMLEvent event);
57:
58: /**
59: * Writes the event to the provided {@link XMLStreamWriter}.
60: *
61: * @param writer The destination stream.
62: * @throws XMLStreamException If an error occurs writing to the destination
63: * stream.
64: */
65: public void writeEvent(XMLStreamWriter writer)
66: throws XMLStreamException;
67:
68: }
|