Text Template

The library exposes a class called TextTemplate.

This utility helps render text templates providing a template string and a resolver (ParameterResolver).

Examples

Input

Definition

Output

{ "name": "John" }

"Hello {name}"

"Hello John"

{ "name": "John" }

"Hello {first_name,Anonymous}"

"Hello Anonymous"

{ 
  "name": "John",
  "children": 2
}

"{name} has {children} children"

"John has 2 children"

{ 
  "first": "John",
  "last": "Doe"
}

"Your initials are {$$substring(0,1):first}{$$substring(0,1):last}"

"Your initials are JD"

info

You can use text templates inside json transformers using the function $$template

API

Java

class TextTemplate {

    /**
     * Creates a new memory template for a string
     *
     * @param template         The template text
     * @param defaultResolver  (optional) defines how the template should resolve parameter default values
     */
    public TextTemplate(String template, ParameterDefaultResolveOptions defaultResolver);

    /**
     * Exposes a read only list to inspect the list of parameters
     *
     * @return a list of parameters in the template
     */
    public List<TemplateParameter> getParameters();

    /**
     * Renders the template after inserting the parameters
     *
     * @param resolver            A resolver to extract parameter values
     * @param adapter             (optional) The adapter to use for rendering
     * @param urlEncodeParameters (optional) if true, the parameters will be URL encoded
     * @return a string with its parameters replaced
     */
    public String render(ParameterResolver resolver, JsonAdapter<?,?,?> adapter, Boolean urlEncodeParameters);

    /**
     * gets or creates a template from the cache
     *
     * @param template         the command to parse
     * @param defaultResolver  (optional) defines how the template should resolve parameter default values
     * @return a new text template
     */
    public static TextTemplate get(String template, ParameterDefaultResolveOptions defaultResolver);

    /**
     * Creates a Map suitable to be used for a parameter resolver out of string parameters.
     * Parameters needs to be provided in pairs of key and value.
     */
    public static Map<String, String> mapOf(String... parameters);

    public static String render(String template, ParameterResolver resolver, ParameterDefaultResolveOptions defaultResolver, Boolean urlEncodeParameters);
    public static String render(String template, Map<String, ?> resolver, ParameterDefaultResolveOptions defaultResolver);
}

info

Some methods will accept Map<String, ?> instead of ParameterResolver.
You can use the static method mapOf to create such a map.

TypeScript

class TextTemplate {
  /**
   * Creates a new memory template for a string
   *
   * @param template         The template text
   * @param defaultResolver  defines how the template should resolve parameter default values
   */
  constructor(template: string, defaultResolver?: ParameterDefaultResolveOptions);
  /**
   * Exposes a list copy to inspect the list of parameters
   *
   * @return a list of parameters in the template
   */
  getParameters(): TemplateParameter[];
  /**
   * gets or creates a template from the cache
   *
   * @param template         the command to parse
   * @param defaultResolver  defines how the template should resolve parameter default values
   * @return a new text template
   */
  static get(template: string, defaultResolver?: ParameterDefaultResolveOptions): TextTemplate;
  /**
   * Renders the template after inserting the parameters
   *
   * @param resolver             A resolver to extract parameter values
   * @param urlEncodeParameters  if true, the parameters will be URL encoded
   * @return a string with its parameters replaced
   */
  render(resolver: Record<string, string> | ParameterResolver, urlEncodeParameters?: boolean | null): Promise<string>;
  static render(template: string, resolver: Record<string, string> | ParameterResolver, defaultResolver?: ParameterDefaultResolveOptions, urlEncodeParameters?: boolean): Promise<string>;
}