org.xwiki.rendering.macro.MacroIdFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-rendering-transformation-macro Show documentation

XWiki Rendering - Transformation - Macro

The newest version!

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rendering.macro;

import org.xwiki.component.annotation.Role;
import org.xwiki.rendering.parser.ParseException;

/**
 * Convert a string representing a macro id into a typed {@link MacroId} object.
 *
 * @version $Id: 54348ec86206bbd8a87d5f2f6cf0a1dbe5329dba $
 * @since 2.0M3
 */
@Role
public interface MacroIdFactory
{
    /**
     * @param macroIdAsString the string representing the macro id in the format "id/syntaxtype/syntaxversion".
     *        Example: html/confluence/1.0
     * @return the typed representation of a macro Id
     * @throws ParseException if the passed string has an invalid format
     */
    MacroId createMacroId(String macroIdAsString) throws ParseException;
}