 | Report generated by Clover Code Coverage v3.1.4 Mon Mar 12 2012 18:03:37 CET. |
Clover: Open Source License registered to XWiki. |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MacroIdFactory | Line # 32 | 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.macro; | |
| 21 | ||
| 22 | import org.xwiki.component.annotation.ComponentRole; | |
| 23 | import org.xwiki.rendering.parser.ParseException; | |
| 24 | ||
| 25 | /** | |
| 26 | * Convert a string representing a macro id into a typed {@link MacroId} object. | |
| 27 | * | |
| 28 | * @version $Id$ | |
| 29 | * @since 2.0M3 | |
| 30 | */ | |
| 31 | @ComponentRole | |
| 32 | public interface MacroIdFactory | |
| 33 | { | |
| 34 | /** | |
| 35 | * @param macroIdAsString the string representing the macro id in the format "id/syntaxtype/syntaxversion". | |
| 36 | * Example: html/confluence/1.0 | |
| 37 | * @return the typed representation of a macro Id | |
| 38 | * @throws ParseException if the passed string has an invalid format | |
| 39 | */ | |
| 40 | MacroId createMacroId(String macroIdAsString) throws ParseException; | |
| 41 | } | |
|
||||||||||||