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

File XMLSerializerFactory.java

 

Code metrics

0
0
0
1
62
14
0
-
-
0
-

Classes

Class Line # Actions
XMLSerializerFactory 36 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.xml.serializer;
21   
22    import javax.xml.stream.FactoryConfigurationError;
23    import javax.xml.stream.XMLStreamException;
24    import javax.xml.transform.Result;
25   
26    import org.xwiki.component.annotation.Role;
27    import org.xwiki.filter.xml.XMLConfiguration;
28   
29    /**
30    * Create XML serializers as listeners.
31    *
32    * @version $Id: dc4c1aa0ecc2176de5fcee71a6b695553da15fb3 $
33    * @since 5.2M1
34    */
35    @Role
 
36    public interface XMLSerializerFactory
37    {
38    /**
39    * @param filterInterface the interface of the filter that will receive the events
40    * @param xmlResult the StAX event writer
41    * @param configuration the configuration of the serializer
42    * @return the listener to send events to
43    * @param <T> the type of the event listener
44    * @throws FactoryConfigurationError if no instance of XMLOutputFactory can be found
45    * @throws XMLStreamException if the passed result is not supported
46    */
47    <T> T createSerializer(Class<T> filterInterface, Result xmlResult, XMLConfiguration configuration)
48    throws XMLStreamException, FactoryConfigurationError;
49   
50    /**
51    * @param filterInterfaces the interfaces of the filter that will receive the events
52    * @param xmlResult the StAX event writer
53    * @param configuration the configuration of the serializer
54    * @return the listener to send events to
55    * @param <T> the type of the event listener
56    * @throws FactoryConfigurationError if no instance of XMLOutputFactory can be found
57    * @throws XMLStreamException if the passed result is not supported
58    * @since 5.3M1
59    */
60    <T> T createSerializer(Class<?>[] filterInterfaces, Result xmlResult, XMLConfiguration configuration)
61    throws XMLStreamException, FactoryConfigurationError;
62    }