Package com.webcohesion.enunciate.modules.csharp_client

Class CSharpXMLClientModule

java.lang.Object

com.webcohesion.enunciate.module.BasicEnunicateModule

com.webcohesion.enunciate.module.BasicGeneratingModule

com.webcohesion.enunciate.modules.csharp_client.CSharpXMLClientModule

All Implemented Interfaces:

ApiFeatureProviderModule, DependingModuleAwareModule, EnunciateModule

public class CSharpXMLClientModule
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
CSharpXMLClientModule()

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.
WebMethod	findExampleWebMethod()	Finds an example resource method, according to the following preference order: The first method annotated with DocumentationExample.
protected String	getBundleFileName()	The name of the bundle file.
String	getCompileCommand()	The C# compile command.
protected File	getCompileDir()
String	getCompileExecutable()	The path to the compile executable.
List<DependencySpec>	getDependencySpecifications()
protected String	getDLLFileName()	The name of the generated C# dll.
protected String	getDocXmlFileName()	The name of the generated C# xml documentation.
Set<String>	getFacetExcludes()
Set<String>	getFacetIncludes()
String	getName()
protected File	getPackageDir()
Map<String,String>	getPackageToNamespaceConversions()	The package-to-namespace conversions.
String	getSlug()	The label for the C# API.
protected File	getSourceDir()
protected String	getSourceFileName()	The name of the generated C# source file.
protected URL	getTemplateURL(String template)	Get a template URL for the template of the given name.
boolean	isDisableCompile()	Whether to disable the compile step.
boolean	isRequire()	Whether to require the C# client code.
boolean	isSingleFilePerClass()	Whether there should be a single file per class.
protected String	packageToNamespace(String pckg)
String	processTemplate(URL templateURL, Object model)	Processes the specified template with the given model.
protected String	readLibraryDescription(Map<String,Object> model)
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

CSharpXMLClientModule

public CSharpXMLClientModule()

Method Detail

getName

public String getName()

Specified by:

getName in interface EnunciateModule

Returns:

"csharp-xml-client"

getDependencySpecifications

public List<DependencySpec> getDependencySpecifications()

Specified by:

getDependencySpecifications in interface EnunciateModule

Overrides:

getDependencySpecifications in class BasicEnunicateModule

call

public void call(EnunciateContext context)

Specified by:

call in interface EnunciateModule

usesUnmappableElements

protected boolean usesUnmappableElements()

getSourceDir

protected File getSourceDir()

getCompileDir

protected File getCompileDir()

getPackageDir

protected File getPackageDir()

packageToNamespace

protected String packageToNamespace(String pckg)

readLibraryDescription

protected String readLibraryDescription(Map<String,Object> model)

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

findExampleWebMethod

public WebMethod findExampleWebMethod()

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

1. The first method annotated with DocumentationExample.
2. The first web method that returns a declared type.
3. The first web method.

Returns:

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

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.

getBundleFileName

protected String getBundleFileName()

The name of the bundle file.

Returns:

The name of the bundle file.

getDLLFileName

protected String getDLLFileName()

The name of the generated C# dll.

Returns:

The name of the generated C# file.

getDocXmlFileName

protected String getDocXmlFileName()

The name of the generated C# xml documentation.

Returns:

The name of the generated C# xml documentation.

getSourceFileName

protected String getSourceFileName()

The name of the generated C# source file.

Returns:

The name of the generated C# source file.

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.

isRequire

public boolean isRequire()

Whether to require the C# client code.

Returns:

Whether to require the C# client code.

getSlug

public String getSlug()

The label for the C# API.

Returns:

The label for the C# API.

getCompileExecutable

public String getCompileExecutable()

The path to the compile executable.

Returns:

The path to the compile executable.

getCompileCommand

public String getCompileCommand()

The C# compile command.

Returns:

The C# compile command.

getPackageToNamespaceConversions

public Map<String,String> getPackageToNamespaceConversions()

The package-to-namespace conversions.

Returns:

The package-to-namespace conversions.

isDisableCompile

public boolean isDisableCompile()

Whether to disable the compile step.

Returns:

Whether to disable the compile step.

isSingleFilePerClass

public boolean isSingleFilePerClass()

Whether there should be a single file per class. Default: false (all classes are contained in a single file).

Returns:

Whether there should be a single file per class.

getFacetIncludes

public Set<String> getFacetIncludes()

getFacetExcludes

public Set<String> getFacetExcludes()