Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.ws.api.message; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import com.sun.istack.internal.Nullable; |
aoqi@0 | 29 | |
aoqi@0 | 30 | /** |
aoqi@0 | 31 | * A set of {@link Attachment} on a {@link Message}. |
aoqi@0 | 32 | * |
aoqi@0 | 33 | * <p> |
aoqi@0 | 34 | * A particular attention is made to ensure that attachments |
aoqi@0 | 35 | * can be read and parsed lazily as requested. |
aoqi@0 | 36 | * |
aoqi@0 | 37 | * @see Message#getAttachments() |
aoqi@0 | 38 | */ |
aoqi@0 | 39 | public interface AttachmentSet extends Iterable<Attachment> { |
aoqi@0 | 40 | /** |
aoqi@0 | 41 | * Gets the attachment by the content ID. |
aoqi@0 | 42 | * |
aoqi@0 | 43 | * @param contentId |
aoqi@0 | 44 | * The content ID like "foo-bar-zot@abc.com", without |
aoqi@0 | 45 | * surrounding '<' and '>' used as the transfer syntax. |
aoqi@0 | 46 | * |
aoqi@0 | 47 | * @return null |
aoqi@0 | 48 | * if no such attachment exist. |
aoqi@0 | 49 | */ |
aoqi@0 | 50 | @Nullable |
aoqi@0 | 51 | Attachment get(String contentId); |
aoqi@0 | 52 | |
aoqi@0 | 53 | /** |
aoqi@0 | 54 | * Returns true if there's no attachment. |
aoqi@0 | 55 | */ |
aoqi@0 | 56 | boolean isEmpty(); |
aoqi@0 | 57 | |
aoqi@0 | 58 | /** |
aoqi@0 | 59 | * Adds an attachment to this set. |
aoqi@0 | 60 | * |
aoqi@0 | 61 | * <p> |
aoqi@0 | 62 | * Note that it's OK for an {@link Attachment} to belong to |
aoqi@0 | 63 | * more than one {@link AttachmentSet} (which is in fact |
aoqi@0 | 64 | * necessary when you wrap a {@link Message} into another. |
aoqi@0 | 65 | * |
aoqi@0 | 66 | * @param att |
aoqi@0 | 67 | * must not be null. |
aoqi@0 | 68 | */ |
aoqi@0 | 69 | public void add(Attachment att); |
aoqi@0 | 70 | |
aoqi@0 | 71 | } |