package com.temp.shared.utils;

public interface TemplateSource {

    static final String SUBSTITUTION_ID_PREFIX = "{";
    static final String SUBSTITUTION_ID_SUFFIX = "}";
    static final String SUBSTITUTION_ID_NO_PREFIX = "{No";

    static final String SPACE_SUBSTITUTION_ID = "{Space}"; // used to force either leading or trailing spaces from being "trim()" away

    static final String DONT_SHOW_SUBSTITUTION_ID = "{DontShow}"; // Don't Show this block Indicator

    /**
     * Get the Template value associated with the key
     *
     * @param key
     *            Leading and trailing spaces are ignored
     *
     * @return null or the Template value associated with the key
     */
    String get(String key);

    /**
     * Get the Template value associated with the key or the defaultValue if the
     * key was not found or its value was empty
     *
     * @param key
     *            Leading and trailing spaces are ignored
     *
     * @return The Template value associated with the key or the defaultValue if
     *         the key was not found or its value was empty
     */
    String get(String key, String defaultValue);
}