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

File TestDefinitionParser.java

 

Code metrics

0
0
0
1
55
14
0
-
-
0
-

Classes

Class Line # Actions
TestDefinitionParser 38 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   
21    package org.xwiki.security.authorization.testwikis;
22   
23    import java.io.IOException;
24    import java.net.URISyntaxException;
25   
26    import javax.xml.parsers.ParserConfigurationException;
27   
28    import org.xml.sax.SAXException;
29    import org.xwiki.model.reference.EntityReferenceResolver;
30    import org.xwiki.model.reference.EntityReferenceSerializer;
31   
32    /**
33    * Public interface of the XML parser of test definition.
34    *
35    * @version $Id: 7aad0fa7f4424b89a9f0ae2c872feeb4d4ced4c3 $
36    * @since 5.0M2
37    */
 
38    public interface TestDefinitionParser
39    {
40    /**
41    * Parse a test definition, creating a full representation in memory using test entities.
42    * @param filename the name of the resource file to parse. Passed over to {@code ClassLoader.#getSystemResource();}.
43    * @param resolver a reference resolver that will be used during parsing to convert strings to references.
44    * @param serializer a reference serializer that will be used during parsing to convert references to strings.
45    * @return a complete test definition.
46    * @throws IOException on file access error.
47    * @throws URISyntaxException on badly formed filename.
48    * @throws ParserConfigurationException on badly setup XML parser.
49    * @throws SAXException on badly formatted definition file.
50    */
51    TestDefinition parse(String filename,
52    EntityReferenceResolver<String> resolver,
53    EntityReferenceSerializer<String> serializer)
54    throws IOException, URISyntaxException, ParserConfigurationException, SAXException;
55    }