001/*
002 * The MIT License
003 * Copyright (c) 2012 Microsoft Corporation
004 *
005 * Permission is hereby granted, free of charge, to any person obtaining a copy
006 * of this software and associated documentation files (the "Software"), to deal
007 * in the Software without restriction, including without limitation the rights
008 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
009 * copies of the Software, and to permit persons to whom the Software is
010 * furnished to do so, subject to the following conditions:
011 *
012 * The above copyright notice and this permission notice shall be included in
013 * all copies or substantial portions of the Software.
014 *
015 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
016 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
017 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
018 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
019 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
020 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
021 * THE SOFTWARE.
022 */
023
024package microsoft.exchange.webservices.data.property.complex;
025
026import microsoft.exchange.webservices.data.attribute.EditorBrowsable;
027import microsoft.exchange.webservices.data.core.EwsServiceXmlReader;
028import microsoft.exchange.webservices.data.core.EwsServiceXmlWriter;
029import microsoft.exchange.webservices.data.core.XmlElementNames;
030import microsoft.exchange.webservices.data.core.enumeration.attribute.EditorBrowsableState;
031import microsoft.exchange.webservices.data.core.enumeration.property.ImAddressKey;
032import microsoft.exchange.webservices.data.core.exception.service.local.ServiceXmlDeserializationException;
033import microsoft.exchange.webservices.data.core.exception.service.local.ServiceXmlSerializationException;
034
035import javax.xml.stream.XMLStreamException;
036
037/**
038 * Represents an entry of an ImAddressDictionary.
039 */
040@EditorBrowsable(state = EditorBrowsableState.Never)
041public final class ImAddressEntry extends DictionaryEntryProperty<ImAddressKey> {
042
043  /**
044   * The im address.
045   */
046  private String imAddress;
047
048  /**
049   * Initializes a new instance of the "ImAddressEntry" class.
050   */
051  protected ImAddressEntry() {
052    super(ImAddressKey.class);
053  }
054
055  /**
056   * Initializes a new instance of the ="ImAddressEntry" class.
057   *
058   * @param key       The key.
059   * @param imAddress The im address.
060   */
061  protected ImAddressEntry(ImAddressKey key, String imAddress) {
062    super(ImAddressKey.class, key);
063    this.imAddress = imAddress;
064  }
065
066  /**
067   * Gets the Instant Messaging address of the entry.
068   *
069   * @return imAddress
070   */
071  public String getImAddress() {
072    return this.imAddress;
073  }
074
075  /**
076   * Sets the Instant Messaging address of the entry.
077   *
078   * @param value the new im address
079   */
080  public void setImAddress(Object value) {
081
082    this.canSetFieldValue(this.imAddress, value);
083  }
084
085  /**
086   * Reads the text value from XML.
087   *
088   * @param reader accepts EwsServiceXmlReader
089   * @throws XMLStreamException the XML stream exception
090   * @throws ServiceXmlDeserializationException the service xml deserialization exception
091   */
092  @Override
093  public void readTextValueFromXml(EwsServiceXmlReader reader)
094      throws XMLStreamException, ServiceXmlDeserializationException {
095    this.imAddress = reader.readValue();
096  }
097
098  /**
099   * Writes elements to XML.
100   *
101   * @param writer The writer.
102   * @throws ServiceXmlSerializationException the service xml serialization exception
103   */
104  public void writeElementsToXml(EwsServiceXmlWriter writer)
105      throws ServiceXmlSerializationException {
106    writer.writeValue(this.imAddress, XmlElementNames.ImAddress);
107  }
108}