org.xwiki.rendering.internal.parser.wikimodel.WikiModelStreamParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-rendering-syntax-wikimodel Show documentation

Bridge WikiModel Model and XWiki Rendering Model

There is a newer version: 16.10.0-rc-1

Show 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.internal.parser.wikimodel;

import org.xwiki.rendering.listener.Listener;
import org.xwiki.rendering.parser.StreamParser;
import org.xwiki.rendering.util.IdGenerator;

/**
 * Adds the ability to create a corresponding XWiki Generator Listener over {@link StreamParser}.
 *
 * @version $Id: 6d2f11080901674afcf951a42aabc898d4f2a896 $
 * @since 2.5RC1
 */
public interface WikiModelStreamParser extends StreamParser
{
    /**
     * @param listener the XWiki listener to which to forward WikiModel events
     * @param idGenerator unique id tool generator
     * @return the XWiki Generator Listener instance corresponding to the parser (they need to be in sync)
     */
    XWikiGeneratorListener createXWikiGeneratorListener(Listener listener, IdGenerator idGenerator);
}