add: documentation to output classes

[gigi.git] / src / org / cacert / gigi / output / template / OutputVariableCommand.java

diff --git a/src/org/cacert/gigi/output/template/OutputVariableCommand.java b/src/org/cacert/gigi/output/template/OutputVariableCommand.java
index 382d0597ddd5991a40961c72f3a00eb1219496aa..5dce3aed211c1c45452d96929e6e0c3c9484dabe 100644 (file)
--- a/src/org/cacert/gigi/output/template/OutputVariableCommand.java
+++ b/src/org/cacert/gigi/output/template/OutputVariableCommand.java
@@ -1,29 +1,42 @@
 package org.cacert.gigi.output.template;
 
 import java.io.PrintWriter;
+import java.util.Collection;
 import java.util.Map;
 
 import org.cacert.gigi.localisation.Language;
-import org.cacert.gigi.output.Outputable;
 
-public final class OutputVariableCommand implements Outputable {
+/**
+ * Emits a variable.
+ */
+public final class OutputVariableCommand implements Translatable {
 
     private final String raw;
 
-    private final boolean escaped;
+    private final boolean unescaped;
 
+    /**
+     * Creates a new OutputVariableCommand.
+     * 
+     * @param raw
+     *            the variable to emit. If starting with <code>!</code> the
+     *            variable is emitted non-HTML-escaped.
+     */
     public OutputVariableCommand(String raw) {
         if (raw.charAt(0) == '!') {
-            escaped = true;
+            unescaped = true;
             this.raw = raw.substring(1);
         } else {
-            escaped = true;
+            unescaped = false;
             this.raw = raw;
         }
     }
 
     @Override
     public void output(PrintWriter out, Language l, Map<String, Object> vars) {
-        Template.outputVar(out, l, vars, raw, escaped);
+        Template.outputVar(out, l, vars, raw, unescaped);
     }
+
+    @Override
+    public void addTranslations(Collection<String> s) {}
 }