Package com.webcohesion.enunciate.modules.c_client

Class CXMLClientModule

java.lang.Object

com.webcohesion.enunciate.module.BasicEnunicateModule

com.webcohesion.enunciate.module.BasicGeneratingModule

com.webcohesion.enunciate.modules.c_client.CXMLClientModule

All Implemented Interfaces:

ApiFeatureProviderModule, DependingModuleAwareModule, EnunciateModule

public class CXMLClientModule
extends BasicGeneratingModule
implements ApiFeatureProviderModule

Author:

Ryan Heaton

Field Summary

Fields inherited from class com.webcohesion.enunciate.module.BasicEnunicateModule

config, context, dependingModules, enunciate

Constructor Summary

Constructors

Constructor	Description
CXMLClientModule()

Method Summary

Modifier and Type	Method	Description
void	call(EnunciateContext context)
Method	findExampleResourceMethod()	Finds an example resource method, according to the following preference order: The first method annotated with DocumentationExample.
List<DependencySpec>	getDependencySpecifications()
String	getEnumConstantNamePattern()	The pattern for converting an enum constant to a unique C-style type name.
Set<String>	getFacetExcludes()
Set<String>	getFacetIncludes()
String	getName()
String	getSlug()	The slug for the C API.
protected File	getSourceDir()
protected String	getSourceFileName(String label)
protected URL	getTemplateURL(String template)	Get a template URL for the template of the given name.
String	getTypeDefinitionNamePattern()	The pattern for converting a type definition to a unique C-style type name.
boolean	isSeparateCommonCode()	Whether to separate the common code from the project-specific code.
String	processTemplate(URL templateURL, Object model)	Processes the specified template with the given model.
protected String	readResource(String resource, Map<String,Object> model, NameForTypeDefinitionMethod nameForTypeDefinition)	Reads a resource into string form.
static String	scrubIdentifier(String identifier)	Scrub a C identifier (removing any illegal characters, etc.).
protected boolean	usesUnmappableElements()

Methods inherited from class com.webcohesion.enunciate.module.BasicGeneratingModule

buildFileList, findSourceTimestamp, getManifest, getOldest, getYoungest, isUpToDate, isUpToDateWithSources

Methods inherited from class com.webcohesion.enunciate.module.BasicEnunicateModule

acknowledgeDependingModules, debug, descriptionOf, error, info, init, init, isEnabled, isEnabledByDefault, positionOf, resolveFile, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.webcohesion.enunciate.module.EnunciateModule

init, init, isEnabled

Constructor Detail

CXMLClientModule

public CXMLClientModule()

Method Detail

getName

public String getName()

Specified by:

getName in interface EnunciateModule

Returns:

"c-xml-client"

getDependencySpecifications

public List<DependencySpec> getDependencySpecifications()

Specified by:

getDependencySpecifications in interface EnunciateModule

Overrides:

getDependencySpecifications in class BasicEnunicateModule

scrubIdentifier

public static String scrubIdentifier(String identifier)

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

Parameters:

identifier - The identifier.

Returns:

The identifier.

call

public void call(EnunciateContext context)

Specified by:

call in interface EnunciateModule

usesUnmappableElements

protected boolean usesUnmappableElements()

processTemplate

public String processTemplate(URL templateURL,
                              Object model)
                       throws IOException,
                              freemarker.template.TemplateException

Processes the specified template with the given model.

Parameters:

templateURL - The template URL.

model - The root model.

Throws:

IOException

freemarker.template.TemplateException

readResource

protected String readResource(String resource,
                              Map<String,Object> model,
                              NameForTypeDefinitionMethod nameForTypeDefinition)

Reads a resource into string form.

Parameters:

resource - The resource to read.

Returns:

The string form of the resource.

findExampleResourceMethod

public Method findExampleResourceMethod()

Finds an example resource method, according to the following preference order:

1. The first method annotated with DocumentationExample.
2. The first method with BOTH an output payload with a known XML element and an input payload with a known XML element.
3. The first method with an output payload with a known XML element.

Returns:

An example resource method, or if no good examples were found.

getSourceFileName

protected String getSourceFileName(String label)

getSourceDir

protected File getSourceDir()

getTemplateURL

protected URL getTemplateURL(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.

getSlug

public String getSlug()

The slug for the C API.

Returns:

The slug for the C API.

getTypeDefinitionNamePattern

public 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.

getEnumConstantNamePattern

public 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.

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.

getFacetIncludes

public Set<String> getFacetIncludes()

getFacetExcludes

public Set<String> getFacetExcludes()