 | Report generated by Clover Code Coverage v3.1.4 Mon Mar 12 2012 18:03:37 CET. |
Clover: Open Source License registered to XWiki. |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PrintRendererFactory | Line # 36 | 0 | - | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| No Tests | |||
| 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.renderer; | |
| 21 | ||
| 22 | import org.xwiki.component.annotation.ComponentRole; | |
| 23 | import org.xwiki.rendering.syntax.Syntax; | |
| 24 | import org.xwiki.rendering.renderer.printer.WikiPrinter; | |
| 25 | ||
| 26 | /** | |
| 27 | * Allows creating {@link Renderer}s of a given type (one factory implementation per Renderer type). | |
| 28 | * We need a factory since we need to pass a {@link WikiPrinter} object to the created Renderer. In addition this | |
| 29 | * factory allows us to be able to return the {@link org.xwiki.rendering.syntax.Syntax} supported by the Renderer without needing to create an | |
| 30 | * instance of it. | |
| 31 | * | |
| 32 | * @version $Id$ | |
| 33 | * @since 1.6M2 | |
| 34 | */ | |
| 35 | @ComponentRole | |
| 36 | public interface PrintRendererFactory | |
| 37 | { | |
| 38 | /** | |
| 39 | * @return the Syntax supported by the Renderer type | |
| 40 | * @since 2.0M3 | |
| 41 | */ | |
| 42 | Syntax getSyntax(); | |
| 43 | ||
| 44 | /** | |
| 45 | * @param printer the printer to use to output renderer data | |
| 46 | * @return a new Renderer instance (stateful) | |
| 47 | * @since 2.0M3 | |
| 48 | */ | |
| 49 | PrintRenderer createRenderer(WikiPrinter printer); | |
| 50 | } | |
|
||||||||||||