com.finalist.mmbase.uml
Class MMBaseDocumentationHelper

java.lang.Object
  com.finalist.mmbase.uml.MMBaseDocumentationHelper

public class MMBaseDocumentationHelper
extends java.lang.Object

Helper classes for formatting the UML documentation.

Version:

$Revision: 1.5 $, $Date: 2005/02/02 15:21:08 $

Author:

Rudie Ekkelenkamp - Finalist IT Group

Constructor Summary

MMBaseDocumentationHelper(MMBaseHelper model)
Default constructor.

Method Summary

java.lang.String	getXML(java.lang.String text) Format the passed String as XML using a SAX Transformer.
java.lang.String	getXMLCdata(java.lang.String text) Format the passed String as XML by putting it between a CDATA section.
java.lang.String	getXMLDocumentation(java.lang.String doc) Convert the javadoc text to an XML format usable by MMBase

Methods inherited from class java.lang.Object

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

Constructor Detail

MMBaseDocumentationHelper

public MMBaseDocumentationHelper(MMBaseHelper model)

Default constructor.

Method Detail

getXMLCdata

public java.lang.String getXMLCdata(java.lang.String text)

Format the passed String as XML by putting it between a CDATA section.

Parameters:

text - Text to format as XML

Returns:

String in XML format

getXMLDocumentation

public java.lang.String getXMLDocumentation(java.lang.String doc)

Convert the javadoc text to an XML format usable by MMBase

Parameters:

doc - Input UML documentation

Returns:

String formatted UML documentation as as XML

getXML

public java.lang.String getXML(java.lang.String text)

Format the passed String as XML using a SAX Transformer. Under construction. The XML header is still returned.

Parameters:

text - Text to format as XML

Returns:

String in XML format