XMLUtils.java

package org.testng.reporters;

import java.text.CharacterIterator;
import java.text.StringCharacterIterator;
import java.util.Map.Entry;
import java.util.Properties;
import javax.annotation.Nullable;

/**
 * Static helpers for XML.
 *
 * @author Cedric Beust Jul 21, 2003
 *
 */
public final class XMLUtils {

  /** Platform specific end of line */
  private static final String EOL = System.getProperty("line.separator");

  private XMLUtils() {
    // Hide constructor
  }

  /**
   * Generate tag.
   * An opening and closing tag will be generated even if value is null.
   * @param name name of the tag
   * @param content content for this tag (or null)
   * @param attributes tag attributes (or null)
   */
  static public String xml(String indent,
                           String name,
                           @Nullable String content,
                           @Nullable Properties attributes) {
    IBuffer result = Buffer.create();
    xmlOpen(result, indent, name, attributes, true /* no newline */);
    if (content != null) {
      result.append(content);
    }
    xmlClose(result, "", name, XMLUtils.extractComment(name, attributes));

    return result.toString();
  }

  public static String extractComment(String tag, Properties properties) {
    if (properties == null || "span".equals(tag)) return null;

    String[] attributes = new String[] { "id", "name", "class" };
    for (String a : attributes) {
      String comment = properties.getProperty(a);
      if (comment != null) {
        return " <!-- " + comment.replaceAll("[-]{2,}", "-") + " -->";
      }
    }

    return null;
  }

  public static void xmlOptional(IBuffer result, String sp,
      String elementName, Boolean value, Properties attributes) {
    if (null != value) {
      xmlRequired(result, sp, elementName, value.toString(), attributes);
    }
  }

  public static void xmlOptional(IBuffer result, String sp,
      String elementName, @Nullable String value, Properties attributes) {
    if (null != value) {
      xmlRequired(result, sp, elementName, value, attributes);
    }
  }

  public static void xmlRequired(IBuffer result, String sp,
      String elementName, @Nullable String value, @Nullable Properties attributes) {
    result.append(xml(sp, elementName, value, attributes));
  }

  public static void xmlOpen(IBuffer result, String indent, String tag,
      Properties attributes) {
    xmlOpen(result, indent, tag, attributes, false /* no newline */);
  }

  /**
   * Appends the attributes to result. The attributes are added on a single line
   * as: key1="value1" key2="value2" ... (a space is added before the first key)
   *
   * @param result
   *          the buffer to append attributes to.
   * @param attributes
   *          the attributes to append (may be null).
   */
  public static void appendAttributes(IBuffer result, Properties attributes) {
    if (null != attributes) {
      for (Object element : attributes.entrySet()) {
        Entry entry = (Entry) element;
        String key = entry.getKey().toString();
        String value = escape(entry.getValue().toString());
        result.append(" ").append(key).append("=\"").append(value).append("\"");
      }
    }
  }

  public static void xmlOpen(IBuffer result, String indent, String tag,
      Properties attributes, boolean noNewLine) {
    result.append(indent).append("<").append(tag);
    appendAttributes(result, attributes);
    result.append(">");
    if (!noNewLine) {
      result.append(EOL);
    }
  }

  public static void xmlClose(IBuffer result, String indent, String tag, String comment) {
    result.append(indent).append("</").append(tag).append(">")
        .append(comment != null ? comment : "")
        .append(EOL);
  }

  public static String escape(String input) {
    if (input == null) {
      return null;
    }
    StringBuilder result = new StringBuilder();
    StringCharacterIterator iterator = new StringCharacterIterator(input);
    char character = iterator.current();
    while (character != CharacterIterator.DONE) {
      if (character == '<') {
        result.append("<");
      } else if (character == '>') {
        result.append(">");
      } else if (character == '\"') {
        result.append(""");
      } else if (character == '\'') {
        result.append("'");
      } else if (character == '&') {
        result.append("&");
      } else {
        result.append(character);
      }
      character = iterator.next();
    }
    return result.toString();
  }
}