com.sun.xml.ws.api.message.AttachmentSet Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://glassfish.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems Inc. All Rights Reserved
*/
package com.sun.xml.ws.api.message;
import com.sun.istack.Nullable;
/**
* A set of {@link Attachment} on a {@link Message}.
*
*
* A particular attention is made to ensure that attachments
* can be read and parsed lazily as requested.
*
* @see Message#getAttachments()
*/
public interface AttachmentSet extends Iterable {
/**
* Gets the attachment by the content ID.
*
* @param contentId
* The content ID like "[email protected]", without
* surrounding '<' and '>' used as the transfer syntax.
*
* @return null
* if no such attachment exist.
*/
@Nullable
Attachment get(String contentId);
/**
* Returns true if there's no attachment.
*/
boolean isEmpty();
/**
* Adds an attachment to this set.
*
*
* Note that it's OK for an {@link Attachment} to belong to
* more than one {@link AttachmentSet} (which is in fact
* necessary when you wrap a {@link Message} into another.
*
* @param att
* must not be null.
*/
public void add(Attachment att);
}