1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * 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
17package android.bluetooth;
18
19import java.io.IOException;
20import java.io.OutputStream;
21
22/**
23 * BluetoothOutputStream.
24 *
25 * Used to read from a Bluetooth socket.
26 *
27 * @hide
28 */
29/*package*/ final class BluetoothOutputStream extends OutputStream {
30    private BluetoothSocket mSocket;
31
32    /*package*/ BluetoothOutputStream(BluetoothSocket s) {
33        mSocket = s;
34    }
35
36    /**
37     * Close this output stream and the socket associated with it.
38     */
39    public void close() throws IOException {
40        mSocket.close();
41    }
42
43    /**
44     * Writes a single byte to this stream. Only the least significant byte of
45     * the integer {@code oneByte} is written to the stream.
46     *
47     * @param oneByte the byte to be written.
48     * @throws IOException if an error occurs while writing to this stream.
49     * @since Android 1.0
50     */
51    public void write(int oneByte) throws IOException {
52        byte[] b = new byte[1];
53        b[0] = (byte) oneByte;
54        mSocket.write(b, 0, 1);
55    }
56
57    /**
58     * Writes {@code count} bytes from the byte array {@code buffer} starting
59     * at position {@code offset} to this stream.
60     *
61     * @param b the buffer to be written.
62     * @param offset the start position in {@code buffer} from where to get bytes.
63     * @param count the number of bytes from {@code buffer} to write to this stream.
64     * @throws IOException if an error occurs while writing to this stream.
65     * @throws IndexOutOfBoundsException if {@code offset < 0} or {@code count < 0}, or if {@code
66     * offset + count} is bigger than the length of {@code buffer}.
67     * @since Android 1.0
68     */
69    public void write(byte[] b, int offset, int count) throws IOException {
70        if (b == null) {
71            throw new NullPointerException("buffer is null");
72        }
73        if ((offset | count) < 0 || count > b.length - offset) {
74            throw new IndexOutOfBoundsException("invalid offset or length");
75        }
76        mSocket.write(b, offset, count);
77    }
78
79    /**
80     * Wait until the data in sending queue is emptied. A polling version
81     * for flush implementation. Use it to ensure the writing data afterwards will
82     * be packed in the new RFCOMM frame.
83     *
84     * @throws IOException if an i/o error occurs.
85     * @since Android 4.2.3
86     */
87    public void flush() throws IOException {
88        mSocket.flush();
89    }
90}
91