com.webcohesion.enunciate.modules.java_xml_client

Class JavaXMLClientModule

java.lang.Object

com.webcohesion.enunciate.module.BasicEnunicateModule

com.webcohesion.enunciate.module.BasicGeneratingModule

com.webcohesion.enunciate.modules.java_xml_client.JavaXMLClientModule

All Implemented Interfaces:

ApiFeatureProviderModule, DependingModuleAwareModule, EnunciateModule, ProjectExtensionModule

public class JavaXMLClientModule
extends BasicGeneratingModule
implements ApiFeatureProviderModule, ProjectExtensionModule

Author:

Ryan Heaton

Field Summary

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

config, context, dependingModules, enunciate

Constructor Summary

Constructors

Constructor and Description
JavaXMLClientModule()

Method Summary

Methods

Modifier and Type	Method and Description
void	call(EnunciateContext context)
protected File	compileClientSources(File sourceDir)
protected File	copyResources()
protected void	copyServerSideType(File sourceDir, TypeElement type)
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 File	generateClientSources()
String	getArtifactId()
protected String	getBeanName(ClientClassnameForMethod conversion, String preconvert) Get the bean name for a specified string.
Map<String,String>	getClientPackageConversions()
protected File	getCompileDir()
List<DependencySpec>	getDependencySpecifications()
Set<String>	getFacetExcludes()
Set<String>	getFacetIncludes()
String	getGroupId()
String	getJarName()
String	getJavacSource()
String	getJavacTarget()
String	getName()
protected File	getPackageDir()
List<File>	getProjectResourceDirectories()
List<File>	getProjectSources()
List<File>	getProjectTestResourceDirectories()
List<File>	getProjectTestSources()
protected File	getResourcesDir()
protected File	getServerSideDestFile(File sourceDir, JavaFileObject sourceFile, TypeElement declaration)
Set<String>	getServerSideTypesToUse()
String	getSlug()
protected File	getSourceDir()
protected URL	getTemplateURL(String template)
String	getVersion()
boolean	isBundleSourcesWithClasses()
boolean	isDisableCompile() Whether to disable the compilation of the java sources (default: false).
protected File	packageArtifacts(File sourceDir, File resourcesDir, File compileDir)
String	processTemplate(URL templateURL, Object model) Processes the specified template with the given model.
protected String	readLibraryDescription(Map<String,Object> model) Reads a resource into string form.
protected boolean	useServerSide(TypeElement declaration, AntPatternMatcher matcher) Whether to use the server-side declaration for this declaration.

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, 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

JavaXMLClientModule

public JavaXMLClientModule()

Method Detail

getName

public String getName()

Specified by:

getName in interface EnunciateModule

Returns:

"java-xml"

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

generateClientSources

protected File generateClientSources()

copyServerSideType

protected void copyServerSideType(File sourceDir,
                      TypeElement type)
                           throws IOException

Throws:

IOException

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

getServerSideDestFile

protected File getServerSideDestFile(File sourceDir,
                         JavaFileObject sourceFile,
                         TypeElement declaration)

useServerSide

protected boolean useServerSide(TypeElement declaration,
                    AntPatternMatcher matcher)

Whether to use the server-side declaration for this declaration.

Parameters:

declaration - The declaration.

matcher - The matcher.

Returns:

Whether to use the server-side declaration for this declaration.

getBeanName

protected String getBeanName(ClientClassnameForMethod conversion,
                 String preconvert)

Get the bean name for a specified string.

Parameters:

conversion - The conversion to use.

preconvert - The pre-converted fqn.

Returns:

The converted fqn.

compileClientSources

protected File compileClientSources(File sourceDir)

getCompileDir

protected File getCompileDir()

copyResources

protected File copyResources()

getResourcesDir

protected File getResourcesDir()

packageArtifacts

protected File packageArtifacts(File sourceDir,
                    File resourcesDir,
                    File compileDir)

getPackageDir

protected File getPackageDir()

readLibraryDescription

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

Reads a resource into string form.

Returns:

The string form of the resource.

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.

getTemplateURL

protected URL getTemplateURL(String template)

getJarName

public String getJarName()

getClientPackageConversions

public Map<String,String> getClientPackageConversions()

getServerSideTypesToUse

public Set<String> getServerSideTypesToUse()

getSlug

public String getSlug()

isBundleSourcesWithClasses

public boolean isBundleSourcesWithClasses()

getGroupId

public String getGroupId()

getArtifactId

public String getArtifactId()

getVersion

public String getVersion()

getJavacSource

public String getJavacSource()

getJavacTarget

public String getJavacTarget()

getProjectSources

public List<File> getProjectSources()

Specified by:

getProjectSources in interface ProjectExtensionModule

getProjectTestSources

public List<File> getProjectTestSources()

Specified by:

getProjectTestSources in interface ProjectExtensionModule

getProjectResourceDirectories

public List<File> getProjectResourceDirectories()

Specified by:

getProjectResourceDirectories in interface ProjectExtensionModule

getProjectTestResourceDirectories

public List<File> getProjectTestResourceDirectories()

Specified by:

getProjectTestResourceDirectories in interface ProjectExtensionModule

isDisableCompile

public boolean isDisableCompile()

Whether to disable the compilation of the java sources (default: false).

Returns:

Whether to disable the compilation of the java sources (default: false).

getFacetIncludes

public Set<String> getFacetIncludes()

getFacetExcludes

public Set<String> getFacetExcludes()