com.sun.xml.messaging.saaj.packaging.mime.MultipartDataSource Maven / Gradle / Ivy
Show all versions of saaj-impl Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2016 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* @(#)MultipartDataSource.java 1.6 02/03/27
*/
package com.sun.xml.messaging.saaj.packaging.mime;
import com.sun.xml.messaging.saaj.packaging.mime.internet.MimeBodyPart;
import javax.activation.DataSource;
/**
* MultipartDataSource is a DataSource that contains body
* parts. This allows "mail aware" DataContentHandlers to
* be implemented more efficiently by being aware of such
* DataSources and using the appropriate methods to access
* BodyParts.
*
* Note that the data of a MultipartDataSource is also available as
* an input stream.
*
* This interface will typically be implemented by providers that
* preparse multipart bodies, for example an IMAP provider.
*
* @version 1.6, 02/03/27
* @author John Mani
* @see javax.activation.DataSource
*/
public interface MultipartDataSource extends DataSource {
/**
* Return the number of enclosed MimeBodyPart objects.
*
* @return number of parts
*/
public int getCount();
/**
* Get the specified MimeBodyPart. Parts are numbered starting at 0.
*
* @param index the index of the desired MimeBodyPart
* @return the MimeBodyPart
* @exception IndexOutOfBoundsException if the given index
* is out of range.
* @exception MessagingException thrown in case of error
*/
public MimeBodyPart getBodyPart(int index) throws MessagingException;
}