org.apache.abdera.util

Class AbstractParser

java.lang.Object

org.apache.abdera.util.AbstractParser

All Implemented Interfaces:

Parser

Direct Known Subclasses:

AbstractNamedParser

public abstract class AbstractParser
extends java.lang.Object
implements Parser

Abstract base implementation of Abdera Parser.

Method Summary

Modifier and Type	Method and Description
Abdera	getAbdera()
ParserOptions	getDefaultParserOptions() Return the default parser options for this Parser.
Factory	getFactory()
<T extends Element> Document<T>	parse(java.io.InputStream in) Parse the input stream using the default character set encoding (UTF-8)
<T extends Element> Document<T>	parse(java.io.InputStream in, ParserOptions options) Parse the input stream using the default character set encoding (UTF-8).
<T extends Element> Document<T>	parse(java.io.InputStream in, java.lang.String base) Parse the input stream using the default character set encoding (UTF-8).
<T extends Element> Document<T>	parse(java.io.InputStream in, java.lang.String base, ParserOptions options) Parse the input stream using using the specified Parse options.
<T extends Element> Document<T>	parse(java.nio.channels.ReadableByteChannel buf) Parse the channel using using the specified Parse options.
<T extends Element> Document<T>	parse(java.nio.channels.ReadableByteChannel buf, ParserOptions options) Parse the channel using using the specified Parse options.
<T extends Element> Document<T>	parse(java.nio.channels.ReadableByteChannel buf, java.lang.String base) Parse the channel using using the specified Parse options.
<T extends Element> Document<T>	parse(java.nio.channels.ReadableByteChannel buf, java.lang.String base, ParserOptions options) Parse the channel using using the specified Parse options.
<T extends Element> Document<T>	parse(java.io.Reader in) Parse the reader using the default Base URI and options
<T extends Element> Document<T>	parse(java.io.Reader in, ParserOptions options) Parse the reader using the specified Base URI
<T extends Element> Document<T>	parse(java.io.Reader in, java.lang.String base) Parse the reader using the specified Base URI
<T extends Element> Document<T>	parse(javax.xml.stream.XMLStreamReader reader) Parse the input stream using the default character set encoding (UTF-8)
void	setAbdera(Abdera abdera)
Parser	setDefaultParserOptions(ParserOptions options) Set the default parser options for this Parser.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.abdera.parser.Parser

parse, parse

Method Detail

getAbdera

public Abdera getAbdera()

setAbdera

public void setAbdera(Abdera abdera)

getFactory

public Factory getFactory()

parse

public <T extends Element> Document<T> parse(java.io.InputStream in)
                                      throws ParseException

Description copied from interface: Parser

Parse the input stream using the default character set encoding (UTF-8)

Specified by:

parse in interface Parser

Parameters:

in - The input stream to parse

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(javax.xml.stream.XMLStreamReader reader)
                                      throws ParseException

Description copied from interface: Parser

Parse the input stream using the default character set encoding (UTF-8)

Specified by:

parse in interface Parser

Parameters:

reader - The XMLStreamReader to use to parse

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(java.io.InputStream in,
                                             java.lang.String base)
                                      throws ParseException

Description copied from interface: Parser

Parse the input stream using the default character set encoding (UTF-8). The specified Base URI is used to resolve relative references contained in the document

Specified by:

parse in interface Parser

Parameters:

in - The input stream to parse

base - The Base URI of the document

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(java.io.InputStream in,
                                             ParserOptions options)
                                      throws ParseException

Description copied from interface: Parser

Parse the input stream using the default character set encoding (UTF-8). The specified Base URI is used to resolve relative references contained in the document

Specified by:

parse in interface Parser

Parameters:

in - The input stream to parse

options - The Parse options

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(java.io.InputStream in,
                                             java.lang.String base,
                                             ParserOptions options)
                                      throws ParseException

Description copied from interface: Parser

Parse the input stream using using the specified Parse options. The parse options can be used to control various aspects of the parsing process such as the character set encoding to use and whether certain elements should be ignored. The specified Base URI is used to resolve relative references contained in the document.

Specified by:

parse in interface Parser

Parameters:

in - The input stream to parse

base - The Base URI of the document

options - The Parse Options

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(java.io.Reader in)
                                      throws ParseException

Description copied from interface: Parser

Parse the reader using the default Base URI and options

Specified by:

parse in interface Parser

Parameters:

in - The Reader to parse

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(java.io.Reader in,
                                             java.lang.String base)
                                      throws ParseException

Description copied from interface: Parser

Parse the reader using the specified Base URI

Specified by:

parse in interface Parser

Parameters:

in - The Reader to parse

base - The Base URI

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(java.io.Reader in,
                                             ParserOptions options)
                                      throws ParseException

Description copied from interface: Parser

Parse the reader using the specified Base URI

Specified by:

parse in interface Parser

Parameters:

in - The Reader to parse

options - The Parse Options

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(java.nio.channels.ReadableByteChannel buf,
                                             ParserOptions options)
                                      throws ParseException

Description copied from interface: Parser

Parse the channel using using the specified Parse options. The parse options can be used to control various aspects of the parsing process such as the character set encoding to use and whether certain elements should be ignored. The specified Base URI is used to resolve relative references contained in the document.

Specified by:

parse in interface Parser

options - The Parse Options

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(java.nio.channels.ReadableByteChannel buf,
                                             java.lang.String base,
                                             ParserOptions options)
                                      throws ParseException

Description copied from interface: Parser

Parse the channel using using the specified Parse options. The parse options can be used to control various aspects of the parsing process such as the character set encoding to use and whether certain elements should be ignored. The specified Base URI is used to resolve relative references contained in the document.

Specified by:

parse in interface Parser

base - The Base URI of the document

options - The Parse Options

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(java.nio.channels.ReadableByteChannel buf,
                                             java.lang.String base)
                                      throws ParseException

Description copied from interface: Parser

Parse the channel using using the specified Parse options. The parse options can be used to control various aspects of the parsing process such as the character set encoding to use and whether certain elements should be ignored. The specified Base URI is used to resolve relative references contained in the document.

Specified by:

parse in interface Parser

base - The Base URI of the document

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

parse

public <T extends Element> Document<T> parse(java.nio.channels.ReadableByteChannel buf)
                                      throws ParseException

Description copied from interface: Parser

Parse the channel using using the specified Parse options. The parse options can be used to control various aspects of the parsing process such as the character set encoding to use and whether certain elements should be ignored. The specified Base URI is used to resolve relative references contained in the document.

Specified by:

parse in interface Parser

Returns:

The parsed Abdera Document

Throws:

ParseException - if the parse failed

getDefaultParserOptions

public ParserOptions getDefaultParserOptions()

Description copied from interface: Parser

Return the default parser options for this Parser. This method returns a copy of the default options. Changes to this instance will not affect the defaults returned by subsequent requests.

Specified by:

getDefaultParserOptions in interface Parser

Returns:

The default ParserOptions

setDefaultParserOptions

public Parser setDefaultParserOptions(ParserOptions options)

Description copied from interface: Parser

Set the default parser options for this Parser. This method copies the specified options.

Specified by:

setDefaultParserOptions in interface Parser

Parameters:

options - The Parser Options to use as the default