1f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* Licensed to the Apache Software Foundation (ASF) under one or more 2f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 3f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * this work for additional information regarding copyright ownership. 4f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 5f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * (the "License"); you may not use this file except in compliance with 6f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the License. You may obtain a copy of the License at 7f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 8f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 10f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * See the License for the specific language governing permissions and 14f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * limitations under the License. 15f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 16f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 17f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpackage java.nio.channels; 18f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 19f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport java.io.IOException; 20f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport java.nio.ByteBuffer; 21f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 22f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/** 23f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * A {@code WritableByteChannel} is a type of {@link Channel} that can write 24f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * bytes. 25f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <p> 26f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Write operations are synchronous on a {@code WritableByteChannel}, that is, 27f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if a write is already in progress on the channel then subsequent writes will 28f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * block until the first write completes. It is undefined whether non-write 29f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * operations will block. 30f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 31f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpublic interface WritableByteChannel extends Channel { 32f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 33f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 34f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Writes bytes from the given buffer to the channel. 35f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <p> 36f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * The maximum number of bytes that will be written is the 37f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>remaining()</code> number of bytes in the buffer when the method 38f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * invoked. The bytes will be written from the buffer starting at the 39f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * buffer's <code>position</code>. 40f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <p> 41f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * The call may block if other threads are also attempting to write on the 42f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * same channel. 43f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <p> 44f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Upon completion, the buffer's <code>position()</code> is updated to the 45f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * end of the bytes that were written. The buffer's <code>limit()</code> 46f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * is unmodified. 47d2510429e70ab91a04c67d5ca39b30f354eba221Jesse Wilson * 48f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param buffer 49f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the byte buffer containing the bytes to be written. 50f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the number of bytes actually written. 51f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws NonWritableChannelException 52f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if the channel was not opened for writing. 53f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws ClosedChannelException 54f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if the channel was already closed. 55f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws AsynchronousCloseException 56f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if another thread closes the channel during the write. 57f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws ClosedByInterruptException 58f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if another thread interrupt the calling thread during the 59f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * write. 60f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws IOException 61f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * another IO exception occurs, details are in the message. 62f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 63f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int write(ByteBuffer buffer) throws IOException; 64f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 65