1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.filter.xar.internal.input

File XARXMLReader.java

 

Code metrics

0
0
0
1
47
11
0
-
-
0
-

Classes

Class Line # Actions
XARXMLReader 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.filter.xar.internal.input;
21   
22    import javax.xml.stream.XMLStreamException;
23    import javax.xml.stream.XMLStreamReader;
24   
25    import org.xwiki.component.annotation.Role;
26    import org.xwiki.filter.FilterException;
27    import org.xwiki.filter.xar.input.XARInputProperties;
28   
29    /**
30    * Read XML to create an entity instance.
31    *
32    * @param <E> the type of instance to create
33    * @version $Id: 6da9e79758ddeadfa23f9e7e24b3a83cb1c3ac8b $
34    * @since 6.2M1
35    */
36    @Role
 
37    public interface XARXMLReader<E>
38    {
39    /**
40    * @param xmlReader the XML reader
41    * @param properties the properties
42    * @return the entity created from XML
43    * @throws XMLStreamException when failing to read XML
44    * @throws FilterException when failing to read XML
45    */
46    E read(XMLStreamReader xmlReader, XARInputProperties properties) throws XMLStreamException, FilterException;
47    }