Interface CtxApi

All Known Implementing Classes:
ImmutableCtxApi
@JStache(path="api") @Immutable public interface CtxApi
Context passed to Mustache when compiling an api.

  • Method Details

    • builder

      static ImmutableCtxApi.Builder builder()
      Returns a builder for this type.
      Returns:
      a builder for this type

    • appName

      String appName()
      Returns the application name.
      Returns:
      the application name

    • version

      String version()
      Returns the application version.
      Returns:
      the application version

    • appDescription

      Optional<String> appDescription()
      Returns the optional application description.
      Returns:
      the optional application description

    • infoEmail

      Optional<String> infoEmail()
      Returns the optional information email.
      Returns:
      the optional information email

    • externalDocs

      List<CtxApi.CtxOperationExternalDoc> externalDocs()
      Returns a list of external documentation references.
      Returns:
      a list of external documentation references

    • returnContainer

      @Nullable Map<String,String> returnContainer()
      Returns the return type information for containers. This is wrong..
      Returns:
      the return type information for containers. This is wrong.

    • getImports

      SortedSet<String> getImports()
      Returns the imports needed for this API class.
      Returns:
      the imports needed for this API class

    • operations

      List<CtxApi.CtxOperationRef> operations()
      Returns the operation contexts in this API class.
      Returns:
      the operation contexts in this API class

    • packageName

      String packageName()
      Returns the package name.
      Returns:
      the package name

    • classname

      String classname()
      Returns the class name.
      Returns:
      the class name

    • generatedAnnotationClass

      String generatedAnnotationClass()
      Returns the name of the Generated annotation class.
      Returns:
      the name of the Generated annotation class

    • generatorClass

      String generatorClass()
      Returns the name of the generator.
      Returns:
      the name of the generator

    • generatedDate

      Optional<String> generatedDate()
      Returns the optional generation date.
      Returns:
      the optional generation date

    • commonPath

      String commonPath()
      Returns the common REST path for all operations in this API class.
      Returns:
      the common REST path for all operations in this API class

    • madaApi

      CtxApiExt madaApi()
      Returns additional custom template data for the api.
      Returns:
      additional custom template data for the api