org.xwiki.rendering.macro
Interface MacroIdFactory

All Known Implementing Classes:

DefaultMacroIdFactory

@ComponentRole
public interface MacroIdFactory

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

Since:

2.0M3

Version:

$Id$

Method Summary

MacroId

createMacroId(java.lang.String macroIdAsString)

Method Detail

createMacroId

MacroId createMacroId(java.lang.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