org.springframework.extensions.webscripts.annotation

Annotation Type ScriptClass

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface ScriptClass

Custom annotation type for java classes that will either serve as JavaScript or Template root objects or provide JavaScript or Template APIs. In general, developer needs to provide help information, sample code and class type in java code which will then be processed by a custom Spring Surf mavnen plugin for producing reference documents as part of the build process. This will avoid manual documentation step.

Author:

drq

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	code
String	help
ScriptClassType[]	types

Element Detail

help

public abstract String help

Returns:

a help message for this object (the default is a blank String, which means there is no help)

Default:

""

code

public abstract String code

Returns:

code snippet for this object (the default is a blank String, which means there is no sample code)

Default:

""

types

public abstract ScriptClassType[] types

Returns:

type of this class (the default is JavaScriptAPI)

Default:

org.springframework.extensions.webscripts.annotation.ScriptClassType.JavaScriptAPI