com.webcohesion.enunciate.modules.javascript_client

Class JavaScriptClientModule

java.lang.Object

com.webcohesion.enunciate.module.BasicEnunicateModule

com.webcohesion.enunciate.module.BasicGeneratingModule

com.webcohesion.enunciate.modules.javascript_client.JavaScriptClientModule

All Implemented Interfaces:

ApiFeatureProviderModule, DependingModuleAwareModule, EnunciateModule

public class JavaScriptClientModule
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 and Description
JavaScriptClientModule()

Method Summary

Methods

Modifier and Type	Method and Description
void	call(EnunciateContext context)
protected void	detectAccessorNamingErrors()
Method	findExampleResourceMethod() 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.
List<DependencySpec>	getDependencySpecifications()
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 JavaScript API.
protected File	getSourceDir()
protected String	getSourceFileName() The name of the generated js source file.
protected URL	getTemplateURL(String template) Get a template URL for the template of the given name.
protected String	packageToNamespace(String pckg)
String	processTemplate(URL templateURL, Object model) Processes the specified template with the given model.
protected String	readResource(String resource, Map<String,Object> model) Reads a resource into string form.

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

buildFileList, findSourceTimestamp, getOldest, getYoungest, isUpToDate, isUpToDateWithSources

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

acknowledgeDependingModules, debug, descriptionOf, error, info, init, init, isEnabled, 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

JavaScriptClientModule

public JavaScriptClientModule()

Method Detail

getName

public String getName()

Specified by:

getName in interface EnunciateModule

Returns:

"javascript-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

detectAccessorNamingErrors

protected void detectAccessorNamingErrors()

getSourceDir

protected File getSourceDir()

getPackageDir

protected File getPackageDir()

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

packageToNamespace

protected String packageToNamespace(String pckg)

getBundleFileName

protected String getBundleFileName()

The name of the bundle file.

Returns:

The name of the bundle file.

readResource

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

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()

The name of the generated js source file.

Returns:

The name of the generated js 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.

getSlug

public String getSlug()

The label for the JavaScript API.

Returns:

The label for the JavaScript API.

getPackageToNamespaceConversions

public Map<String,String> getPackageToNamespaceConversions()

The package-to-namespace conversions.

Returns:

The package-to-namespace conversions.

getFacetIncludes

public Set<String> getFacetIncludes()

getFacetExcludes

public Set<String> getFacetExcludes()