blackboard.persist.discussionboard
Interface MessageXmlLoader

All Superinterfaces:

Loader

public interface MessageXmlLoader
extends Loader

MessageXmlLoader

Since:

Bb 5.5

Version:

$Revision: #1 $ $Date: 2007/06/27 $

Field Summary

static java.lang.String

TYPE Type used to obtain an instance of the class configured to provide the implementation for this interface.

Method Summary

Message	load(org.w3c.dom.Element rootElement) Generates an Message object given an Element tree whose structure and contents match those generated by MessageXMLPersister .
Message	load(java.io.InputStream is) Generates an Message object given an InputStream which contains XML whose structure and contents match those generated by MessageXMLPerister.

Methods inherited from interface blackboard.persist.Loader

getAppVersion, init

Field Detail

TYPE

static final java.lang.String TYPE

Type used to obtain an instance of the class configured to provide the implementation for this interface. Used when making a call to BbPersistenceManager.getLoader(String)

See Also:

Constant Field Values

Method Detail

load

Message load(org.w3c.dom.Element rootElement)
             throws java.lang.IllegalArgumentException,
                    PersistenceException

Generates an Message object given an Element tree whose structure and contents match those generated by MessageXMLPersister .

Parameters:

rootElement - the root (@link Element} of a valid Message XML tree that should be transformed.

Returns:

an Message whose contents matches those of the Element tree provided.

Throws:

java.lang.IllegalArgumentException - thrown if the provided Element is not the root of a valid Message XML tree.

PersistenceException - thrown if an error occurs in the element reading process.

load

Message load(java.io.InputStream is)
             throws java.lang.IllegalArgumentException,
                    PersistenceException

Generates an Message object given an InputStream which contains XML whose structure and contents match those generated by MessageXMLPerister.

Parameters:

is - the InputStream containg the XML to load the message from

Returns:

an Message whose contents matches those of the XML contained within the provided stream.

Throws:

java.lang.IllegalArgumentException - thrown if the provided stream does not contain a valid Message XML tree.

PersistenceException - thrown if an error occurs in the element reading process.