upd: rename package name and all references to it

[gigi.git] / src / club / wpia / gigi / output / template / Outputable.java

diff --git a/src/club/wpia/gigi/output/template/Outputable.java b/src/club/wpia/gigi/output/template/Outputable.java
new file mode 100644 (file)
index 0000000..836a44f
--- /dev/null
+++ b/src/club/wpia/gigi/output/template/Outputable.java
@@ -0,0 +1,26 @@
+package club.wpia.gigi.output.template;
+
+import java.io.PrintWriter;
+import java.util.Map;
+
+import club.wpia.gigi.localisation.Language;
+
+/**
+ * An object that is outputable to the user normally in an HTML-page.
+ */
+public interface Outputable {
+
+    public static final String OUT_KEY_PLAIN = "output-content-plain";
+
+    /**
+     * Writes this object's content to the given output stream.
+     * 
+     * @param out
+     *            the PrintWriter to the user.
+     * @param l
+     *            the {@link Language} to translate localizable strings to.
+     * @param vars
+     *            a map of variable assignments for this template.
+     */
+    public void output(PrintWriter out, Language l, Map<String, Object> vars);
+}