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