Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaf_classes/javax/activation/DataContentHandler.java@f3d512b73229 (annotated)
src/share/jaf_classes/javax/activation/DataContentHandler.java
Mon, 08 Aug 2016 13:10:38 -0700
- author
- asaha
- date
- Mon, 08 Aug 2016 13:10:38 -0700
- changeset 1267
- f3d512b73229
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
Merge
| 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.awt.datatransfer.DataFlavor; |
| aoqi@0 | 29 | import java.awt.datatransfer.UnsupportedFlavorException; |
| aoqi@0 | 30 | import java.io.InputStream; |
| aoqi@0 | 31 | import java.io.IOException; |
| aoqi@0 | 32 | import java.io.OutputStream; |
| aoqi@0 | 33 | import javax.activation.DataSource; |
| aoqi@0 | 34 | |
| aoqi@0 | 35 | /** |
| aoqi@0 | 36 | * The DataContentHandler interface is implemented by objects that can |
| aoqi@0 | 37 | * be used to extend the capabilities of the DataHandler's implementation |
| aoqi@0 | 38 | * of the Transferable interface. Through <code>DataContentHandlers</code> |
| aoqi@0 | 39 | * the framework can be extended to convert streams in to objects, and |
| aoqi@0 | 40 | * to write objects to streams. <p> |
| aoqi@0 | 41 | * |
| aoqi@0 | 42 | * Applications don't generally call the methods in DataContentHandlers |
| aoqi@0 | 43 | * directly. Instead, an application calls the equivalent methods in |
| aoqi@0 | 44 | * DataHandler. The DataHandler will attempt to find an appropriate |
| aoqi@0 | 45 | * DataContentHandler that corresponds to its MIME type using the |
| aoqi@0 | 46 | * current DataContentHandlerFactory. The DataHandler then calls |
| aoqi@0 | 47 | * through to the methods in the DataContentHandler. |
| aoqi@0 | 48 | * |
| aoqi@0 | 49 | * @since 1.6 |
| aoqi@0 | 50 | */ |
| aoqi@0 | 51 | |
| aoqi@0 | 52 | public interface DataContentHandler { |
| aoqi@0 | 53 | /** |
| aoqi@0 | 54 | * Returns an array of DataFlavor objects indicating the flavors the |
| aoqi@0 | 55 | * data can be provided in. The array should be ordered according to |
| aoqi@0 | 56 | * preference for providing the data (from most richly descriptive to |
| aoqi@0 | 57 | * least descriptive). |
| aoqi@0 | 58 | * |
| aoqi@0 | 59 | * @return The DataFlavors. |
| aoqi@0 | 60 | */ |
| aoqi@0 | 61 | public DataFlavor[] getTransferDataFlavors(); |
| aoqi@0 | 62 | |
| aoqi@0 | 63 | /** |
| aoqi@0 | 64 | * Returns an object which represents the data to be transferred. |
| aoqi@0 | 65 | * The class of the object returned is defined by the representation class |
| aoqi@0 | 66 | * of the flavor. |
| aoqi@0 | 67 | * |
| aoqi@0 | 68 | * @param df The DataFlavor representing the requested type. |
| aoqi@0 | 69 | * @param ds The DataSource representing the data to be converted. |
| aoqi@0 | 70 | * @return The constructed Object. |
| aoqi@0 | 71 | * @exception UnsupportedFlavorException if the handler doesn't |
| aoqi@0 | 72 | * support the requested flavor |
| aoqi@0 | 73 | * @exception IOException if the data can't be accessed |
| aoqi@0 | 74 | */ |
| aoqi@0 | 75 | public Object getTransferData(DataFlavor df, DataSource ds) |
| aoqi@0 | 76 | throws UnsupportedFlavorException, IOException; |
| aoqi@0 | 77 | |
| aoqi@0 | 78 | /** |
| aoqi@0 | 79 | * Return an object representing the data in its most preferred form. |
| aoqi@0 | 80 | * Generally this will be the form described by the first DataFlavor |
| aoqi@0 | 81 | * returned by the <code>getTransferDataFlavors</code> method. |
| aoqi@0 | 82 | * |
| aoqi@0 | 83 | * @param ds The DataSource representing the data to be converted. |
| aoqi@0 | 84 | * @return The constructed Object. |
| aoqi@0 | 85 | * @exception IOException if the data can't be accessed |
| aoqi@0 | 86 | */ |
| aoqi@0 | 87 | public Object getContent(DataSource ds) throws IOException; |
| aoqi@0 | 88 | |
| aoqi@0 | 89 | /** |
| aoqi@0 | 90 | * Convert the object to a byte stream of the specified MIME type |
| aoqi@0 | 91 | * and write it to the output stream. |
| aoqi@0 | 92 | * |
| aoqi@0 | 93 | * @param obj The object to be converted. |
| aoqi@0 | 94 | * @param mimeType The requested MIME type of the resulting byte stream. |
| aoqi@0 | 95 | * @param os The output stream into which to write the converted |
| aoqi@0 | 96 | * byte stream. |
| aoqi@0 | 97 | * @exception IOException errors writing to the stream |
| aoqi@0 | 98 | */ |
| aoqi@0 | 99 | public void writeTo(Object obj, String mimeType, OutputStream os) |
| aoqi@0 | 100 | throws IOException; |
| aoqi@0 | 101 | } |
