Module io.jstach.jstache
Package io.jstach.jstache

Annotation Interface JStacheName

@Retention(SOURCE) @Target(ANNOTATION_TYPE) @Documented public @interface JStacheName
Configures how to name the generated template java code (the classes generated from JStache annotations). See JStacheConfig on how this configuration is fully resolved.
Author:
agentgt
See Also:
API Note
The default return values of UNSPECIFIED on the annotation methods are not the actual default but rather signify not set.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    prefix
    If JStache.name() is blank the name of the generated class is derived from the models class name plus the return value if the return value is not ""*"".
    String
    suffix
    If JStache.name() is blank the name of the generated class is derived from the models class name plus the return value if the return value is not ""*"".

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_PREFIX
    The default prefix if no prefix() is set anywhere.
    static final String
    DEFAULT_SUFFIX
    The default suffix if no suffix() is set anywhere.
    static final String
    UNSPECIFIED
    The value to mean the suffix and prefix is not set.

  • Field Details

    • UNSPECIFIED

      static final String UNSPECIFIED
      The value to mean the suffix and prefix is not set.
      See Also:
      API Note
      The value is purposely not a possible valid prefix or suffix and is not the actual default.

    • DEFAULT_PREFIX

      static final String DEFAULT_PREFIX
      The default prefix if no prefix() is set anywhere. The generated renderers by default are prefix with this literal: ""
      See Also:

    • DEFAULT_SUFFIX

      static final String DEFAULT_SUFFIX
      The default suffix if no suffix() is set anywhere. The generated renderers by default are suffix with this literal: "Renderer"
      See Also:

  • Element Details

    • prefix

      String prefix
      If JStache.name() is blank the name of the generated class is derived from the models class name plus the return value if the return value is not ""*"".
      Returns:
      suffix for generated classes.
      See Also:
      Default:
      "*"

    • suffix

      String suffix
      If JStache.name() is blank the name of the generated class is derived from the models class name plus the return value if the return value is not ""*"".
      Returns:
      suffix for generated classes.
      See Also:
      Default:
      "*"