xref: /AOO41X/main/odk/examples/DevelopersGuide/UCB/MyInputStream.java (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  *  The Contents of this file are made available subject to the terms of
4*cdf0e10cSrcweir  *  the BSD license.
5*cdf0e10cSrcweir  *
6*cdf0e10cSrcweir  *  Copyright 2000, 2010 Oracle and/or its affiliates.
7*cdf0e10cSrcweir  *  All rights reserved.
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  *  Redistribution and use in source and binary forms, with or without
10*cdf0e10cSrcweir  *  modification, are permitted provided that the following conditions
11*cdf0e10cSrcweir  *  are met:
12*cdf0e10cSrcweir  *  1. Redistributions of source code must retain the above copyright
13*cdf0e10cSrcweir  *     notice, this list of conditions and the following disclaimer.
14*cdf0e10cSrcweir  *  2. Redistributions in binary form must reproduce the above copyright
15*cdf0e10cSrcweir  *     notice, this list of conditions and the following disclaimer in the
16*cdf0e10cSrcweir  *     documentation and/or other materials provided with the distribution.
17*cdf0e10cSrcweir  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
18*cdf0e10cSrcweir  *     contributors may be used to endorse or promote products derived
19*cdf0e10cSrcweir  *     from this software without specific prior written permission.
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22*cdf0e10cSrcweir  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23*cdf0e10cSrcweir  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24*cdf0e10cSrcweir  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25*cdf0e10cSrcweir  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26*cdf0e10cSrcweir  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27*cdf0e10cSrcweir  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
28*cdf0e10cSrcweir  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
29*cdf0e10cSrcweir  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
30*cdf0e10cSrcweir  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
31*cdf0e10cSrcweir  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32*cdf0e10cSrcweir  *
33*cdf0e10cSrcweir  *************************************************************************/
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir // imports
36*cdf0e10cSrcweir import com.sun.star.io.BufferSizeExceededException;
37*cdf0e10cSrcweir import com.sun.star.io.NotConnectedException;
38*cdf0e10cSrcweir import com.sun.star.io.XInputStream;
39*cdf0e10cSrcweir import com.sun.star.io.XSeekable;
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir /**
42*cdf0e10cSrcweir  * XInputStream interface implementation.
43*cdf0e10cSrcweir  */
44*cdf0e10cSrcweir public class MyInputStream implements XSeekable, XInputStream {
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir     /**
47*cdf0e10cSrcweir      * Member properties
48*cdf0e10cSrcweir      */
49*cdf0e10cSrcweir     private int offset = 0;
50*cdf0e10cSrcweir 	private int read = offset;
51*cdf0e10cSrcweir 	private byte[] bigbuffer;
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir     /**
54*cdf0e10cSrcweir      * Constructor
55*cdf0e10cSrcweir      */
56*cdf0e10cSrcweir 	public MyInputStream() {
57*cdf0e10cSrcweir 	}
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir 	    // XSeekable. Makes it possible to seek to a certain position within a stream.
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir     /**
62*cdf0e10cSrcweir      *   Returns the length of the stream.
63*cdf0e10cSrcweir      *
64*cdf0e10cSrcweir      *@return  long  The length of the storage medium on which the stream works.
65*cdf0e10cSrcweir      */
66*cdf0e10cSrcweir     public synchronized long getLength()
67*cdf0e10cSrcweir         throws com.sun.star.io.IOException,com.sun.star.uno.RuntimeException {
68*cdf0e10cSrcweir 		if ( bigbuffer != null ) {
69*cdf0e10cSrcweir 			return bigbuffer.length - offset;
70*cdf0e10cSrcweir 		} else {
71*cdf0e10cSrcweir             return 0;
72*cdf0e10cSrcweir 		}
73*cdf0e10cSrcweir 	}
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir     /**
76*cdf0e10cSrcweir      *   Returns the current offset of the stream.
77*cdf0e10cSrcweir      *
78*cdf0e10cSrcweir      *@return  long  The current offset in this stream.
79*cdf0e10cSrcweir      */
80*cdf0e10cSrcweir 	public synchronized long getPosition()
81*cdf0e10cSrcweir         throws com.sun.star.io.IOException,com.sun.star.uno.RuntimeException {
82*cdf0e10cSrcweir 		return read - offset ;
83*cdf0e10cSrcweir 	}
84*cdf0e10cSrcweir 
85*cdf0e10cSrcweir     /**
86*cdf0e10cSrcweir      *  Changes the seek pointer to a new location relative to the beginning of the stream.
87*cdf0e10cSrcweir      *
88*cdf0e10cSrcweir      *@param  long
89*cdf0e10cSrcweir      */
90*cdf0e10cSrcweir 	public synchronized void seek(long p0)
91*cdf0e10cSrcweir         throws IllegalArgumentException, com.sun.star.io.IOException,
92*cdf0e10cSrcweir             com.sun.star.uno.RuntimeException {
93*cdf0e10cSrcweir 		if( bigbuffer != null ) {
94*cdf0e10cSrcweir             p0 +=offset;
95*cdf0e10cSrcweir             read = ( int ) p0;
96*cdf0e10cSrcweir             if( read < offset || read > bigbuffer.length )
97*cdf0e10cSrcweir 			    throw new IllegalArgumentException();
98*cdf0e10cSrcweir         }
99*cdf0e10cSrcweir     }
100*cdf0e10cSrcweir 
101*cdf0e10cSrcweir 	    // XInputStream. This is the basic interface to read data from a stream.
102*cdf0e10cSrcweir 
103*cdf0e10cSrcweir     /**
104*cdf0e10cSrcweir      *   States how many bytes can be read or skipped without blocking.
105*cdf0e10cSrcweir      *
106*cdf0e10cSrcweir      *@return  int  If not available, then returned 0
107*cdf0e10cSrcweir      */
108*cdf0e10cSrcweir     public synchronized int available()
109*cdf0e10cSrcweir         throws NotConnectedException, com.sun.star.io.IOException,
110*cdf0e10cSrcweir             com.sun.star.uno.RuntimeException {
111*cdf0e10cSrcweir 		if( bigbuffer != null )
112*cdf0e10cSrcweir 			return ( bigbuffer.length - read );
113*cdf0e10cSrcweir 		else
114*cdf0e10cSrcweir 			return 0;
115*cdf0e10cSrcweir 	}
116*cdf0e10cSrcweir 
117*cdf0e10cSrcweir 	/**
118*cdf0e10cSrcweir      *   Closes the stream. .
119*cdf0e10cSrcweir      */
120*cdf0e10cSrcweir     public void closeInput()
121*cdf0e10cSrcweir 	    throws NotConnectedException,com.sun.star.io.IOException,
122*cdf0e10cSrcweir         com.sun.star.uno.RuntimeException {
123*cdf0e10cSrcweir 		read = -1;
124*cdf0e10cSrcweir     }
125*cdf0e10cSrcweir 
126*cdf0e10cSrcweir     /**
127*cdf0e10cSrcweir      *   Reads the specified number of bytes in the given sequence.
128*cdf0e10cSrcweir      *
129*cdf0e10cSrcweir      *@param    byte[][]
130*cdf0e10cSrcweir      *@param    int
131*cdf0e10cSrcweir      *@return   int
132*cdf0e10cSrcweir      */
133*cdf0e10cSrcweir 	public synchronized int readBytes(byte[][] p0, int p1)
134*cdf0e10cSrcweir 		throws NotConnectedException, BufferSizeExceededException,
135*cdf0e10cSrcweir             com.sun.star.io.IOException, com.sun.star.uno.RuntimeException {
136*cdf0e10cSrcweir 		if( bigbuffer != null ) {
137*cdf0e10cSrcweir 			if( read == -1 )
138*cdf0e10cSrcweir       		    return 0;
139*cdf0e10cSrcweir             int i = 0;
140*cdf0e10cSrcweir             int available;
141*cdf0e10cSrcweir             if ( p1 > bigbuffer.length - read )
142*cdf0e10cSrcweir                 available = bigbuffer.length - read;
143*cdf0e10cSrcweir             else
144*cdf0e10cSrcweir                 available = p1;
145*cdf0e10cSrcweir 
146*cdf0e10cSrcweir 			p0[0] = new byte[p1];
147*cdf0e10cSrcweir 			while( available != 0 ) {
148*cdf0e10cSrcweir 			    p0[0][i++] = bigbuffer[read++];
149*cdf0e10cSrcweir 				--available;
150*cdf0e10cSrcweir 			}
151*cdf0e10cSrcweir 			return i;
152*cdf0e10cSrcweir         } else {
153*cdf0e10cSrcweir 			p0[0] = new byte[0];
154*cdf0e10cSrcweir 			return 0;
155*cdf0e10cSrcweir 		}
156*cdf0e10cSrcweir     }
157*cdf0e10cSrcweir 
158*cdf0e10cSrcweir 	/**
159*cdf0e10cSrcweir      *  Reads the available number of bytes at maximum  nMaxBytesToRead .
160*cdf0e10cSrcweir      *  This method blocks the thread until at least one byte is available.
161*cdf0e10cSrcweir      *
162*cdf0e10cSrcweir      *@param    byte[][]
163*cdf0e10cSrcweir      *@param    int
164*cdf0e10cSrcweir      *@return   int
165*cdf0e10cSrcweir      */
166*cdf0e10cSrcweir     public synchronized int readSomeBytes(byte[][] p0, int p1)
167*cdf0e10cSrcweir 		    throws 	NotConnectedException,
168*cdf0e10cSrcweir         		    BufferSizeExceededException,
169*cdf0e10cSrcweir 		            com.sun.star.io.IOException,
170*cdf0e10cSrcweir 		            com.sun.star.uno.RuntimeException {
171*cdf0e10cSrcweir 		    return readBytes( p0,p1 );
172*cdf0e10cSrcweir 	}
173*cdf0e10cSrcweir 
174*cdf0e10cSrcweir     /**
175*cdf0e10cSrcweir      *  Skips the next nBytesToSkip bytes (must be positive).
176*cdf0e10cSrcweir      *  It is up to the implementation whether this method is blocking the thread or not.
177*cdf0e10cSrcweir      *
178*cdf0e10cSrcweir      *@param    int
179*cdf0e10cSrcweir      */
180*cdf0e10cSrcweir     public synchronized void skipBytes(int p0)
181*cdf0e10cSrcweir         throws 	NotConnectedException, BufferSizeExceededException,
182*cdf0e10cSrcweir 		    com.sun.star.io.IOException, com.sun.star.uno.RuntimeException {
183*cdf0e10cSrcweir         read += p0;
184*cdf0e10cSrcweir 	    if( read > bigbuffer.length )
185*cdf0e10cSrcweir     	    read = bigbuffer.length;
186*cdf0e10cSrcweir 
187*cdf0e10cSrcweir 	    if( read < offset )
188*cdf0e10cSrcweir 		    read = offset;
189*cdf0e10cSrcweir     }
190*cdf0e10cSrcweir }
191