1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 /*
38 * @(#)MultipartDataSource.java 1.8 07/05/04
39 */
40
41 package javax.mail;
42
43 import java.util.Vector;
44 import java.io.InputStream;
45 import java.io.OutputStream;
46 import java.io.IOException;
47 import javax.activation.DataSource;
48
49 /**
50 * MultipartDataSource is a <code>DataSource</code> that contains body
51 * parts. This allows "mail aware" <code>DataContentHandlers</code> to
52 * be implemented more efficiently by being aware of such
53 * <code>DataSources</code> and using the appropriate methods to access
54 * <code>BodyParts</code>. <p>
55 *
56 * Note that the data of a MultipartDataSource is also available as
57 * an input stream. <p>
58 *
59 * This interface will typically be implemented by providers that
60 * preparse multipart bodies, for example an IMAP provider.
61 *
62 * @version 1.8, 07/05/04
63 * @author John Mani
64 * @see javax.activation.DataSource
65 */
66
67 public interface MultipartDataSource extends DataSource {
68
69 /**
70 * Return the number of enclosed BodyPart objects.
71 *
72 * @return number of parts
73 */
74 public int getCount();
75
76 /**
77 * Get the specified Part. Parts are numbered starting at 0.
78 *
79 * @param index the index of the desired Part
80 * @return the Part
81 * @exception IndexOutOfBoundsException if the given index
82 * is out of range.
83 * @exception MessagingException
84 */
85 public BodyPart getBodyPart(int index) throws MessagingException;
86
87 }