|
1 /* |
|
2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
|
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 * |
|
5 * This code is free software; you can redistribute it and/or modify it |
|
6 * under the terms of the GNU General Public License version 2 only, as |
|
7 * published by the Free Software Foundation. Oracle designates this |
|
8 * particular file as subject to the "Classpath" exception as provided |
|
9 * by Oracle in the LICENSE file that accompanied this code. |
|
10 * |
|
11 * This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 * version 2 for more details (a copy is included in the LICENSE file that |
|
15 * accompanied this code). |
|
16 * |
|
17 * You should have received a copy of the GNU General Public License version |
|
18 * 2 along with this work; if not, write to the Free Software Foundation, |
|
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 * |
|
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 * or visit www.oracle.com if you need additional information or have any |
|
23 * questions. |
|
24 */ |
|
25 |
|
26 /* |
|
27 * @(#)MultipartDataSource.java 1.6 02/03/27 |
|
28 */ |
|
29 |
|
30 |
|
31 |
|
32 package com.sun.xml.internal.messaging.saaj.packaging.mime; |
|
33 |
|
34 import com.sun.xml.internal.messaging.saaj.packaging.mime.internet.MimeBodyPart; |
|
35 |
|
36 import javax.activation.DataSource; |
|
37 |
|
38 /** |
|
39 * MultipartDataSource is a <code>DataSource</code> that contains body |
|
40 * parts. This allows "mail aware" <code>DataContentHandlers</code> to |
|
41 * be implemented more efficiently by being aware of such |
|
42 * <code>DataSources</code> and using the appropriate methods to access |
|
43 * <code>BodyParts</code>. <p> |
|
44 * |
|
45 * Note that the data of a MultipartDataSource is also available as |
|
46 * an input stream. <p> |
|
47 * |
|
48 * This interface will typically be implemented by providers that |
|
49 * preparse multipart bodies, for example an IMAP provider. |
|
50 * |
|
51 * @version 1.6, 02/03/27 |
|
52 * @author John Mani |
|
53 * @see javax.activation.DataSource |
|
54 */ |
|
55 |
|
56 public interface MultipartDataSource extends DataSource { |
|
57 |
|
58 /** |
|
59 * Return the number of enclosed MimeBodyPart objects. |
|
60 * |
|
61 * @return number of parts |
|
62 */ |
|
63 public int getCount(); |
|
64 |
|
65 /** |
|
66 * Get the specified MimeBodyPart. Parts are numbered starting at 0. |
|
67 * |
|
68 * @param index the index of the desired MimeBodyPart |
|
69 * @return the MimeBodyPart |
|
70 * @exception IndexOutOfBoundsException if the given index |
|
71 * is out of range. |
|
72 * @exception MessagingException |
|
73 */ |
|
74 public MimeBodyPart getBodyPart(int index) throws MessagingException; |
|
75 |
|
76 } |