Publish

1 files changed, 23 insertions, 0 deletions

diff --git a/container-search/src/main/java/com/yahoo/data/XmlProducer.java b/container-search/src/main/java/com/yahoo/data/XmlProducer.java
new file mode 100644
index 00000000000..d1d65aab095
--- /dev/null
+++ b/container-search/src/main/java/com/yahoo/data/XmlProducer.java
@@ -0,0 +1,23 @@
+// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+package com.yahoo.data;
+
+/**
+ * Generic API for classes that contain data representable as XML.
+ **/
+public interface XmlProducer {
+
+    /**
+     * Append the XML representation of this object's data to a StringBuilder.
+     * @param target the StringBuilder to append to.
+     * @return the target passed in is also returned (to allow chaining).
+     **/
+    public StringBuilder writeXML(StringBuilder target);
+
+    /**
+     * Convenience method equivalent to:
+     * makeXML(new StringBuilder()).toString()
+     * @return String containing XML representation of this object's data.
+     **/
+    public String toXML();
+}
+