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
024 package microsoft.exchange.webservices.data.property.complex;
025
026 import microsoft.exchange.webservices.data.attribute.EditorBrowsable;
027 import microsoft.exchange.webservices.data.core.enumeration.attribute.EditorBrowsableState;
028 import microsoft.exchange.webservices.data.core.enumeration.property.ImAddressKey;
029 import microsoft.exchange.webservices.data.misc.OutParam;
030
031 /**
032 * Represents a dictionary of Instant Messaging addresses.
033 */
034 @EditorBrowsable(state = EditorBrowsableState.Never)
035 public final class ImAddressDictionary extends DictionaryProperty<ImAddressKey, ImAddressEntry> {
036
037 /**
038 * Gets the field URI.
039 *
040 * @return Field URI.
041 */
042 @Override
043 protected String getFieldURI() {
044 return "contacts:ImAddress";
045 }
046
047 /**
048 * Creates instance of dictionary entry.
049 *
050 * @return New instance.
051 */
052 @Override
053 protected ImAddressEntry createEntryInstance() {
054 return new ImAddressEntry();
055 }
056
057 /**
058 * Gets the Instant Messaging address at the specified key.
059 *
060 * @param key the key
061 * @return The Instant Messaging address at the specified key.
062 */
063 public String getImAddressKey(ImAddressKey key) {
064 return this.getEntries().get(key).getImAddress();
065 }
066
067 /**
068 * Sets the im address key.
069 *
070 * @param key the key
071 * @param value the value
072 */
073 public void setImAddressKey(ImAddressKey key, String value) {
074 if (value == null) {
075 this.internalRemove(key);
076 } else {
077 ImAddressEntry entry;
078
079 if (this.getEntries().containsKey(key)) {
080 entry = this.getEntries().get(key);
081 entry.setImAddress(value);
082 this.changed();
083 } else {
084 entry = new ImAddressEntry(key, value);
085 this.internalAdd(entry);
086 }
087 }
088 }
089
090 /**
091 * Tries to get the IM address associated with the specified key.
092 *
093 * @param key the key
094 * @param outParam the out param
095 * @return true if the Dictionary contains an IM address associated with the
096 * specified key; otherwise, false.
097 */
098 public boolean tryGetValue(ImAddressKey key, OutParam<String> outParam) {
099 ImAddressEntry entry = null;
100
101 if (this.getEntries().containsKey(key)) {
102 entry = this.getEntries().get(key);
103 outParam.setParam(entry.getImAddress());
104
105 return true;
106 } else {
107 outParam = null;
108 return false;
109 }
110 }
111 }