org.xwiki.rendering.parser

Interface ContentParser

@Role
public interface ContentParser

A bridge between platform and rendering from centralising parsing needs.

Since:

6.0M2

Version:

$Id: 7c2a006a90065b59ec77ea8173e6064f6c4c39fe $

Method Summary

Methods

Modifier and Type	Method and Description
org.xwiki.rendering.block.XDOM	parse(String content, org.xwiki.rendering.syntax.Syntax syntax) Parse content.
org.xwiki.rendering.block.XDOM	parse(String content, org.xwiki.rendering.syntax.Syntax syntax, org.xwiki.model.reference.EntityReference source) Parse content, and add source metadata.

Method Detail

parse

org.xwiki.rendering.block.XDOM parse(String content,
                                   org.xwiki.rendering.syntax.Syntax syntax)
                                     throws org.xwiki.rendering.parser.ParseException,
                                            org.xwiki.rendering.internal.parser.MissingParserException

Parse content.

Parameters:

content - the content to parse.

syntax - the syntax in which the content is written.

Returns:

the XDOM corresponding to the parsed content.

Throws:

ParseException - when a parsing error occurs.

org.xwiki.rendering.internal.parser.MissingParserException - when no parser has been found.

parse

org.xwiki.rendering.block.XDOM parse(String content,
                                   org.xwiki.rendering.syntax.Syntax syntax,
                                   org.xwiki.model.reference.EntityReference source)
                                     throws org.xwiki.rendering.parser.ParseException,
                                            org.xwiki.rendering.internal.parser.MissingParserException

Parse content, and add source metadata.

Parameters:

content - the content to parse.

syntax - the syntax in which the content is written.

source - the source entity (mostly a Document Reference) containing the parsed content.

Returns:

the XDOM corresponding to the parsed content with source metadata set to source.

Throws:

ParseException - when a parsing error occurs.

org.xwiki.rendering.internal.parser.MissingParserException - when no parser has been found.