public interface IDOMMarkupParser
Interface to be implemented by all DOM Markup Parsers.
Default implementation is DOMMarkupParser.
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);
Note that implementations of this interface should be thread-safe, and therefore parsers should be reusable through several parsing operations and any number of concurrent threads.
| 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.
|
Document parse(String document) throws ParseException
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
document - the document to be parsed, as a String.Document object resulting from parsing.ParseException - if the document cannot be parsed.Document parse(char[] document) throws ParseException
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
document - the document to be parsed, as a char[].Document object resulting from parsing.ParseException - if the document cannot be parsed.Document parse(char[] document, int offset, int len) throws ParseException
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
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.Document parse(Reader reader) throws ParseException
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.
reader - a Reader on the document.Document object resulting from parsing.ParseException - if the document cannot be parsed.Document parse(String documentName, String document) throws ParseException
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
documentName - 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.Document parse(String documentName, char[] document) throws ParseException
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
documentName - 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.Document parse(String documentName, char[] document, int offset, int len) throws ParseException
Parse a document and convert it into a DOM tree, using the classes at the org.attoparser.dom package.
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[].Document object resulting from parsing.ParseException - if the document cannot be parsed.Document parse(String documentName, Reader reader) throws ParseException
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.
documentName - 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.