Package org.springframework.ai.template.st

Class StTemplateRenderer.Builder

java.lang.Object
org.springframework.ai.template.st.StTemplateRenderer.Builder
Enclosing class:
StTemplateRenderer
public static final class StTemplateRenderer.Builder extends Object
Builder for configuring and creating StTemplateRenderer instances.

  • Method Details

    • startDelimiterToken

      public StTemplateRenderer.Builder startDelimiterToken(char startDelimiterToken)
      Sets the character used as the start delimiter for template expressions. Default is '{'.
      Parameters:
      startDelimiterToken - The start delimiter character.
      Returns:
      This builder instance for chaining.

    • endDelimiterToken

      public StTemplateRenderer.Builder endDelimiterToken(char endDelimiterToken)
      Sets the character used as the end delimiter for template expressions. Default is '}'.
      Parameters:
      endDelimiterToken - The end delimiter character.
      Returns:
      This builder instance for chaining.

    • validationMode

      public StTemplateRenderer.Builder validationMode(ValidationMode validationMode)
      Sets the validation mode to control behavior when the provided variables do not match the variables required by the template. Default is ValidationMode.THROW.
      Parameters:
      validationMode - The desired validation mode.
      Returns:
      This builder instance for chaining.

    • validateStFunctions

      public StTemplateRenderer.Builder validateStFunctions()
      Configures the renderer to support StringTemplate's built-in functions during validation.

      When enabled (set to true), identifiers in the template that match known ST function names (e.g., "first", "rest", "length") will not be treated as required input variables during validation.

      When disabled (default, false), these identifiers are treated like regular variables and must be provided in the input map if validation is enabled (ValidationMode.WARN or ValidationMode.THROW).

      Returns:
      This builder instance for chaining.

    • build

      public StTemplateRenderer build()
      Builds and returns a new StTemplateRenderer instance with the configured settings.
      Returns:
      A configured StTemplateRenderer.