ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.api.message;
ohair@286: 
ohair@286: import com.sun.istack.internal.Nullable;
ohair@286: 
ohair@286: /**
ohair@286:  * A set of {@link Attachment} on a {@link Message}.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * A particular attention is made to ensure that attachments
ohair@286:  * can be read and parsed lazily as requested.
ohair@286:  *
ohair@286:  * @see Message#getAttachments()
ohair@286:  */
ohair@286: public interface AttachmentSet extends Iterable<Attachment> {
ohair@286:     /**
ohair@286:      * Gets the attachment by the content ID.
ohair@286:      *
ohair@286:      * @param contentId
ohair@286:      *      The content ID like "foo-bar-zot@abc.com", without
ohair@286:      *      surrounding '&lt;' and '>' used as the transfer syntax.
ohair@286:      *
ohair@286:      * @return null
ohair@286:      *      if no such attachment exist.
ohair@286:      */
ohair@286:     @Nullable
ohair@286:     Attachment get(String contentId);
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns true if there's no attachment.
ohair@286:      */
ohair@286:     boolean isEmpty();
ohair@286: 
ohair@286:     /**
ohair@286:      * Adds an attachment to this set.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * Note that it's OK for an {@link Attachment} to belong to
ohair@286:      * more than one {@link AttachmentSet} (which is in fact
ohair@286:      * necessary when you wrap a {@link Message} into another.
ohair@286:      *
ohair@286:      * @param att
ohair@286:      *      must not be null.
ohair@286:      */
ohair@286:     public void add(Attachment att);
ohair@286: 
ohair@286: }