Package com.webcohesion.enunciate.modules.ruby_json_client

Class RubyJSONClientModule

java.lang.Object

com.webcohesion.enunciate.module.BasicEnunicateModule

com.webcohesion.enunciate.module.BasicGeneratingModule

com.webcohesion.enunciate.modules.ruby_json_client.RubyJSONClientModule

All Implemented Interfaces:

ApiFeatureProviderModule, DependingModuleAwareModule, EnunciateModule

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

Method Summary

Modifier and Type	Method	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.
List<DependencySpec>	getDependencySpecifications()
Set<String>	getFacetExcludes()
Set<String>	getFacetIncludes()
String	getName()
Map<String,String>	getPackageToModuleConversions()	The package-to-module conversions.
String	getSlug()	The label for the PHP API.
protected File	getSourceDir()
protected String	getSourceFileName()	The name of the generated Ruby source file.
protected URL	getTemplateURL(String template)	Get a template URL for the template of the given name.
protected String	packageToModule(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.
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

RubyJSONClientModule

public RubyJSONClientModule()

Method Detail

getName

public String getName()

Specified by:

getName in interface EnunciateModule

Returns:

"ruby-json-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()

detectAccessorNamingErrors

protected void detectAccessorNamingErrors()

getSourceDir

protected File getSourceDir()

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

packageToModule

protected String packageToModule(String pckg)

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 Ruby source file.

Returns:

The name of the generated Ruby 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 PHP API.

Returns:

The label for the PHP API.

getPackageToModuleConversions

public Map<String,String> getPackageToModuleConversions()

The package-to-module conversions.

Returns:

The package-to-module conversions.

getFacetIncludes

public Set<String> getFacetIncludes()

getFacetExcludes

public Set<String> getFacetExcludes()