Class DOMMarkupParser
- All Implemented Interfaces:
IDOMMarkupParser
Default implementation of the IDOMMarkupParser
interface.
DOM trees created by this class are made with objects of the classes from the org.attoparser.dom package.
Note that this parser interface is actually a convenience artifact aimed at using
the DOMBuilderMarkupHandler
DOM-conversion handler
more easily.
Sample usage:
// Obtain a java.io.Reader on the document to be parsed
final Reader documentReader = ...;
// Create or obtain the parser instance (note this is not the 'simple' one!)
final IDOMMarkupParser parser = new DOMMarkupParser(ParseConfiguration.htmlConfiguration());
// Parse it and return the Document Object Model
final Document document = parser.parse("Some document", documentReader);
This parser class uses an instance of the MarkupParser
class underneath (configured
with the default values for its buffer pool), and applies to it an instance of the
DOMBuilderMarkupHandler
handler class in order to make it produce a DOM
(Document Object model) tree as a result of parsing.
In fact, using the DOMMarkupParser
class as shown above is completely
equivalent to:
// Obtain a java.io.Reader on the document to be parsed
final Reader documentReader = ...;
// Instance the DOM-builder handler
final DOMBuilderMarkupHandler handler = new DOMBuilderMarkupHandler("Some document");
// Create or obtain the parser instance
final IMarkupParser parser = new MarkupParser(ParseConfiguration.htmlConfiguration());
// Parse the document
parser.parse(documentReader, handler);
// Obtain the parsed Document Object Model
final Document document = handler.getDocument();
This parser class is thread-safe.
- Since:
- 2.0.0
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionparse
(char[] document) Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.parse
(char[] document, int offset, int len) Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
-
Field Details
-
markupParser
-
-
Constructor Details
-
DOMMarkupParser
-
-
Method Details
-
parse
Description copied from interface:IDOMMarkupParser
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
- Specified by:
parse
in interfaceIDOMMarkupParser
- Parameters:
document
- the document to be parsed, as a String.- Returns:
- the
Document
object resulting from parsing. - Throws:
ParseException
- if the document cannot be parsed.
-
parse
Description copied from interface:IDOMMarkupParser
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
- Specified by:
parse
in interfaceIDOMMarkupParser
- Parameters:
document
- the document to be parsed, as a char[].- Returns:
- the
Document
object resulting from parsing. - Throws:
ParseException
- if the document cannot be parsed.
-
parse
Description copied from interface:IDOMMarkupParser
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
- Specified by:
parse
in interfaceIDOMMarkupParser
- Parameters:
document
- the document to be parsed, as a char[].offset
- the offset to be applied on the char[] document to determine the start of the document contents.len
- the length (in chars) of the document stored in the char[].- Returns:
- the
Document
object resulting from parsing. - Throws:
ParseException
- if the document cannot be parsed.
-
parse
Description copied from interface:IDOMMarkupParser
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
Implementations of this interface must close the provided
Reader
object after parsing.- Specified by:
parse
in interfaceIDOMMarkupParser
- Parameters:
reader
- a Reader on the document.- Returns:
- the
Document
object resulting from parsing. - Throws:
ParseException
- if the document cannot be parsed.
-
parse
Description copied from interface:IDOMMarkupParser
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
- Specified by:
parse
in interfaceIDOMMarkupParser
- Parameters:
documentName
- the name of the document to be parsed.document
- the document to be parsed, as a String.- Returns:
- the
Document
object resulting from parsing. - Throws:
ParseException
- if the document cannot be parsed.
-
parse
Description copied from interface:IDOMMarkupParser
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
- Specified by:
parse
in interfaceIDOMMarkupParser
- Parameters:
documentName
- the name of the document to be parsed.document
- the document to be parsed, as a char[].- Returns:
- the
Document
object resulting from parsing. - Throws:
ParseException
- if the document cannot be parsed.
-
parse
public Document parse(String documentName, char[] document, int offset, int len) throws ParseException Description copied from interface:IDOMMarkupParser
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
- Specified by:
parse
in interfaceIDOMMarkupParser
- Parameters:
documentName
- the name of the document to be parsed.document
- the document to be parsed, as a char[].offset
- the offset to be applied on the char[] document to determine the start of the document contents.len
- the length (in chars) of the document stored in the char[].- Returns:
- the
Document
object resulting from parsing. - Throws:
ParseException
- if the document cannot be parsed.
-
parse
Description copied from interface:IDOMMarkupParser
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
Implementations of this interface must close the provided
Reader
object after parsing.- Specified by:
parse
in interfaceIDOMMarkupParser
- Parameters:
documentName
- the name of the document to be parsed.reader
- a Reader on the document.- Returns:
- the
Document
object resulting from parsing. - Throws:
ParseException
- if the document cannot be parsed.
-