javax.swing

Class ProgressMonitorInputStream

Implemented Interfaces:
AutoCloseable, Closeable

public class ProgressMonitorInputStream
extends FilterInputStream

An input stream with a ProgressMonitor.
Since:
1.2

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

ProgressMonitorInputStream(Component component, Object message, InputStream stream)
Creates a new ProgressMonitorInputStream.

Method Summary

void
close()
Closes the input stream and the associated ProgressMonitor.
ProgressMonitor
getProgressMonitor()
Returns the ProgressMonitor used by this input stream.
int
read()
Reads an unsigned byte from the input stream and returns it as an int in the range of 0-255.
int
read(byte[] data)
Reads bytes from the input stream and stores them in the supplied array, and updates the progress monitor (or closes it if the end of the stream is reached).
int
read(byte[] data, int offset, int length)
Reads up to length bytes from the input stream and stores them in the supplied array at the given index, and updates the progress monitor (or closes it if the end of the stream is reached).
void
reset()
Resets the input stream to the point where mark(int) was called.
long
skip(long length)
Skips the specified number of bytes and updates the ProgressMonitor.

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProgressMonitorInputStream

public ProgressMonitorInputStream(Component component,
                                  Object message,
                                  InputStream stream)
Creates a new ProgressMonitorInputStream.
Parameters:
component - the parent component for the progress monitor dialog.
message - the task description.
stream - the underlying input stream.

Method Details

close

public void close()
            throws IOException
Closes the input stream and the associated ProgressMonitor.
Specified by:
close in interface Closeable
close in interface AutoCloseable
Overrides:
close in interface FilterInputStream
Throws:
IOException - if there is a problem closing the input stream.

getProgressMonitor

public ProgressMonitor getProgressMonitor()
Returns the ProgressMonitor used by this input stream.
Returns:
The progress monitor.

read

public int read()
            throws IOException
Reads an unsigned byte from the input stream and returns it as an int in the range of 0-255. Returns -1 if the end of the stream has been reached. The progress monitor is updated.
Overrides:
read in interface FilterInputStream
Returns:
int
Throws:
IOException - if there is a problem reading the stream.

read

public int read(byte[] data)
            throws IOException
Reads bytes from the input stream and stores them in the supplied array, and updates the progress monitor (or closes it if the end of the stream is reached).
Overrides:
read in interface FilterInputStream
Parameters:
data - the data array for returning bytes read from the stream.
Returns:
The number of bytes read, or -1 if there are no more bytes in the stream.
Throws:
IOException - if there is a problem reading bytes from the stream.

read

public int read(byte[] data,
                int offset,
                int length)
            throws IOException
Reads up to length bytes from the input stream and stores them in the supplied array at the given index, and updates the progress monitor (or closes it if the end of the stream is reached).
Overrides:
read in interface FilterInputStream
Parameters:
data - the data array for returning bytes read from the stream.
offset - the offset into the array where the bytes should be written.
length - the maximum number of bytes to read from the stream.
Returns:
The number of bytes read, or -1 if there are no more bytes in the stream.
Throws:
IOException - if there is a problem reading bytes from the stream.

reset

public void reset()
            throws IOException
Resets the input stream to the point where mark(int) was called.
Overrides:
reset in interface FilterInputStream
Throws:
IOException - TODO

skip

public long skip(long length)
            throws IOException
Skips the specified number of bytes and updates the ProgressMonitor.
Overrides:
skip in interface FilterInputStream
Parameters:
length - the number of bytes to skip.
Returns:
The actual number of bytes skipped.
Throws:
IOException - if there is a problem skipping bytes in the stream.

ProgressMonitorInputStream.java -- Copyright (C) 2002, 2004, 2005, 2006, 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.