public final class DOMMarkupParser extends Object implements 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.
| Constructor and Description |
|---|
DOMMarkupParser(ParseConfiguration configuration) |
| Modifier and Type | Method and Description |
|---|---|
Document |
parse(char[] document)
Parse a document and convert it into a DOM tree, using the classes at the
org.attoparser.dom package.
|
Document |
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.
|
Document |
parse(Reader reader)
Parse a document and convert it into a DOM tree, using the classes at the
org.attoparser.dom package.
|
Document |
parse(String document)
Parse a document and convert it into a DOM tree, using the classes at the
org.attoparser.dom package.
|
Document |
parse(String documentName,
char[] document)
Parse a document and convert it into a DOM tree, using the classes at the
org.attoparser.dom package.
|
Document |
parse(String documentName,
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.
|
Document |
parse(String documentName,
Reader reader)
Parse a document and convert it into a DOM tree, using the classes at the
org.attoparser.dom package.
|
Document |
parse(String documentName,
String document)
Parse a document and convert it into a DOM tree, using the classes at the
org.attoparser.dom package.
|
public DOMMarkupParser(ParseConfiguration configuration)
public Document parse(String document) throws ParseException
IDOMMarkupParserParse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
parse in interface IDOMMarkupParserdocument - the document to be parsed, as a String.Document object resulting from parsing.ParseException - if the document cannot be parsed.public Document parse(char[] document) throws ParseException
IDOMMarkupParserParse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
parse in interface IDOMMarkupParserdocument - the document to be parsed, as a char[].Document object resulting from parsing.ParseException - if the document cannot be parsed.public Document parse(char[] document, int offset, int len) throws ParseException
IDOMMarkupParserParse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
parse in interface IDOMMarkupParserdocument - 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[].Document object resulting from parsing.ParseException - if the document cannot be parsed.public Document parse(Reader reader) throws ParseException
IDOMMarkupParserParse 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.
parse in interface IDOMMarkupParserreader - a Reader on the document.Document object resulting from parsing.ParseException - if the document cannot be parsed.public Document parse(String documentName, String document) throws ParseException
IDOMMarkupParserParse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
parse in interface IDOMMarkupParserdocumentName - the name of the document to be parsed.document - the document to be parsed, as a String.Document object resulting from parsing.ParseException - if the document cannot be parsed.public Document parse(String documentName, char[] document) throws ParseException
IDOMMarkupParserParse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
parse in interface IDOMMarkupParserdocumentName - the name of the document to be parsed.document - the document to be parsed, as a char[].Document object resulting from parsing.ParseException - if the document cannot be parsed.public Document parse(String documentName, char[] document, int offset, int len) throws ParseException
IDOMMarkupParserParse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
parse in interface IDOMMarkupParserdocumentName - 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[].Document object resulting from parsing.ParseException - if the document cannot be parsed.public Document parse(String documentName, Reader reader) throws ParseException
IDOMMarkupParserParse 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.
parse in interface IDOMMarkupParserdocumentName - the name of the document to be parsed.reader - a Reader on the document.Document object resulting from parsing.ParseException - if the document cannot be parsed.Copyright © 2023 The ATTOPARSER team. All rights reserved.