01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36: package com.sun.xml.ws.api.message;
37:
38: import com.sun.istack.Nullable;
39:
40: /**
41: * A set of {@link Attachment} on a {@link Message}.
42: *
43: * <p>
44: * A particular attention is made to ensure that attachments
45: * can be read and parsed lazily as requested.
46: *
47: * @see Message#getAttachments()
48: */
49: public interface AttachmentSet extends Iterable<Attachment> {
50: /**
51: * Gets the attachment by the content ID.
52: *
53: * @param contentId
54: * The content ID like "foo-bar-zot@abc.com", without
55: * surrounding '<' and '>' used as the transfer syntax.
56: *
57: * @return null
58: * if no such attachment exist.
59: */
60: @Nullable
61: Attachment get(String contentId);
62:
63: /**
64: * Returns true if there's no attachment.
65: */
66: boolean isEmpty();
67:
68: /**
69: * Adds an attachment to this set.
70: *
71: * <p>
72: * Note that it's OK for an {@link Attachment} to belong to
73: * more than one {@link AttachmentSet} (which is in fact
74: * necessary when you wrap a {@link Message} into another.
75: *
76: * @param att
77: * must not be null.
78: */
79: public void add(Attachment att);
80:
81: }
|