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