sdk/sources/android-25/javax/obex/BaseStream.java

   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
  33 package javax.obex;
  34
  35 import 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  * @hide
  41  */
  42 public interface BaseStream {
  43
  44     /**
  45      * Verifies that this object is still open.
  46      * @throws IOException if the object is closed
  47      */
  48     void ensureOpen() throws IOException;
  49
  50     /**
  51      * Verifies that additional information may be sent. In other words, the
  52      * operation is not done.
  53      * @throws IOException if the operation is completed
  54      */
  55     void ensureNotDone() throws IOException;
  56
  57     /**
  58      * Continues the operation since there is no data to read.
  59      * @param sendEmpty <code>true</code> if the operation should send an empty
  60      *        packet or not send anything if there is no data to send
  61      * @param inStream <code>true</code> if the stream is input stream or is
  62      *        output stream
  63      * @return <code>true</code> if the operation was completed;
  64      *         <code>false</code> if no operation took place
  65      * @throws IOException if an IO error occurs
  66      */
  67     boolean continueOperation(boolean sendEmpty, boolean inStream) throws IOException;
  68
  69     /**
  70      * Called when the output or input stream is closed.
  71      * @param inStream <code>true</code> if the input stream is closed;
  72      *        <code>false</code> if the output stream is closed
  73      * @throws IOException if an IO error occurs
  74      */
  75     void streamClosed(boolean inStream) throws IOException;
  76 }