org.xwiki.rendering.macro

Interface MacroIdFactory

@Role
public interface MacroIdFactory

Convert a string representing a macro id into a typed MacroId object.

Since:

2.0M3

Version:

$Id: 54348ec86206bbd8a87d5f2f6cf0a1dbe5329dba $

Method Summary

Modifier and Type	Method and Description
MacroId	createMacroId(String macroIdAsString)

Method Detail

createMacroId

MacroId createMacroId(String macroIdAsString)
               throws ParseException

Parameters:

macroIdAsString - the string representing the macro id in the format "id/syntaxtype/syntaxversion". Example: html/confluence/1.0

Returns:

the typed representation of a macro Id

Throws:

ParseException - if the passed string has an invalid format