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

Annotation Interface JStacheFormatterTypes

@Retention(SOURCE) @Target({TYPE,PACKAGE,MODULE}) @Documented public @interface JStacheFormatterTypes
Statically sets allowed formatting types.

If a type is not allowed or known and used as a variable a compile error will happen. This annotation allows you to change that behavior by adding types.

By default the only allowed (and always allowed) types to be formatted are:

Config lookup and precedence is as follows:

  1. type annotated with JStache and this annotation.
  2. enclosing class (of type annotated with JStache) with this annotation with inner to outer order.
  3. package annotated with this annotation.
  4. module annotated with this annotation.
  5. the chosen formatter with this annotation.
However unlike other annotations in this library the found annotation settings are combined (union) and consequently the precedence order does not matter.
Author:
agentgt
See Also:
API Note
n.b. the retention policy is SOURCE as this settings are only needed for the compiler and why it is not in JStacheConfig.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    patterns
    List of regex used to match whitelist class names that are allowed to be formatted.
    Class<?>[]
    types
    Whitelist classes that will be allowed to be passed to the formatter.

  • Element Details

    • types

      Class<?>[] types
      Whitelist classes that will be allowed to be passed to the formatter.
      Returns:
      Allowed classes that will be passed to the formatter.
      Default:
      {}

    • patterns

      String[] patterns
      List of regex used to match whitelist class names that are allowed to be formatted.
      Returns:
      regex used to match class names that are allowed to be formatted.
      Default:
      {}