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.enumeration.attribute.EditorBrowsableState;
028import microsoft.exchange.webservices.data.core.enumeration.property.PhysicalAddressKey;
029import microsoft.exchange.webservices.data.misc.OutParam;
030
031/**
032 * Represents a dictionary of physical addresses.
033 */
034@EditorBrowsable(state = EditorBrowsableState.Never)
035public final class PhysicalAddressDictionary extends
036                                             DictionaryProperty<PhysicalAddressKey, PhysicalAddressEntry> {
037
038  /**
039   * Creates instance of dictionary entry.
040   *
041   * @return New instance.
042   */
043  @Override
044  protected PhysicalAddressEntry createEntryInstance() {
045    return new PhysicalAddressEntry();
046  }
047
048  /**
049   * Gets  the physical address at the specified key.
050   *
051   * @param key the key
052   * @return The physical address at the specified key.
053   */
054  public PhysicalAddressEntry getPhysicalAddress(PhysicalAddressKey key) {
055    return this.getEntries().get(key);
056  }
057
058  /**
059   * Sets the physical address.
060   *
061   * @param key   the key
062   * @param value the value
063   */
064  public void setPhysicalAddress(PhysicalAddressKey key,
065      PhysicalAddressEntry value) {
066    if (value == null) {
067      this.internalRemove(key);
068    } else {
069      value.setKey(key);
070      this.internalAddOrReplace(value);
071    }
072  }
073
074  /**
075   * Tries to get the physical address associated with the specified key.
076   *
077   * @param key      the key
078   * @param outparam the outparam
079   * @return true if the Dictionary contains a physical address associated
080   * with the specified key; otherwise, false.
081   */
082  public boolean tryGetValue(PhysicalAddressKey key,
083      OutParam<PhysicalAddressEntry> outparam) {
084    if (this.getEntries().containsKey(key)) {
085      outparam.setParam(this.getEntries().get(key));
086    }
087    return this.getEntries().containsKey(key);
088  }
089
090}