org.apache.wicket.markup.parser
Class XmlPullParser

java.lang.Object
  org.apache.wicket.markup.parser.AbstractMarkupFilter
      org.apache.wicket.markup.parser.XmlPullParser

All Implemented Interfaces:

IMarkupFilter, IXmlPullParser

public final class XmlPullParser
extends AbstractMarkupFilter
implements IXmlPullParser

A fairly shallow markup pull parser which parses a markup string of a given type of markup (for example, html, xml, vxml or wml) into ComponentTag and RawMarkup tokens.

Author:

Jonathan Locke, Juergen Donnerstag

Field Summary

static int	BODY Tag body in between two tags
static int	CDATA
static int	COMMENT
static int	NOT_INITIALIZED next() must be called at least once for the Type to be valid
static int	PROCESSING_INSTRUCTION
static int	SPECIAL_TAG all other tags which look like
static int	TAG

Constructor Summary

XmlPullParser()
Construct.

Method Summary

java.lang.String	getEncoding() Return the encoding applied while reading the markup resource.
java.lang.CharSequence	getInput(int fromPos, int toPos) Wicket dissects the markup into Wicket relevant tags and raw markup, which is not further analyzed by Wicket.
java.lang.CharSequence	getInputFromPositionMarker(int toPos) Wicket dissects the markup into Wicket relevant tags and raw markup, which is not further analyzed by Wicket.
java.lang.String	getXmlDeclaration() Return the XML declaration string, in case if found in the markup.
boolean	next() Gets the next tag from the input string.
MarkupElement	nextTag() Gets the next tag from the input string.
void	parse(java.lang.CharSequence string) Parse the given string.
void	parse(java.io.InputStream in) Reads and parses markup from an input stream, using UTF-8 encoding by default when not specified in XML declaration.
void	parse(java.io.InputStream inputStream, java.lang.String encoding) Reads and parses markup from an input stream
void	setPositionMarker() Set the position marker of the markup at the current position.
void	setPositionMarker(int pos) Set the position marker of the markup
java.lang.String	toString()

Methods inherited from class org.apache.wicket.markup.parser.AbstractMarkupFilter

getParent, nextComponentTag, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.wicket.markup.parser.IMarkupFilter

getParent, setParent

Field Detail

NOT_INITIALIZED

public static final int NOT_INITIALIZED

next() must be called at least once for the Type to be valid

See Also:

Constant Field Values

TAG

public static final int TAG

See Also:

Constant Field Values

BODY

public static final int BODY

Tag body in between two tags

See Also:

Constant Field Values

COMMENT

public static final int COMMENT

See Also:

Constant Field Values

CDATA

public static final int CDATA

See Also:

Constant Field Values

PROCESSING_INSTRUCTION

public static final int PROCESSING_INSTRUCTION

See Also:

Constant Field Values

SPECIAL_TAG

public static final int SPECIAL_TAG

all other tags which look like

See Also:

Constant Field Values

Constructor Detail

XmlPullParser

public XmlPullParser()

Construct.

Method Detail

getEncoding

public java.lang.String getEncoding()

Description copied from interface: IXmlPullParser

Return the encoding applied while reading the markup resource. The encoding is determined by analyzing the <?xml version=".." encoding=".." ?> tag.

Specified by:

getEncoding in interface IXmlPullParser

Returns:

if null, JVM defaults have been used.

See Also:

IXmlPullParser.getEncoding()

getXmlDeclaration

public java.lang.String getXmlDeclaration()

Description copied from interface: IXmlPullParser

Return the XML declaration string, in case if found in the markup.

Specified by:

getXmlDeclaration in interface IXmlPullParser

Returns:

Null, if not found.

See Also:

IXmlPullParser.getXmlDeclaration()

getInputFromPositionMarker

public final java.lang.CharSequence getInputFromPositionMarker(int toPos)

Description copied from interface: IXmlPullParser

Wicket dissects the markup into Wicket relevant tags and raw markup, which is not further analyzed by Wicket. The method getInputFromPositionMarker() is used to access the raw markup.

Specified by:

getInputFromPositionMarker in interface IXmlPullParser

Parameters:

toPos - To position

Returns:

The raw markup in between the position marker and toPos

See Also:

IXmlPullParser.getInputFromPositionMarker(int)

getInput

public final java.lang.CharSequence getInput(int fromPos,
                                             int toPos)

Description copied from interface: IXmlPullParser

Wicket dissects the markup into Wicket relevant tags and raw markup, which is not further analyzed by Wicket. The getInputSubsequence() method is used to access the raw markup.

Specified by:

getInput in interface IXmlPullParser

Parameters:

fromPos - From position

toPos - To position

Returns:

The raw markup in between fromPos and toPos

See Also:

IXmlPullParser.getInput(int, int)

next

public final boolean next()
                   throws java.text.ParseException

Gets the next tag from the input string.

Specified by:

next in interface IXmlPullParser

Returns:

The extracted tag (will always be of type XmlTag).

Throws:

java.text.ParseException

nextTag

public final MarkupElement nextTag()
                            throws java.text.ParseException

Gets the next tag from the input string.

Specified by:

nextTag in interface IMarkupFilter

Returns:

The extracted tag (will always be of type XmlTag).

Throws:

java.text.ParseException

parse

public void parse(java.lang.CharSequence string)
           throws java.io.IOException,
                  ResourceStreamNotFoundException

Parse the given string.

Note: xml character encoding is NOT applied. It is assumed the input provided does have the correct encoding already.

Specified by:

parse in interface IXmlPullParser

Parameters:

string - The input string

Throws:

java.io.IOException - Error while reading the resource

ResourceStreamNotFoundException - Resource not found

parse

public void parse(java.io.InputStream in)
           throws java.io.IOException,
                  ResourceStreamNotFoundException

Reads and parses markup from an input stream, using UTF-8 encoding by default when not specified in XML declaration.

Specified by:

parse in interface IXmlPullParser

Parameters:

in - The input stream to read and parse

Throws:

java.io.IOException

ResourceStreamNotFoundException

parse

public void parse(java.io.InputStream inputStream,
                  java.lang.String encoding)
           throws java.io.IOException,
                  ResourceStreamNotFoundException

Reads and parses markup from an input stream

Specified by:

parse in interface IXmlPullParser

Parameters:

inputStream - The input stream to read and parse

encoding - The default character encoding of the input

Throws:

java.io.IOException

ResourceStreamNotFoundException

setPositionMarker

public final void setPositionMarker()

Description copied from interface: IXmlPullParser

Set the position marker of the markup at the current position.

Specified by:

setPositionMarker in interface IXmlPullParser

See Also:

IXmlPullParser.setPositionMarker()

setPositionMarker

public final void setPositionMarker(int pos)

Description copied from interface: IXmlPullParser

Set the position marker of the markup

Specified by:

setPositionMarker in interface IXmlPullParser

See Also:

IXmlPullParser.setPositionMarker(int)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()