1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.xml

File XMLReaderFactory.java

 

Code metrics

0
0
0
1
45
10
0
-
-
0
-

Classes

Class Line # Actions
XMLReaderFactory 37 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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.xml;
21   
22    import javax.xml.parsers.ParserConfigurationException;
23   
24    import org.xml.sax.SAXException;
25    import org.xml.sax.XMLReader;
26    import org.xwiki.component.annotation.Role;
27   
28    /**
29    * Factory to create optimised {@link XMLReader}. This gives us a level of indirection versus using directly
30    * {@link javax.xml.parsers.SAXParserFactory}. We use that for example to verify if we're using Xerces and if so we
31    * configure it to cache parsed DTD grammars for better performance.
32    *
33    * @version $Id: fd630a2eb021c501cddd525d291438799a8f3d01 $
34    * @since 1.7.1
35    */
36    @Role
 
37    public interface XMLReaderFactory
38    {
39    /**
40    * @return the optimised XML Reader instance
41    * @throws SAXException in case of an error in the creation of the XML Reader instance
42    * @throws ParserConfigurationException in case of an error in the creation of the XML Reader instance
43    */
44    XMLReader createXMLReader() throws SAXException, ParserConfigurationException;
45    }