org.codehaus.cargo.documentation
Class ConfluenceContainerDocumentationGenerator

java.lang.Object
  extended by org.codehaus.cargo.documentation.ConfluenceContainerDocumentationGenerator

public class ConfluenceContainerDocumentationGenerator
extends java.lang.Object

Generate container documentation using Confluence markup language. The generated text is meant to be copied on the Cargo Confluence web site.

Version:
$Id: ConfluenceContainerDocumentationGenerator.java 1233 2006-11-22 09:15:56Z vmassol $

Constructor Summary
ConfluenceContainerDocumentationGenerator()
           
 
Method Summary
protected  java.lang.String computedFQCN(java.lang.String className)
           
protected  java.lang.String findPropertySetFieldName(java.lang.String propertyValue)
           
protected  java.lang.String findPropertySetFieldName(java.lang.String propertyValue, java.lang.Class propertySetClass)
           
protected  java.lang.StringBuffer generateConfigurationFeaturesText(java.lang.String containerId)
           
protected  java.lang.StringBuffer generateConfigurationPropertiesForConfigurationTypeForContainerType(java.lang.String typeAsName, ConfigurationType type, java.lang.String containerId, ContainerType containerType)
           
protected  java.lang.StringBuffer generateConfigurationPropertiesText(java.lang.String containerId)
           
protected  java.lang.StringBuffer generateContainerFeaturesText(java.lang.String containerId)
           
protected  java.lang.StringBuffer generateDeployerFeaturesText(java.lang.String containerId)
           
 java.lang.String generateDocumentation(java.lang.String containerId)
           
protected  java.lang.StringBuffer generateExistingConfigurationText(java.lang.String containerId, ContainerType type)
           
protected  java.lang.StringBuffer generateOtherFeaturesText(java.lang.String containerId)
           
protected  java.lang.StringBuffer generateStandaloneConfigurationText(java.lang.String containerId, ContainerType type)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfluenceContainerDocumentationGenerator

public ConfluenceContainerDocumentationGenerator()
Method Detail

generateDocumentation

public java.lang.String generateDocumentation(java.lang.String containerId)
                                       throws java.lang.Exception
Throws:
java.lang.Exception

generateContainerFeaturesText

protected java.lang.StringBuffer generateContainerFeaturesText(java.lang.String containerId)

generateStandaloneConfigurationText

protected java.lang.StringBuffer generateStandaloneConfigurationText(java.lang.String containerId,
                                                                     ContainerType type)

generateExistingConfigurationText

protected java.lang.StringBuffer generateExistingConfigurationText(java.lang.String containerId,
                                                                   ContainerType type)

generateConfigurationFeaturesText

protected java.lang.StringBuffer generateConfigurationFeaturesText(java.lang.String containerId)

generateDeployerFeaturesText

protected java.lang.StringBuffer generateDeployerFeaturesText(java.lang.String containerId)

generateOtherFeaturesText

protected java.lang.StringBuffer generateOtherFeaturesText(java.lang.String containerId)

generateConfigurationPropertiesText

protected java.lang.StringBuffer generateConfigurationPropertiesText(java.lang.String containerId)
                                                              throws java.lang.Exception
Throws:
java.lang.Exception

generateConfigurationPropertiesForConfigurationTypeForContainerType

protected java.lang.StringBuffer generateConfigurationPropertiesForConfigurationTypeForContainerType(java.lang.String typeAsName,
                                                                                                     ConfigurationType type,
                                                                                                     java.lang.String containerId,
                                                                                                     ContainerType containerType)
                                                                                              throws java.lang.Exception
Throws:
java.lang.Exception

computedFQCN

protected java.lang.String computedFQCN(java.lang.String className)

findPropertySetFieldName

protected java.lang.String findPropertySetFieldName(java.lang.String propertyValue)
                                             throws java.lang.Exception
Throws:
java.lang.Exception

findPropertySetFieldName

protected java.lang.String findPropertySetFieldName(java.lang.String propertyValue,
                                                    java.lang.Class propertySetClass)
                                             throws java.lang.Exception
Throws:
java.lang.Exception


Copyright © 2004-2011 Codehaus. All Rights Reserved.