com.google.api.client.xml.GenericXml Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-client Show documentation

Google API Client Library for Java. Supports Java 5 (or higher) desktop (SE) and web (EE), Android, and Google App Engine.

There is a newer version: 1.4.1-beta

Show newest version

package com.google.api.client.xml;

import com.google.api.client.util.GenericData;
import com.google.api.client.util.Key;

/**
 * Generic XML data that stores all unknown key name/value pairs.
 * 
 * Each data key name maps into the name of the XPath expression value for the
 * XML element, attribute, or text content (using {@code "text()"}). Subclasses
 * can declare fields for known XML content using the {@link Key} annotation.
 * Each field can be of any visibility (private, package private, protected, or
 * public) and must not be static. {@code null} unknown data key names are not
 * allowed, but {@code null} data values are allowed.
 * 
 * @since 1.0
 * @author Yaniv Inbar
 */
public class GenericXml extends GenericData implements Cloneable {

  /**
   * Optional XML element local name prefixed by its namespace alias -- for
   * example {@code "atom:entry"} -- or {@code null} if not set.
   */
  public String name;

  /** Optional namespace dictionary or {@code null} if not set. */
  public XmlNamespaceDictionary namespaceDictionary;

  @Override
  public GenericXml clone() {
    return (GenericXml) super.clone();
  }

  @Override
  public String toString() {
    XmlNamespaceDictionary namespaceDictionary = this.namespaceDictionary;
    if (namespaceDictionary == null) {
      namespaceDictionary = new XmlNamespaceDictionary();
    }
    return namespaceDictionary.toStringOf(this.name, this);
  }
}