Package de.xima.fc.annotations

Annotation Type Placeholder

@Documented @Target(FIELD) @Retention(RUNTIME) public @interface Placeholder
Informational annotation that may be placed on a field to indicate whether the field's value may contain formcycle placeholders, such as [%tf1%].

This annotation does not prescribe which actions are to be taken when it is placed on a field. APIs may choose to use this annotation for custom behavior. If they do, they must document how they treat this annotation.

Note that while it is most common for String fields to contain placeholders, this annotation does not forbid its usage on fields of other types. APIs should clarify which field types they support.

Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Element Details

    • context

      boolean context
      Returns:
      true if the field's value may contain formcycle placeholders of type context, or false if it never contains such placeholders.
      Default:
      true

    • customSyntax

      Class<? extends IPlaceholderEscaper> customSyntax
      Returns:
      The syntax of the field's value. The class must have an accessible public no-arg constructor. This takes precedence over syntax(): If this is set to IPlaceholderEscaper.class, this value is ignored and the syntax given by syntax() is used. Otherwise, this value is used and syntax() is ignored.
      Default:
      de.xima.fc.interfaces.placeholder.params.IPlaceholderEscaper.class

    • form

      boolean form
      Returns:
      true if the field's value may contain formcycle placeholders of type form, or false if it never contains such placeholders.
      Default:
      true

    • i18n

      boolean i18n
      Returns:
      true if the field's value may contain formcycle placeholders of type i18n, or false if it never contains such placeholders.
      Default:
      true

    • session

      boolean session
      Returns:
      true if the field's value may contain formcycle placeholders of type session, or false if it never contains such placeholders.
      Default:
      true

    • syntax

      EPlaceholderEscaper syntax
      Returns:
      The syntax of the field's value. APIs may use this to decide how to insert the evaluated value of a placeholder into the field's value. This value is ignored when customSyntax() is set to any value other than IPlaceholderEscaper.class.
      Default:
      PLAIN_TEXT

    • system

      boolean system
      Returns:
      true if the field's value may contain formcycle placeholders of type system, or false if it never contains such placeholders.
      Default:
      true

    • template

      boolean template
      Returns:
      true if the field's value may contain formcycle placeholders of type template, or false if it never contains such placeholders.
      Default:
      true

    • value

      boolean value
      Returns:
      true if the field's value may contain formcycle placeholders of any type, or false otherwise. When set to false, the values of context(), form() etc. are ignored.
      Default:
      true