IWikiReferenceParser.java

/*
 * 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.wikimodel;

/**
 * Instances of this type are used to transform references found in wiki
 * documents into corresponding structured objects - {@link WikiReference}.
 *
 * @author kotelnikov
 * @see WikiReference
 */
public interface IWikiReferenceParser
{
    /**
     * Parses the given reference, recognizes individual parts of this reference
     * (link, label, parameters) and returns the corresponding reference object.
     *
     * @param str the reference to parse
     * @return a wiki reference corresponding to the given link
     */
    WikiReference parse(String str);
}