Package de.xima.fc.interfaces.workflow.placeholder

Interface IPlaceholderReference<Location>

Type Parameters:
Location - Type of the object that uniquely identifier the placeholder reference within its containing property.
All Known Implementing Classes:
PlaceholderReference
public interface IPlaceholderReference<Location>
Models a placeholder that is contained within a IPlaceholderProperty. For example, if a string property might contains multiple placeholders, it can be tokenized into literals and placeholder tokens, and each placeholder token could be referenced by its index within the token stream.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getLocation

      Location getLocation()
      Returns:
      A key that uniquely identifies this placeholder within the IPlaceholderProperty that contains this placeholder. For example, this could be the zero-based index of the n-th token in a string property.

    • getPlaceholderContent

      String getPlaceholderContent()
      Returns:
      The content of this placeholder without the lexer mode changing tokens, e.g. tfEmail or templateSuccessullySubmitted.

    • getPlaceholderPrefix

      String getPlaceholderPrefix()
      Returns:
      The prefix of this placeholder that marks its beginning, e.g. [%.

    • getPlaceholderSuffix

      String getPlaceholderSuffix()
      Returns:
      The suffix of this placeholder that marks its end, e.g. %].