Package: FetchItem
FetchItem
name | instruction | branch | complexity | line | method | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
FetchItem(String, FetchProfile.Item) |
|
|
|
|
|
||||||||||||||||||||
getFetchProfileItem() |
|
|
|
|
|
||||||||||||||||||||
getName() |
|
|
|
|
|
Coverage
1: /*
2: * Copyright (c) 1997, 2023 Oracle and/or its affiliates. All rights reserved.
3: *
4: * This program and the accompanying materials are made available under the
5: * terms of the Eclipse Public License v. 2.0, which is available at
6: * http://www.eclipse.org/legal/epl-2.0.
7: *
8: * This Source Code may also be made available under the following Secondary
9: * Licenses when the conditions for such availability set forth in the
10: * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
11: * version 2 with the GNU Classpath Exception, which is available at
12: * https://www.gnu.org/software/classpath/license.html.
13: *
14: * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15: */
16:
17: package org.eclipse.angus.mail.imap.protocol;
18:
19: import jakarta.mail.FetchProfile;
20: import org.eclipse.angus.mail.iap.ParsingException;
21:
22: /**
23: * Metadata describing a FETCH item.
24: * Note that the "name" field MUST be in uppercase. <p>
25: *
26: * @author Bill Shannon
27: * @since JavaMail 1.4.6
28: */
29:
30: public abstract class FetchItem {
31: private String name;
32: private FetchProfile.Item fetchProfileItem;
33:
34: public FetchItem(String name, FetchProfile.Item fetchProfileItem) {
35:         this.name = name;
36:         this.fetchProfileItem = fetchProfileItem;
37: }
38:
39: public String getName() {
40:         return name;
41: }
42:
43: public FetchProfile.Item getFetchProfileItem() {
44:         return fetchProfileItem;
45: }
46:
47: /**
48: * Parse the item into some kind of object appropriate for the item.
49: * Note that the item name will have been parsed and skipped already.
50: *
51: * @param        r        the response
52: * @return                the fetch item
53: * @exception ParsingException for parsing failures
54: */
55: public abstract Object parseItem(FetchResponse r) throws ParsingException;
56: }