01: /* Licensed to the Apache Software Foundation (ASF) under one or more
02: * contributor license agreements. See the NOTICE file distributed with
03: * this work for additional information regarding copyright ownership.
04: * The ASF licenses this file to You under the Apache License, Version 2.0
05: * (the "License"); you may not use this file except in compliance with
06: * the License. You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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 WritableByteChannel is a type of Channel that can write bytes.
24: * <p>
25: * Writes are synchronous on a WritableByteChannel, that is, if a write is
26: * already in progress on the channel then subsequent writes will block until
27: * the first write completes. It is undefined whether non-write operations will
28: * block.
29: */
30: public interface WritableByteChannel extends Channel {
31:
32: /**
33: * Writes bytes from the given buffer to the channel.
34: * <p>
35: * The maximum number of bytes that will be written is the
36: * <code>remaining()</code> number of bytes in the buffer when the method
37: * invoked. The bytes will be written from the buffer starting at the
38: * buffer's <code>position</code>.
39: * </p>
40: * <p>
41: * The call may block if other threads are also attempting to write on the
42: * same channel.
43: * </p>
44: * <p>
45: * Upon completion, the buffer's <code>position()</code> is updated to the
46: * end of the bytes that were written. The buffer's <code>limit()</code>
47: * is unmodified.
48: * </p>
49: *
50: * @param buffer
51: * the byte buffer containing the bytes to be written.
52: * @return the number of bytes actually written.
53: * @throws NonWritableChannelException
54: * if the channel was not opened for writing.
55: * @throws ClosedChannelException
56: * if the channel was already closed.
57: * @throws AsynchronousCloseException
58: * if another thread closes the channel during the write.
59: * @throws ClosedByInterruptException
60: * if another thread interrupt the calling thread during the
61: * write.
62: * @throws IOException
63: * another IO exception occurs, details are in the message.
64: */
65: public int write(ByteBuffer buffer) throws IOException;
66: }
|