org.idoox.xmlrpc.header
Class HeaderHelper

java.lang.Object
  org.idoox.xmlrpc.header.HeaderHelper

public abstract class HeaderHelper

extends java.lang.Object

This class allows header processor implementation to create headers without need to write its own XML Tokenizer implementation.

It provides functionality to create Tokenizer implementation from the DOM Element, XML contained in InputStream or String, or to create Tokenizer instance with TokenWriter interface

Since:

4.0

Component:

Core

Constructor Summary

HeaderHelper()

Method Summary

abstract Tokenizer	createDOMTokenizer(org.w3c.dom.Element element) Creates new Tokenizer instance from given XML fragment contained in Element instance including the element itself.
abstract Tokenizer	createInputStreamTokenizer(java.io.InputStream xml) Creates new Tokenizer instance from given XML contained in String instance.
abstract Tokenizer	createStringTokenizer(java.lang.String xml) Creates new Tokenizer instance from given XML contained in String instance.
abstract XMLWriterReader	createWriterTokenizer() Creates new Tokenizer instance which also provides TokenWriter interface.
static HeaderHelper	getInstance() Returns instance of the HeaderHelper class.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderHelper

public HeaderHelper()

Method Detail

createStringTokenizer

public abstract Tokenizer createStringTokenizer(java.lang.String xml)

Creates new Tokenizer instance from given XML contained in String instance.

Parameters:

xml - String containing XML to create Tokenizer from.

Returns:

Tokenizer instance

createDOMTokenizer

public abstract Tokenizer createDOMTokenizer(org.w3c.dom.Element element)

Creates new Tokenizer instance from given XML fragment contained in Element instance including the element itself.

Parameters:

element - Element containing XML fragment to create Tokenizer from.

Returns:

Tokenizer instance

createInputStreamTokenizer

public abstract Tokenizer createInputStreamTokenizer(java.io.InputStream xml)

Creates new Tokenizer instance from given XML contained in String instance.

Parameters:

xml - String containing XML to create Tokenizer from.

Returns:

Tokenizer instance

createWriterTokenizer

public abstract XMLWriterReader createWriterTokenizer()

Creates new Tokenizer instance which also provides TokenWriter interface.

The usage scenario is, that header processor uses this method to create new instance of XMLWriterReader class, then fills the instance using TokenWriter interface. Next it uses the returned instance to create new header in the message. The message implementation uses the Tokenizer interface to read content of the header.

Instance of XMLWriterReader class can be also create directly, so this method can be seen as a shorthand to direct creation of this instance

Returns:

new empty instance of XMLWriterReader class

getInstance

public static HeaderHelper getInstance()

Returns instance of the HeaderHelper class.

Returns:

instance of this class