org.fujion.page

Class PIParserBase

java.lang.Object

org.fujion.page.PIParserBase

Direct Known Subclasses:

PIParserAttribute, PIParserTagLibrary

public abstract class PIParserBase
extends Object

Abstract base class for implementing a parser for a processing instruction of a given target type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PIParserBase(String target) Creates the PI parser with the specified target name.

Method Summary

Modifier and Type	Method and Description
protected String	getAttribute(ProcessingInstruction pi, String name, boolean required) Extracts an attribute from a processing instruction's data where the data is formatted as a space-delimited list of key-value pairs.
String	getTarget() Returns the processing instruction's target.
abstract void	parse(ProcessingInstruction pi, PageElement element) Parses a processing instruction.

Methods inherited from class java.lang.Object

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

Constructor Detail

PIParserBase

protected PIParserBase(String target)

Creates the PI parser with the specified target name.

Parameters:

target - This is the name of the target of the processing instruction.

Method Detail

getTarget

public String getTarget()

Returns the processing instruction's target.

Returns:

The processing instruction's target.

parse

public abstract void parse(ProcessingInstruction pi,
                           PageElement element)

Parses a processing instruction.

Parameters:

pi - The processing instruction.

element - The enclosing page element.

getAttribute

protected String getAttribute(ProcessingInstruction pi,
                              String name,
                              boolean required)

Extracts an attribute from a processing instruction's data where the data is formatted as a space-delimited list of key-value pairs.

Parameters:

pi - The processing instruction.

name - The attribute's key.

required - If true and the attributes is not found, an exception is throw.

Returns:

The attribute's value. If the attribute is not found, null will be returned unless the required parameter is true, in which case an exception is thrown.