Package org.springframework.extensions.webscripts.annotation

Annotation Interface ScriptClass

@Retention(RUNTIME) @Target(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

  • Element Details

    • help

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

    • code

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

    • types

      ScriptClassType[] types
      Returns:
      type of this class (the default is JavaScriptAPI)
      Default:
      {JavaScriptAPI}