org.xwiki.rendering.parser.Parser Maven / Gradle / Ivy
/*
* 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.parser;
import java.io.Reader;
import org.xwiki.component.annotation.Role;
import org.xwiki.rendering.block.XDOM;
import org.xwiki.rendering.syntax.Syntax;
import org.xwiki.rendering.util.IdGenerator;
/**
* Parse content into a XDOM (a tree of {@link org.xwiki.rendering.block.Block}s).
*
* @version $Id: 21c776303a9241ef012881b3339f3d5cd98ee773 $
* @since 1.5M2
*/
@Role
public interface Parser
{
/**
* @return the syntax the parser is implementing
*/
Syntax getSyntax();
/**
* @param source the content to parse
* @return the tree representation of the content as {@link org.xwiki.rendering.block.Block}s
* @throws ParseException if the source cannot be read or an unexpected error happens during the parsing. Parsers
* should be written to not generate any error as much as possible.
*/
XDOM parse(Reader source) throws ParseException;
/**
* @param source the content to parse
* @param idGenerator the id generator to use for automatically generating ids during parsing
* @return the tree representation of the content as {@link org.xwiki.rendering.block.Block}s
* @throws ParseException if the source cannot be read or an unexpected error happens during the parsing.
* Parsers should be written to not generate any error as much as possible.
* @since 14.2RC1
*/
default XDOM parse(Reader source, IdGenerator idGenerator) throws ParseException
{
return parse(source);
}
}