Package com.peterphi.std.io

Class StreamUtil

java.lang.Object

com.peterphi.std.io.StreamUtil

public class StreamUtil
extends Object

Title: Stream Utility Class

Description: Does useful things with streams

Copyright: Copyright (c) 2006

Version:

$Revision$

Field Summary

Fields

Modifier and Type	Field	Description
static int	CHUNKSIZE
static com.peterphi.std.io.StreamUtil.DummyMonitor	DUMMY_MONITOR	A monitor which does nothing
static int	MONITOR_UPDATE_INTERVAL
static int	STREAM_SLEEP_TIME

Method Summary

Modifier and Type	Method	Description
static void	doBackgroundCopy(InputStream isI, OutputStream osI)
static void	doBackgroundCopy(InputStream is, OutputStream os, ICopyProgressMonitor monitor)
static void	doBackgroundCopy(InputStream is, OutputStream os, ICopyProgressMonitor monitor, boolean closeOutput, boolean closeInput)
static long	eatInputStream(InputStream is)	Eats an inputstream, discarding its contents
static InputStream	routeStreamThroughProcess(Process p, InputStream origin, boolean closeInput)	Given a Process, this function will route the flow of data through it & out again
static void	streamCopy(InputStream in, OutputStream out)
static void	streamCopy(InputStream in, OutputStream out, ICopyProgressMonitor monitor)
static void	streamCopy(InputStream input, Writer output)	Copies the contents of an InputStream, using the default encoding, into a Writer
static void	streamCopy(Reader reader, Writer writer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STREAM_SLEEP_TIME

public static final int STREAM_SLEEP_TIME

See Also:

Constant Field Values

CHUNKSIZE

public static final int CHUNKSIZE

See Also:

Constant Field Values

MONITOR_UPDATE_INTERVAL

public static final int MONITOR_UPDATE_INTERVAL

See Also:

Constant Field Values

DUMMY_MONITOR

public static final com.peterphi.std.io.StreamUtil.DummyMonitor DUMMY_MONITOR

A monitor which does nothing

Method Detail

routeStreamThroughProcess

public static InputStream routeStreamThroughProcess(Process p,
                                                    InputStream origin,
                                                    boolean closeInput)

Given a Process, this function will route the flow of data through it & out again

Parameters:

p -

origin -

closeInput -

Returns:

eatInputStream

public static long eatInputStream(InputStream is)

Eats an inputstream, discarding its contents

Parameters:

is - InputStream The input stream to read to the end of

Returns:

long The size of the stream

doBackgroundCopy

public static void doBackgroundCopy(InputStream isI,
                                    OutputStream osI)

doBackgroundCopy

public static void doBackgroundCopy(InputStream is,
                                    OutputStream os,
                                    ICopyProgressMonitor monitor)

doBackgroundCopy

public static void doBackgroundCopy(InputStream is,
                                    OutputStream os,
                                    ICopyProgressMonitor monitor,
                                    boolean closeOutput,
                                    boolean closeInput)

streamCopy

public static void streamCopy(InputStream in,
                              OutputStream out)

streamCopy

public static void streamCopy(InputStream in,
                              OutputStream out,
                              ICopyProgressMonitor monitor)

streamCopy

public static void streamCopy(Reader reader,
                              Writer writer)
                       throws IOException

Throws:

IOException

streamCopy

public static void streamCopy(InputStream input,
                              Writer output)
                       throws IOException

Copies the contents of an InputStream, using the default encoding, into a Writer

Parameters:

input -

output -

Throws:

IOException