1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.rendering.converter

File Converter.java

 

Code metrics

0
0
0
1
48
11
0
-
-
0
-

Classes

Class Line # Actions
Converter 35 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.rendering.converter;
21   
22    import java.io.Reader;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.rendering.renderer.printer.WikiPrinter;
26    import org.xwiki.rendering.syntax.Syntax;
27   
28    /**
29    * Convert source content in a given Syntax to another Syntax.
30    *
31    * @version $Id: c6c10c5c751206d0362c1479a620d8dba2281cd4 $
32    * @since 2.0M3
33    */
34    @Role
 
35    public interface Converter
36    {
37    /**
38    * Converts content from a Syntax to another and execute all registered Macro Transformations on the parsed content.
39    *
40    * @param source the content to be converted
41    * @param sourceSyntax the Syntax in which the content is represented
42    * @param targetSyntax the Syntax to which to convert to
43    * @param printer the printer that will receive the result of the conversion
44    * @throws ConversionException in case of a conversion error (invalid Syntax, etc)
45    */
46    void convert(Reader source, Syntax sourceSyntax, Syntax targetSyntax, WikiPrinter printer)
47    throws ConversionException;
48    }