BaseStream.java revision 3998bf009acaf8cde4d7f837f8b8e41ae0a65141 
1/*
2 * Copyright (c) 2008-2009, Motorola, Inc.
3 *
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * - Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * - Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * - Neither the name of the Motorola, Inc. nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33package javax.obex;
34
35import java.io.IOException;
36
37/**
38 * This interface defines the methods needed by a parent that uses the
39 * PrivateInputStream and PrivateOutputStream objects defined in this package.
40 *
41 * @hide
42 */
43public interface BaseStream {
44
45    /**
46     * Verifies that this object is still open.
47     *
48     * @throws IOException if the object is closed
49     */
50    void ensureOpen() throws IOException;
51
52    /**
53     * Verifies that additional information may be sent.  In other words, the
54     * operation is not done.
55     *
56     * @throws IOException if the operation is completed
57     */
58    void ensureNotDone() throws IOException;
59
60    /**
61     * Continues the operation since there is no data to read.
62     *
63     * @param sendEmpty <code>true</code> if the operation should send an
64     * empty packet or not send anything if there is no data to send
65     * @param inStream  <code>true</code> if the stream is input stream or
66     * is output stream
67     * @return <code>true</code> if the operation was completed;
68     * <code>false</code> if no operation took place
69     *
70     * @throws IOException if an IO error occurs
71     */
72    boolean continueOperation(boolean sendEmpty, boolean inStream) throws IOException;
73
74    /**
75     * Called when the output or input stream is closed.
76     *
77     * @param inStream <code>true</code> if the input stream is closed;
78     * <code>false</code> if the output stream is closed
79     *
80     * @throws IOException if an IO error occurs
81     */
82    void streamClosed(boolean inStream) throws IOException;
83}
84