ServiceId.java

/*
 * The MIT License
 * Copyright (c) 2012 Microsoft Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package microsoft.exchange.webservices.data.property.complex;

import microsoft.exchange.webservices.data.core.EwsServiceXmlReader;
import microsoft.exchange.webservices.data.core.EwsServiceXmlWriter;
import microsoft.exchange.webservices.data.core.EwsUtilities;
import microsoft.exchange.webservices.data.core.XmlAttributeNames;
import microsoft.exchange.webservices.data.core.exception.service.local.ServiceXmlSerializationException;
import org.apache.commons.lang3.StringUtils;

/**
 * Represents the Id of an Exchange object.
 */
public abstract class ServiceId extends ComplexProperty {

  /**
   * The change key.
   */
  private String changeKey;

  /**
   * The unique id.
   */
  private String uniqueId;

  /**
   * Initializes a new instance.
   */
  public ServiceId() {
    super();
  }

  /**
   * Initializes a new instance.
   *
   * @param uniqueId The unique id.
   * @throws Exception the exception
   */
  public ServiceId(String uniqueId) throws Exception {
    this();
    EwsUtilities.validateParam(uniqueId, "uniqueId");
    this.uniqueId = uniqueId;
  }

  /**
   * Read attribute from XML.
   *
   * @param reader The reader.
   * @throws Exception the exception
   */
  @Override
  public void readAttributesFromXml(EwsServiceXmlReader reader)
      throws Exception {
    this.uniqueId = reader.readAttributeValue(XmlAttributeNames.Id);
    this.changeKey = reader.readAttributeValue(XmlAttributeNames.ChangeKey);

  }

  /**
   * Writes attribute to XML.
   *
   * @param writer The writer.
   * @throws ServiceXmlSerializationException the service xml serialization exception
   */
  @Override
  public void writeAttributesToXml(EwsServiceXmlWriter writer)
      throws ServiceXmlSerializationException {
    writer.writeAttributeValue(XmlAttributeNames.Id, this.getUniqueId());
    writer.writeAttributeValue(XmlAttributeNames.ChangeKey, this
        .getChangeKey());
  }

  /**
   * Gets the name of the XML element.
   *
   * @return XML element name.
   */
  public abstract String getXmlElementName();

  /**
   * Writes to XML.
   *
   * @param writer The writer.
   * @throws Exception the exception
   */
  public void writeToXml(EwsServiceXmlWriter writer) throws Exception {
    this.writeToXml(writer, this.getXmlElementName());
  }

  /**
   * Assigns from existing id.
   *
   * @param source The source.
   */
  public void assign(ServiceId source) {
    this.uniqueId = source.getUniqueId();
    this.changeKey = source.getChangeKey();
  }

  /**
   * True if this instance is valid, false otherthise.
   *
   * @return true if this instance is valid; otherwise,false
   */
  public boolean isValid() {
    return (null != this.uniqueId && !this.uniqueId.isEmpty());
  }

  /**
   * Gets the unique Id of the Exchange object.
   *
   * @return unique Id of the Exchange object.
   */
  public String getUniqueId() {
    return uniqueId;
  }

  /**
   * Sets the unique Id of the Exchange object.
   *
   * @param uniqueId unique Id of the Exchange object.
   */
  public void setUniqueId(String uniqueId) {
    this.uniqueId = uniqueId;
  }

  /**
   * Gets the change key associated with the Exchange object. The change key
   * represents the version of the associated item or folder.
   *
   * @return change key associated with the Exchange object.
   */
  public String getChangeKey() {
    return changeKey;
  }

  /**
   * Sets the change key associated with the Exchange object. The change key
   * represents the version of the associated item or folder.
   *
   * @param changeKey change key associated with the Exchange object.
   */
  public void setChangeKey(String changeKey) {
    this.changeKey = changeKey;
  }

  /**
   * Determines whether two ServiceId instances are equal (including
   * ChangeKeys).
   *
   * @param other The ServiceId to compare with the current ServiceId.
   * @return true if equal otherwise false.
   */
  public boolean sameIdAndChangeKey(final ServiceId other) {
    return this.equals(other) && StringUtils.equals(this.getChangeKey(), other.getChangeKey());
  }

  /**
   * Determines whether the specified instance is equal to the current
   * instance. We do not consider the ChangeKey for ServiceId.Equals.
   *
   * @param obj The object to compare with the current instance
   * @return true if the specified object is equal to the current instance,
   * otherwise, false.
   */
  @Override
  public boolean equals(Object obj) {
    if (super.equals(obj)) {
      return true;
    } else {
      if (!(obj instanceof ServiceId)) {
        return false;
      } else {
        ServiceId other = (ServiceId) obj;
        if (!(this.isValid() && other.isValid())) {
          return false;
        } else {
          return this.getUniqueId().equals(other.getUniqueId());
        }
      }
    }
  }

  /**
   * Serves as a hash function for a particular type. We do not consider the
   * change key in the hash code computation.
   *
   * @return A hash code for the current
   */
  @Override
  public int hashCode() {
    return this.isValid() ? this.getUniqueId().hashCode() : super
        .hashCode();
  }

  /**
   * Returns a string that represents the current instance.
   *
   * @return A string that represents the current instance.
   */
  @Override
  public String toString() {
    return (this.uniqueId == null) ? "" : this.uniqueId;
  }
}