Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
XMLParserFactory | 38 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.filter.xml.parser; | |
21 | ||
22 | import javax.xml.stream.XMLEventWriter; | |
23 | import javax.xml.stream.XMLStreamException; | |
24 | import javax.xml.transform.Result; | |
25 | import javax.xml.transform.Source; | |
26 | ||
27 | import org.xml.sax.ContentHandler; | |
28 | import org.xwiki.component.annotation.Role; | |
29 | import org.xwiki.filter.xml.XMLConfiguration; | |
30 | ||
31 | /** | |
32 | * Create XML parsers. | |
33 | * | |
34 | * @version $Id: e68b5a9dfc8fd7c75bcb9b438cce01a22ced6c3f $ | |
35 | * @since 5.2M1 | |
36 | */ | |
37 | @Role | |
38 | public interface XMLParserFactory | |
39 | { | |
40 | /** | |
41 | * @param source the source to read | |
42 | * @param filter the filter to send events to | |
43 | * @param configuration the configuration of the parser | |
44 | * @throws XMLStreamException when failing to create the parser | |
45 | */ | |
46 | void parse(Source source, Object filter, XMLConfiguration configuration) throws XMLStreamException; | |
47 | ||
48 | /** | |
49 | * @param filter the filter to send events to | |
50 | * @param configuration the configuration of the parser | |
51 | * @return the parser as a {@link Result}. | |
52 | */ | |
53 | Result createResult(Object filter, XMLConfiguration configuration); | |
54 | ||
55 | /** | |
56 | * @param filter the filter to send events to | |
57 | * @param configuration the configuration of the parser | |
58 | * @return the parser as a {@link Result}. | |
59 | */ | |
60 | XMLEventWriter createXMLEventWriter(Object filter, XMLConfiguration configuration); | |
61 | ||
62 | /** | |
63 | * @param filter the filter to send events to | |
64 | * @param configuration the configuration of the parser | |
65 | * @return the parser as a {@link ContentHandler} | |
66 | */ | |
67 | ContentHandler createContentHandler(Object filter, XMLConfiguration configuration); | |
68 | } |