org.codehaus.cargo.documentation

Class ConfluenceContainerDocumentationGenerator

java.lang.Object

org.codehaus.cargo.documentation.ConfluenceContainerDocumentationGenerator

public class ConfluenceContainerDocumentationGenerator
extends 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

Constructors

Constructor and Description
ConfluenceContainerDocumentationGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	computedFQCN(String className)
protected String	findPropertySetFieldName(String propertyValue)
protected String	findPropertySetFieldName(String propertyValue, Class propertySetClass)
protected StringBuffer	generateConfigurationFeaturesText(String containerId)
protected StringBuffer	generateConfigurationPropertiesForConfigurationTypeForContainerType(String typeAsName, org.codehaus.cargo.container.configuration.ConfigurationType type, String containerId, org.codehaus.cargo.container.ContainerType containerType)
protected StringBuffer	generateConfigurationPropertiesText(String containerId)
protected StringBuffer	generateContainerFeaturesText(String containerId)
protected StringBuffer	generateDeployerFeaturesText(String containerId)
String	generateDocumentation(String containerId)
protected StringBuffer	generateExistingConfigurationText(String containerId, org.codehaus.cargo.container.ContainerType type)
protected StringBuffer	generateOtherFeaturesText(String containerId)
protected StringBuffer	generateStandaloneConfigurationText(String containerId, org.codehaus.cargo.container.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 String generateDocumentation(String containerId)
                             throws Exception

Throws:

Exception

generateContainerFeaturesText

protected StringBuffer generateContainerFeaturesText(String containerId)

generateStandaloneConfigurationText

protected StringBuffer generateStandaloneConfigurationText(String containerId,
                                               org.codehaus.cargo.container.ContainerType type)

generateExistingConfigurationText

protected StringBuffer generateExistingConfigurationText(String containerId,
                                             org.codehaus.cargo.container.ContainerType type)

generateConfigurationFeaturesText

protected StringBuffer generateConfigurationFeaturesText(String containerId)

generateDeployerFeaturesText

protected StringBuffer generateDeployerFeaturesText(String containerId)

generateOtherFeaturesText

protected StringBuffer generateOtherFeaturesText(String containerId)

generateConfigurationPropertiesText

protected StringBuffer generateConfigurationPropertiesText(String containerId)
                                                    throws Exception

Throws:

Exception

generateConfigurationPropertiesForConfigurationTypeForContainerType

protected StringBuffer generateConfigurationPropertiesForConfigurationTypeForContainerType(String typeAsName,
                                                                               org.codehaus.cargo.container.configuration.ConfigurationType type,
                                                                               String containerId,
                                                                               org.codehaus.cargo.container.ContainerType containerType)
                                                                                    throws Exception

Throws:

Exception

computedFQCN

protected String computedFQCN(String className)

findPropertySetFieldName

protected String findPropertySetFieldName(String propertyValue)
                                   throws Exception

Throws:

Exception

findPropertySetFieldName

protected String findPropertySetFieldName(String propertyValue,
                              Class propertySetClass)
                                   throws Exception

Throws:

Exception