summaryrefslogtreecommitdiff
path: root/libjava/classpath/javax/imageio/stream/ImageInputStream.java
blob: dd57ca611da6d076d6894213b004087da57f9592 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
/* ImageInputStream.java
   Copyright (C) 2004, 2005  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package javax.imageio.stream;

import java.io.DataInput;
import java.io.EOFException;
import java.io.IOException;
import java.nio.ByteOrder;


/**
 * An input stream for use by {@link javax.imageio.ImageReader
 * ImageReaders}.
 *
 * @since 1.4
 *
 * @author Sascha Brawer (brawer@dandelis.ch)
 */
public interface ImageInputStream
  extends DataInput
{
  void setByteOrder(ByteOrder order);

  ByteOrder getByteOrder();

  int read()
    throws IOException;

  int read(byte[] b)
    throws IOException;

  int read(byte[] b, int offset, int length)
    throws IOException;


  /**
   * Reads up to a specified number of bytes, and modifies a
   * {@link IIOByteBuffer} to hold the read data.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @param buf an <code>IIOByteBuffer</code> that will hold the read
   * data.
   *
   * @param numBytes the maximum number of bytes to read.
   *
   * @throws IndexOutOfBoundsException if <code>numBytes</code> is
   * negative.
   *
   * @throws NullPointerException if <code>buf</code> is
   * <code>null</code>.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   */
  void readBytes(IIOByteBuffer buf, int numBytes)
    throws IOException;


  /**
   * Reads a byte and checks whether or not its value is zero.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before the byte is read.
   *
   * @throws EOFException if the input stream is at its end.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readBit()
   * @see #readByte()
   * @see #readFully(byte[], int, int)
   */
  boolean readBoolean()
    throws IOException;


  /**
   * Reads a signed byte.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @throws EOFException if the input stream is at its end.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readUnsignedByte()
   * @see #readFully(byte[], int, int)
   */
  byte readByte()
    throws IOException;


  /**
   * Reads an unsigned byte.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @throws EOFException if the input stream is at its end.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readByte()
   * @see #readFully(byte[], int, int)
   */
  int readUnsignedByte()
    throws IOException;


  /**
   * Reads an signed 16-bit integer. If necessary, the value gets
   * converted from the stream&#x2019;s {@linkplain #getByteOrder()
   * current byte order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @throws EOFException if the input stream ends before all two
   * bytes were read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readUnsignedShort()
   * @see #readChar()
   * @see #readFully(short[], int, int)
   */
  short readShort()
    throws IOException;


  /**
   * Reads an unsigned 16-bit integer. If necessary, the value gets
   * converted from the stream&#x2019;s {@linkplain #getByteOrder()
   * current byte order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * <p>This method does the same as {@link #readChar()}.
   *
   * @throws EOFException if the input stream ends before all two
   * bytes were read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readShort()
   * @see #readChar()
   * @see #readFully(char[], int, int)
   */
  int readUnsignedShort()
    throws IOException;


  /**
   * Reads an unsigned 16-bit integer. If necessary, the value gets
   * converted from the stream&#x2019;s {@linkplain #getByteOrder()
   * current byte order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * <p>This method does the same as {@link #readUnsignedShort()}.
   *
   * @throws EOFException if the input stream ends before all two
   * bytes were read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readFully(char[], int, int)
   */
  char readChar()
    throws IOException;


  /**
   * Reads a signed 32-bit integer. If necessary, the value gets
   * converted from the stream&#x2019;s {@linkplain #getByteOrder()
   * current byte order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @throws EOFException if the input stream ends before all four
   * bytes were read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readUnsignedInt()
   * @see #readFully(int[], int, int)
   */
  int readInt()
    throws IOException;


  /**
   * Reads an unsigned 32-bit integer. If necessary, the value gets
   * converted from the stream&#x2019;s {@linkplain #getByteOrder()
   * current byte order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @throws EOFException if the input stream ends before all four
   * bytes were read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readInt()
   * @see #readFully(int[], int, int)
   */
  long readUnsignedInt()
    throws IOException;


  /**
   * Reads a signed 64-bit integer. If necessary, the value gets
   * converted from the stream&#x2019;s {@linkplain #getByteOrder()
   * current byte order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @throws EOFException if the input stream ends before all eight
   * bytes were read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readFully(long[], int, int)
   */
  long readLong()
    throws IOException;


  /**
   * Reads an IEEE 32-bit single-precision floating point number. If
   * necessary, the value gets converted from the stream&#x2019;s
   * {@linkplain #getByteOrder() current byte order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @throws EOFException if the input stream ends before all four
   * bytes were read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readFully(float[], int, int)
   */
  float readFloat()
    throws IOException;


  /**
   * Reads an IEEE 64-bit double-precision floating point number. If
   * necessary, the value gets converted from the stream&#x2019;s
   * {@linkplain #getByteOrder() current byte order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @throws EOFException if the input stream ends before all eight
   * bytes were read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readFully(double[], int, int)
   */
  double readDouble()
    throws IOException;

  String readLine()
    throws IOException;

  String readUTF()
    throws IOException;


  /**
   * Reads a sequence of signed 8-bit integers into a
   * <code>byte[]</code> array.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @param b an array for storing the read values.
   *
   * @param offset the index of the first element in <code>b</code>
   * that will hold read data.
   *
   * @param numBytes the number of bytes to read.
   *
   * @throws IndexOutOfBoundsException if <code>offset</code> or
   * <code>numBytes</code> is negative, or if <code>offset +
   * numBytes</code> exceeds <code>b.length</code>.
   *
   * @throws NullPointerException if <code>b</code> is
   * <code>null</code>.
   *
   * @throws EOFException if the input stream ends before all content
   * was read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readByte()
   */
  void readFully(byte[] b, int offset, int numBytes)
    throws IOException;


  /**
   * Reads a sequence of signed 8-bit integers into a
   * <code>byte[]</code> array.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @param b an array for storing the read values.
   *
   * @throws NullPointerException if <code>b</code> is
   * <code>null</code>.
   *
   * @throws EOFException if the input stream ends before all content
   * was read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readByte()
   * @see #readFully(byte[], int, int)
   */
  void readFully(byte[] b)
    throws IOException;


  /**
   * Reads a sequence of signed 16-bit integers into a
   * <code>short[]</code> array.  If necessary, values are converted
   * from the stream&#x2019;s {@linkplain #getByteOrder() current byte
   * order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @param s an array for storing the read values.
   *
   * @param offset the index of the first element in <code>s</code>
   * that will hold read data.
   *
   * @param numShorts the number of signed 16-bit integers to read
   * (which is one half of the number of bytes).
   *
   * @throws IndexOutOfBoundsException if <code>offset</code> or
   * <code>numShorts</code> is negative, or if <code>offset +
   * numShorts</code> exceeds <code>s.length</code>.
   *
   * @throws NullPointerException if <code>s</code> is
   * <code>null</code>.
   *
   * @throws EOFException if the input stream ends before all content
   * was read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readShort()
   */
  void readFully(short[] s, int offset, int numShorts)
    throws IOException;


  /**
   * Reads a sequence of unsigned 16-bit integers into a
   * <code>char[]</code> array.  If necessary, values are converted
   * from the stream&#x2019;s {@linkplain #getByteOrder() current byte
   * order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @param c an array for storing the read values.
   *
   * @param offset the index of the first element in <code>c</code>
   * that will hold read data.
   *
   * @param numChars the number of unsigned 16-bit integers to read
   * (which is one half of the number of bytes).
   *
   * @throws IndexOutOfBoundsException if <code>offset</code> or
   * <code>numChars</code> is negative, or if <code>offset +
   * numChars</code> exceeds <code>c.length</code>.
   *
   * @throws NullPointerException if <code>c</code> is
   * <code>null</code>.
   *
   * @throws EOFException if the input stream ends before all content
   * was read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readChar()
   */
  void readFully(char[] c, int offset, int numChars)
    throws IOException;


  /**
   * Reads a sequence of signed 32-bit integers into a
   * <code>long[]</code> array.  If necessary, values are converted
   * from the stream&#x2019;s {@linkplain #getByteOrder() current byte
   * order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @param i an array for storing the read values.
   *
   * @param offset the index of the first element in <code>i</code>
   * that will hold read data.
   *
   * @param numInts the number of signed 32-bit integers to read
   * (which is one fourth of the number of bytes).
   *
   * @throws IndexOutOfBoundsException if <code>offset</code> or
   * <code>numInts</code> is negative, or if <code>offset +
   * numInts</code> exceeds <code>i.length</code>.
   *
   * @throws NullPointerException if <code>i</code> is
   * <code>null</code>.
   *
   * @throws EOFException if the input stream ends before all content
   * was read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readInt()
   */
  void readFully(int[] i, int offset, int numInts)
    throws IOException;


  /**
   * Reads a sequence of signed 64-bit integers into a
   * <code>long[]</code> array.  If necessary, values are converted
   * from the stream&#x2019;s {@linkplain #getByteOrder() current byte
   * order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @param l an array for storing the read values.
   *
   * @param offset the index of the first element in <code>l</code>
   * that will hold read data.
   *
   * @param numLongs the number of signed 64-bit integers to read
   * (which is one eight of the number of bytes).
   *
   * @throws IndexOutOfBoundsException if <code>offset</code> or
   * <code>numLongs</code> is negative, or if <code>offset +
   * numLongs</code> exceeds <code>l.length</code>.
   *
   * @throws NullPointerException if <code>l</code> is
   * <code>null</code>.
   *
   * @throws EOFException if the input stream ends before all content
   * was read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readLong()
   */
  void readFully(long[] l, int offset, int numLongs)
    throws IOException;


  /**
   * Reads a sequence of IEEE 32-bit single-precision floating point
   * numbers into a <code>float[]</code> array.  If necessary, values
   * are converted from the stream&#x2019;s {@linkplain
   * #getByteOrder() current byte order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @param d an array for storing the read values.
   *
   * @param offset the index of the first element in <code>d</code>
   * that will hold read data.
   *
   * @param numFloats the number of IEEE 32-bit single-precision
   * floating point numbers to read (which is one fourth of the number
   * of bytes).
   *
   * @throws IndexOutOfBoundsException if <code>offset</code> or
   * <code>numFloats</code> is negative, or if <code>offset +
   * numFloats</code> exceeds <code>f.length</code>.
   *
   * @throws NullPointerException if <code>f</code> is
   * <code>null</code>.
   *
   * @throws EOFException if the input stream ends before all content
   * was read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readFloat()
   */
  void readFully(float[] f, int offset, int numFloats)
    throws IOException;


  /**
   * Reads a sequence of IEEE 64-bit double-precision floating point
   * numbers into a <code>double[]</code> array.  If necessary, values
   * are converted from the stream&#x2019;s {@linkplain
   * #getByteOrder() current byte order}.
   *
   * <p>The {@linkplain #getBitOffset() bit offset} is set to zero
   * before any data is read.
   *
   * @param d an array for storing the read values.
   *
   * @param offset the index of the first element in <code>d</code>
   * that will hold read data.
   *
   * @param numDoubles the number of IEEE 64-bit double-precision
   * floating point numbers to read (which is one eight of the number
   * of bytes).
   *
   * @throws IndexOutOfBoundsException if <code>offset</code> or
   * <code>numDoubles</code> is negative, or if <code>offset +
   * numDoubles</code> exceeds <code>d.length</code>.
   *
   * @throws NullPointerException if <code>d</code> is
   * <code>null</code>.
   *
   * @throws EOFException if the input stream ends before all content
   * was read.
   *
   * @throws IOException if some general problem happens with
   * accessing data.
   *
   * @see #readDouble()
   */
  void readFully(double[] d, int offset, int numDoubles)
    throws IOException;

  long getStreamPosition()
    throws IOException;

  int getBitOffset()
    throws IOException;

  void setBitOffset(int bitOffset)
    throws IOException;

  int readBit()
    throws IOException;

  long readBits(int numBits)
    throws IOException;

  long length()
    throws IOException;

  int skipBytes(int numBytes)
    throws IOException;

  long skipBytes(long numBytes)
    throws IOException;

  void seek(long pos)
    throws IOException;

  void mark();

  void reset()
    throws IOException;

  void flushBefore(long pos)
    throws IOException;

  void flush()
    throws IOException;

  long getFlushedPosition();

  boolean isCached();

  boolean isCachedMemory();

  boolean isCachedFile();

  void close()
    throws IOException;
}