org.xwiki.rendering.macro
Interface MacroIdFactory

@ComponentRole
public interface MacroIdFactory

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

Since:

2.0M3

Version:

$Id: 302731b8efbb0639b37d0320bda2969eca0d3fb8 $

Method Summary

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