-
Notifications
You must be signed in to change notification settings - Fork 553
/
FolderId.java
277 lines (251 loc) · 7.75 KB
/
FolderId.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
/*
* 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.EwsServiceXmlWriter;
import microsoft.exchange.webservices.data.core.EwsUtilities;
import microsoft.exchange.webservices.data.core.XmlAttributeNames;
import microsoft.exchange.webservices.data.core.XmlElementNames;
import microsoft.exchange.webservices.data.core.enumeration.misc.ExchangeVersion;
import microsoft.exchange.webservices.data.core.enumeration.property.WellKnownFolderName;
import microsoft.exchange.webservices.data.core.exception.service.local.ServiceVersionException;
import microsoft.exchange.webservices.data.core.exception.service.local.ServiceXmlSerializationException;
/**
* Represents the Id of a folder.
*/
public final class FolderId extends ServiceId {
/**
* The folder name.
*/
private WellKnownFolderName folderName;
/**
* The mailbox.
*/
private Mailbox mailbox;
/**
* Initializes a new instance.
*/
public FolderId() {
super();
}
/**
* Initializes a new instance.Use this constructor to link this FolderId to
* an existing folder that you have the unique Id of.
*
* @param uniqueId the unique id
* @throws Exception the exception
*/
public FolderId(String uniqueId) throws Exception {
super(uniqueId);
}
/**
* Initializes a new instance.Use this constructor to link this FolderId to
* a well known folder (e.g. Inbox, Calendar or Contacts)
*
* @param folderName the folder name
*/
public FolderId(WellKnownFolderName folderName) {
super();
this.folderName = folderName;
}
/**
* Initializes a new instance.Use this constructor to link this FolderId to
* a well known folder (e.g. Inbox, Calendar or Contacts) in a specific
* mailbox.
*
* @param folderName the folder name
* @param mailbox the mailbox
*/
public FolderId(WellKnownFolderName folderName, Mailbox mailbox) {
this(folderName);
this.mailbox = mailbox;
}
/**
* Gets the name of the XML element.
*
* @return XML element name
*/
public String getXmlElementName() {
if (this.getFolderName() != null) {
return XmlElementNames.DistinguishedFolderId;
} else {
return XmlElementNames.FolderId;
}
}
/**
* Writes attribute to XML.
*
* @param writer the writer
* @throws ServiceXmlSerializationException the service xml serialization exception
*/
public void writeAttributesToXml(EwsServiceXmlWriter writer)
throws ServiceXmlSerializationException {
if (this.getFolderName() != null) {
writer.writeAttributeValue(XmlAttributeNames.Id, this
.getFolderName().toString().toLowerCase());
if (this.mailbox != null) {
try {
this.mailbox.writeToXml(writer, XmlElementNames.Mailbox);
} catch (Exception e) {
throw new ServiceXmlSerializationException(e.getMessage());
}
}
} else {
super.writeAttributesToXml(writer);
}
}
/**
* Validates FolderId against a specified request version.
*
* @param version the version
* @throws ServiceVersionException the service version exception
*/
public void validate(ExchangeVersion version)
throws ServiceVersionException {
// The FolderName property is a WellKnownFolderName, an enumeration
// type. If the property
// is set, make sure that the value is valid for the request version.
if (this.getFolderName() != null) {
EwsUtilities
.validateEnumVersionValue(this.getFolderName(), version);
}
}
/**
* Gets the name of the folder associated with the folder Id. Name and Id
* are mutually exclusive; if one is set, the other is null.
*
* @return the folder name
*/
public WellKnownFolderName getFolderName() {
return this.folderName;
}
/**
* Gets the mailbox of the folder. Mailbox is only set when FolderName is
* set.
*
* @return the mailbox
*/
public Mailbox getMailbox() {
return this.mailbox;
}
/**
* Defines an implicit conversion between string and FolderId.
*
* @param uniqueId the unique id
* @return A FolderId initialized with the specified unique Id
* @throws Exception the exception
*/
public static FolderId getFolderIdFromString(String uniqueId)
throws Exception {
return new FolderId(uniqueId);
}
/**
* Defines an implicit conversion between WellKnownFolderName and FolderId.
*
* @param folderName the folder name
* @return A FolderId initialized with the specified folder name
*/
public static FolderId getFolderIdFromWellKnownFolderName(
WellKnownFolderName folderName) {
return new FolderId(folderName);
}
/**
* True if this instance is valid, false otherwise.
*
* @return the checks if is valid
*/
protected boolean getIsValid() {
if (this.folderName != null) {
return (this.mailbox == null) || this.mailbox.isValid();
} else {
return super.isValid();
}
}
/**
* Determines whether the specified is equal to the current.
*
* @param obj the obj
* @return true if the specified is equal to the current
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
} else if (obj instanceof FolderId) {
FolderId other = (FolderId) obj;
if (this.folderName != null) {
if (other.folderName != null
&& this.folderName.equals(other.folderName)) {
if (this.mailbox != null) {
return this.mailbox.equals(other.mailbox);
} else if (other.mailbox == null) {
return true;
}
}
} else if (super.equals(other)) {
return true;
}
return false;
} else {
return false;
}
}
/**
* Serves as a hash function for a particular type.
*
* @return A hash code for the current
*/
@Override
public int hashCode() {
int hashCode;
if (this.folderName != null) {
hashCode = this.folderName.hashCode();
if ((this.mailbox != null) && this.mailbox.isValid()) {
hashCode = hashCode ^ this.mailbox.hashCode();
}
} else {
hashCode = super.hashCode();
}
return hashCode;
}
/**
* Returns a String that represents the current Object.
*
* @return the string
*/
public String toString() {
if (this.isValid()) {
if (this.folderName != null) {
if ((this.mailbox != null) && mailbox.isValid()) {
return String.format("%s,(%s)", this.folderName,
this.mailbox.toString());
} else {
return this.folderName.toString();
}
} else {
return super.toString();
}
} else {
return "";
}
}
}