Showing the changes to java/pkg/sun/nio/ByteBuffered.java (1 of 18352 files). Show all
Unified · Split
| @@ -0,0 +1,58 @@ | ||
| 1 | +/* | |
| 2 | + * Copyright (c) 2003, 2006, 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 | +package sun.nio; | |
| 27 | + | |
| 28 | +import java.nio.ByteBuffer; | |
| 29 | +import java.io.IOException; | |
| 30 | + | |
| 31 | +/** This is an interface to adapt existing APIs to use {@link java.nio.ByteBuffer | |
| 32 | + * <tt>ByteBuffers</tt>} as the underlying | |
| 33 | + * data format. Only the initial producer and final consumer have to be changed.<p> | |
| 34 | + * | |
| 35 | + * For example, the Zip/Jar code supports {@link java.io.InputStream <tt>InputStreams</tt>}. | |
| 36 | + * To make the Zip code use {@link java.nio.MappedByteBuffer <tt>MappedByteBuffers</tt>} as | |
| 37 | + * the underlying data structure, it can create a class of InputStream that wraps the ByteBuffer, | |
| 38 | + * and implements the ByteBuffered interface. A co-operating class several layers | |
| 39 | + * away can ask the InputStream if it is an instance of ByteBuffered, then | |
| 40 | + * call the {@link #getByteBuffer()} method. | |
| 41 | + */ | |
| 42 | +public interface ByteBuffered { | |
| 43 | + | |
| 44 | + /** | |
| 45 | + * Returns the <tt>ByteBuffer</tt> behind this object, if this particular | |
| 46 | + * instance has one. An implementation of <tt>getByteBuffer()</tt> is allowed | |
| 47 | + * to return <tt>null</tt> for any reason. | |
| 48 | + * | |
| 49 | + * @return The <tt>ByteBuffer</tt>, if this particular instance has one, | |
| 50 | + * or <tt>null</tt> otherwise. | |
| 51 | + * | |
| 52 | + * @throws IOException | |
| 53 | + * If the ByteBuffer is no longer valid. | |
| 54 | + * | |
| 55 | + * @since 1.5 | |
| 56 | + */ | |
| 57 | + public ByteBuffer getByteBuffer() throws IOException; | |
| 58 | +} | |