Wed, 27 Apr 2016 15:32:20 -0700
Added tag jdk8u102-b05 for changeset 1f512419ae33
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2005, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package javax.activation; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.io.InputStream; |
aoqi@0 | 29 | import java.io.OutputStream; |
aoqi@0 | 30 | import java.io.IOException; |
aoqi@0 | 31 | |
aoqi@0 | 32 | /** |
aoqi@0 | 33 | * The DataSource interface provides the JavaBeans Activation Framework |
aoqi@0 | 34 | * with an abstraction of an arbitrary collection of data. It |
aoqi@0 | 35 | * provides a type for that data as well as access |
aoqi@0 | 36 | * to it in the form of <code>InputStreams</code> and |
aoqi@0 | 37 | * <code>OutputStreams</code> where appropriate. |
aoqi@0 | 38 | * |
aoqi@0 | 39 | * @since 1.6 |
aoqi@0 | 40 | */ |
aoqi@0 | 41 | |
aoqi@0 | 42 | public interface DataSource { |
aoqi@0 | 43 | |
aoqi@0 | 44 | /** |
aoqi@0 | 45 | * This method returns an <code>InputStream</code> representing |
aoqi@0 | 46 | * the data and throws the appropriate exception if it can |
aoqi@0 | 47 | * not do so. Note that a new <code>InputStream</code> object must be |
aoqi@0 | 48 | * returned each time this method is called, and the stream must be |
aoqi@0 | 49 | * positioned at the beginning of the data. |
aoqi@0 | 50 | * |
aoqi@0 | 51 | * @return an InputStream |
aoqi@0 | 52 | */ |
aoqi@0 | 53 | public InputStream getInputStream() throws IOException; |
aoqi@0 | 54 | |
aoqi@0 | 55 | /** |
aoqi@0 | 56 | * This method returns an <code>OutputStream</code> where the |
aoqi@0 | 57 | * data can be written and throws the appropriate exception if it can |
aoqi@0 | 58 | * not do so. Note that a new <code>OutputStream</code> object must |
aoqi@0 | 59 | * be returned each time this method is called, and the stream must |
aoqi@0 | 60 | * be positioned at the location the data is to be written. |
aoqi@0 | 61 | * |
aoqi@0 | 62 | * @return an OutputStream |
aoqi@0 | 63 | */ |
aoqi@0 | 64 | public OutputStream getOutputStream() throws IOException; |
aoqi@0 | 65 | |
aoqi@0 | 66 | /** |
aoqi@0 | 67 | * This method returns the MIME type of the data in the form of a |
aoqi@0 | 68 | * string. It should always return a valid type. It is suggested |
aoqi@0 | 69 | * that getContentType return "application/octet-stream" if the |
aoqi@0 | 70 | * DataSource implementation can not determine the data type. |
aoqi@0 | 71 | * |
aoqi@0 | 72 | * @return the MIME Type |
aoqi@0 | 73 | */ |
aoqi@0 | 74 | public String getContentType(); |
aoqi@0 | 75 | |
aoqi@0 | 76 | /** |
aoqi@0 | 77 | * Return the <i>name</i> of this object where the name of the object |
aoqi@0 | 78 | * is dependant on the nature of the underlying objects. DataSources |
aoqi@0 | 79 | * encapsulating files may choose to return the filename of the object. |
aoqi@0 | 80 | * (Typically this would be the last component of the filename, not an |
aoqi@0 | 81 | * entire pathname.) |
aoqi@0 | 82 | * |
aoqi@0 | 83 | * @return the name of the object. |
aoqi@0 | 84 | */ |
aoqi@0 | 85 | public String getName(); |
aoqi@0 | 86 | } |