aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/main/java/com/yahoo/data/XmlProducer.java
blob: 0b986eb542b9a731f933104fd94423e7d3a94cda (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Copyright Vespa.ai. 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).
     */
    StringBuilder writeXML(StringBuilder target);

    /**
     * Convenience method equivalent to:
     * writeXML(new StringBuilder()).toString()
     *
     * @return String containing XML representation of this object's data.
     */
    default String toXML() {
        return writeXML(new StringBuilder()).toString();
    }

}