OpenJDK 27 · com.sun.media.sound.RIFFReader · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private long	avail
private final long	ckSize
private long	filepointer
private final String	fourcc
private RIFFReader	lastiterator
private String	riff_type
private final RIFFReader	root
private final InputStream	stream

Access	Constructor and Description
public	RIFFReader(final InputStream stream)

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public void	finish()
public long	getFilePointer()
public String	getFormat()
public long	getSize()
public String	getType()
public boolean	hasNextChunk()
public RIFFReader	nextChunk()
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] b, int offset, int len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
public byte	readByte()
public void	readFully(byte[] b)
public void	readFully(byte[] b, int off, int len)
public int	readInt()
public long	readLong()
public short	readShort()
public String	readString(final int len)
public int	readUnsignedByte()
public long	readUnsignedInt()
public int	readUnsignedShort()
public long	skip(final long n) Overrides java.io.InputStream.skip. Skips over and discards `n` bytes of data from this input stream.

Inherited from java.io.InputStream:: mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skipNBytes transferTo

avail	back to summary
private long avail

ckSize	back to summary
private final long ckSize

filepointer	back to summary
private long filepointer

fourcc	back to summary
private final String fourcc

lastiterator	back to summary
private RIFFReader lastiterator

riff_type	back to summary
private String riff_type

root	back to summary
private final RIFFReader root

stream	back to summary
private final InputStream stream

RIFFReader	back to summary
public RIFFReader(final InputStream stream) throws IOException

Method Detail

available back to summary

available	back to summary
public int available() Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Annotations @Override

public int available()

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Annotations

@Override

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

finish	back to summary
public void finish() throws IOException

getFilePointer	back to summary
public long getFilePointer() throws IOException

getFormat	back to summary
public String getFormat()

getSize	back to summary
public long getSize()

getType	back to summary
public String getType()

hasNextChunk	back to summary
public boolean hasNextChunk() throws IOException

nextChunk	back to summary
public RIFFReader nextChunk() throws IOException

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int offset, int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public int read(byte[] b, int offset, int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

readByte	back to summary
public byte readByte() throws IOException

readFully	back to summary
public void readFully(byte[] b) throws IOException

readFully	back to summary
public void readFully(byte[] b, int off, int len) throws IOException

readInt	back to summary
public int readInt() throws IOException

readLong	back to summary
public long readLong() throws IOException

readShort	back to summary
public short readShort() throws IOException

readString	back to summary
public String readString(final int len) throws IOException

readUnsignedByte	back to summary
public int readUnsignedByte() throws IOException

readUnsignedInt	back to summary
public long readUnsignedInt() throws IOException

readUnsignedShort	back to summary
public int readUnsignedShort() throws IOException

skip back to summary

skip	back to summary
public long skip(final long n) throws IOException Overrides java.io.InputStream.skip. Doc from java.io.InputStream.skip. Skips over and discards `n` bytes of data from this input stream. The `skip` method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly `0`. This may result from any of a number of conditions; reaching end of file before `n` bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If `n` is negative, the `skip` method for class `InputStream` always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently. Annotations @Override Exceptions IOException: if an I/O error occurs.

public long skip(final long n) throws IOException

Overrides java.io.InputStream.skip.

Doc from java.io.InputStream.skip.

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, the skip method for class InputStream always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

public final Class RIFFReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail