org.codehaus.enunciate.modules.c
Class CDeploymentModule

java.lang.Object
  org.codehaus.enunciate.modules.BasicDeploymentModule
      org.codehaus.enunciate.modules.FreemarkerDeploymentModule
          org.codehaus.enunciate.modules.c.CDeploymentModule

All Implemented Interfaces:

EnunciateModelAware, DeploymentModule

public class CDeploymentModule
extends FreemarkerDeploymentModule

C Module

The C module generates C data structures and (de)serialization functions that can be used in conjunction with libxml2 to (de)serialize the REST resources as they are represented as XML data.

The order of the C deployment module is 0, as it doesn't depend on any artifacts exported by any other module.

• configuration

Configuration

The C module is configured with the "c" element under the "modules" element of the enunciate configuration file. It supports the following attributes:

• The "label" attribute is the label for the C API. This is the name by which the file will be identified (producing [label].c). By default the label is the same as the Enunciate project label.
• The "forceEnable" attribute is used to force-enable the C module. By default, the C module is enabled only if REST endpoints are found in the project.
• The "enumConstantNamePattern" attribute defines the format string for converting an enum constant name to a unique c-style constant name. The arguments passed to the format string are: (1) the project label (2) the namespace id of the type definition (3) the name of the type definition (4) the NOT decapitalized annotation-specified client name of the type declaration (5) the decapitalized annotation-specified client name of the type declaration (6) the NOT-decapitalized simple name of the type declaration (7) the decapitalized simple name of the type declaration (8) the package name (9) the annotation-specified client name of the enum contant (10) the simple name of the enum constant. All tokens will be "scrubbed" by replacing any non-word character with the "_" character. The default value for this pattern is "%1$S_%2$S_%3$S_%9$S".
• The "typeDefinitionNamePattern" attribute defines the format string for converting an type definition name to a unique c-style name. The arguments passed to the format string are: (1) the project label (2) the namespace id of the type definition (3) the name of the type definition (4) the NOT decapitalized annotation-specified client name of the type declaration (5) the decapitalized annotation-specified client name of the type declaration (6) the NOT-decapitalized simple name of the type declaration (7) the decapitalized simple name of the type declaration (8) the package name. All tokens will be "scrubbed" by replacing any non-word character with the "_" character. The default value for this pattern is "%1$s_%2$s_%3$s".
• The 'separateCommonCode' attribute tells Enunciate to keep the code that is common to all Enunciate-generated projects separate from the code that is generated specifically for this project. Default: true.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.codehaus.enunciate.modules.BasicDeploymentModule

enunciate

Constructor Summary

CDeploymentModule()

Method Summary

void	doFreemarkerGenerate() Generate using Freemarker.
org.apache.commons.digester.RuleSet	getConfigurationRules() Default implementation returns null.
java.lang.String	getEnumConstantNamePattern() The pattern for converting an enum constant to a unique C-style type name.
java.lang.String	getLabel() The label for the C API.
java.lang.String	getName() The name of the deployment module.
protected freemarker.template.ObjectWrapper	getObjectWrapper() The object wrapper to use for the model.
protected java.lang.String	getSourceFileName() The name of the generated Ruby source file.
protected java.net.URL	getTemplateURL(java.lang.String template) Get a template URL for the template of the given name.
java.lang.String	getTypeDefinitionNamePattern() The pattern for converting a type definition to a unique C-style type name.
Validator	getValidator() Get the validator for this module, or null if none.
boolean	isDisabled() Whether this deployment module has been disabled, e.g.
boolean	isForceEnable() Whether to require this module (force-enable it).
boolean	isSeparateCommonCode() Whether to separate the common code from the project-specific code.
protected java.lang.String	readResource(java.lang.String resource) Reads a resource into string form.
static java.lang.String	scrubIdentifier(java.lang.String identifier) Scrub a C identifier (removing any illegal characters, etc.).
void	setEnumConstantNamePattern(java.lang.String enumConstantNamePattern) The pattern for converting an enum constant to a unique C-style type name.
void	setForceEnable(boolean forceEnable) Whether to require this module (force-enable it).
void	setLabel(java.lang.String label) The label for the C API.
void	setSeparateCommonCode(boolean separateCommonCode) Whether to separate the common code from the project-specific code.
void	setTypeDefinitionNamePattern(java.lang.String typeDefinitionNamePattern) The pattern for converting a type definition to a unique C-style type name.

Methods inherited from class org.codehaus.enunciate.modules.FreemarkerDeploymentModule

close, doGenerate, getConfiguration, getModel, getModelInternal, getTemplateExceptionHandler, getTemplateLoader, initModel, processTemplate, processTemplate, processTemplate, processTemplate

Methods inherited from class org.codehaus.enunciate.modules.BasicDeploymentModule

debug, doBuild, doCompile, doPackage, getAliases, getBuildDir, getCompileDir, getEnunciate, getGenerateDir, getOrder, getPackageDir, info, init, setBuildDir, setCompileDir, setDisabled, setGenerateDir, setPackageDir, step, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

CDeploymentModule

public CDeploymentModule()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: DeploymentModule

The name of the deployment module. Identifies its section in the enunciate configuration.

Specified by:

getName in interface DeploymentModule

Overrides:

getName in class BasicDeploymentModule

Returns:

"c"

scrubIdentifier

public static java.lang.String scrubIdentifier(java.lang.String identifier)

Scrub a C identifier (removing any illegal characters, etc.).

Parameters:

identifier - The identifier.

Returns:

The identifier.

doFreemarkerGenerate

public void doFreemarkerGenerate()
                          throws java.io.IOException,
                                 freemarker.template.TemplateException,
                                 EnunciateException

Description copied from class: FreemarkerDeploymentModule

Generate using Freemarker. Same as FreemarkerDeploymentModule.doGenerate() but can throw a TemplateException.

Specified by:

doFreemarkerGenerate in class FreemarkerDeploymentModule

Throws:

java.io.IOException

freemarker.template.TemplateException

EnunciateException

readResource

protected java.lang.String readResource(java.lang.String resource)
                                 throws java.io.IOException,
                                        EnunciateException

Reads a resource into string form.

Parameters:

resource - The resource to read.

Returns:

The string form of the resource.

Throws:

java.io.IOException

EnunciateException

getSourceFileName

protected java.lang.String getSourceFileName()

The name of the generated Ruby source file.

Returns:

The name of the generated Ruby source file.

getObjectWrapper

protected freemarker.template.ObjectWrapper getObjectWrapper()

Description copied from class: FreemarkerDeploymentModule

The object wrapper to use for the model.

Overrides:

getObjectWrapper in class FreemarkerDeploymentModule

Returns:

The object wrapper to use for the model.

getTemplateURL

protected java.net.URL getTemplateURL(java.lang.String template)

Get a template URL for the template of the given name.

Parameters:

template - The specified template.

Returns:

The URL to the specified template.

getLabel

public java.lang.String getLabel()

The label for the C API.

Returns:

The label for the C API.

setLabel

public void setLabel(java.lang.String label)

The label for the C API.

Parameters:

label - The label for the C API.

getTypeDefinitionNamePattern

public java.lang.String getTypeDefinitionNamePattern()

The pattern for converting a type definition to a unique C-style type name.

Returns:

The pattern for converting a type definition to a unique C-style type name.

setTypeDefinitionNamePattern

public void setTypeDefinitionNamePattern(java.lang.String typeDefinitionNamePattern)

The pattern for converting a type definition to a unique C-style type name.

Parameters:

typeDefinitionNamePattern - The pattern for converting a type definition to a unique C-style type name.

getEnumConstantNamePattern

public java.lang.String getEnumConstantNamePattern()

The pattern for converting an enum constant to a unique C-style type name.

Returns:

The pattern for converting an enum constant to a unique C-style type name.

setEnumConstantNamePattern

public void setEnumConstantNamePattern(java.lang.String enumConstantNamePattern)

The pattern for converting an enum constant to a unique C-style type name.

Parameters:

enumConstantNamePattern - The pattern for converting an enum constant to a unique C-style type name.

isForceEnable

public boolean isForceEnable()

Whether to require this module (force-enable it).

Returns:

Whether to require this module (force-enable it).

setForceEnable

public void setForceEnable(boolean forceEnable)

Whether to require this module (force-enable it).

Parameters:

forceEnable - Whether to require this module (force-enable it).

isSeparateCommonCode

public boolean isSeparateCommonCode()

Whether to separate the common code from the project-specific code.

Returns:

Whether to separate the common code from the project-specific code.

setSeparateCommonCode

public void setSeparateCommonCode(boolean separateCommonCode)

Whether to separate the common code from the project-specific code.

Parameters:

separateCommonCode - Whether to separate the common code from the project-specific code.

getConfigurationRules

public org.apache.commons.digester.RuleSet getConfigurationRules()

Description copied from class: BasicDeploymentModule

Default implementation returns null.

Specified by:

getConfigurationRules in interface DeploymentModule

Overrides:

getConfigurationRules in class BasicDeploymentModule

Returns:

null.

getValidator

public Validator getValidator()

Description copied from interface: DeploymentModule

Get the validator for this module, or null if none.

Specified by:

getValidator in interface DeploymentModule

Overrides:

getValidator in class BasicDeploymentModule

Returns:

null

isDisabled

public boolean isDisabled()

Description copied from interface: DeploymentModule

Whether this deployment module has been disabled, e.g. in the config file. Since the discovery mechanism is used to discover the modules on the classpath, it may be necessary to be able to disable a module.

Specified by:

isDisabled in interface DeploymentModule

Overrides:

isDisabled in class BasicDeploymentModule

Returns:

Whether this deployment module has been disabled.