src/share/jaxws_classes/com/sun/xml/internal/ws/api/message/AttachmentSet.java

Wed, 12 Jun 2013 14:47:09 +0100

author
mkos
date
Wed, 12 Jun 2013 14:47:09 +0100
changeset 384
8f2986ff0235
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8013021: Rebase 8005432 & 8003542 against the latest jdk8/jaxws
8003542: Improve processing of MTOM attachments
8005432: Update access to JAX-WS
Reviewed-by: mullan

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

mercurial