added more comments on how to construct a valid StringTemplate

2012-03-14 18:17:53 +00:00
parent 982eebf70f
commit 5f2fc14b8b
1 changed files with 5 additions and 1 deletions
@@ -18,7 +18,11 @@ package jet;
 /**
 * Represents a string template object; that is a string with $ expressions such as "Hello $user".
 *
- * It is represented as an object that contains a Tuple
+ * It is represented as an object that contains a Tuple such that all the even items in the tuple are constant
+ * strings and the odd items are dynamic expressions which may need to be escaped.
+ *
+ * So the expression "Hello $foo$bar how are you?" would be represented as a tuple #("Hello ", foo, "", bar, " how are you?).
+ * i.e. we insert an empty string to ensure that the tuple starts with a constant string and every other value is a dynamic expression.
 */
 public class StringTemplate {
    private final Tuple tuple;