com.kamontat.utilities

Class URLReader

java.lang.Object

com.kamontat.utilities.URLReader

All Implemented Interfaces:

Callable<Long>

public class URLReader
extends Object
implements Callable<Long>

Download a URL to a File.

Author:

James Brucker

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
URLReader(URL url, File outfile) Initialize a new URL Reader.

Method Summary

Modifier and Type	Method and Description
Long	call() start the URL reader.
long	getBytesRead() Get the number of bytes downloaded so far.
String	getOutputFile() Get actual name of the output file.
long	getTotalByte()
int	read() precondition: you need to call setInput() first.
long	readAll() Read the URL connection and save bytes to output file.
void	setInput() set this method before read()

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

public static int BUFFER_SIZE

Constructor Detail

URLReader

public URLReader(URL url,
                 File outfile)
          throws IOException

Initialize a new URL Reader.
precondition: url is a valid URL, outfile is a valid writable file or directory.

Parameters:

url - is the URL to readAll from

outfile - is a File output to write output to. If it is a writable directory then a file is created in that directory with same name as the download resource.

Throws:

IOException - if URLConnection fails,

FileNotFoundException - if outfile not found or cannot be written to

Method Detail

getBytesRead

public long getBytesRead()

Get the number of bytes downloaded so far.

Returns:

number of bytes downloaded from URL so far.

getTotalByte

public long getTotalByte()

readAll

public long readAll()
             throws IOException

Read the URL connection and save bytes to output file. This method will block until the entire URL content is readAll. While reading, the bytesRead object attribute is regularly updated.

Returns:

the number of bytes actually readAll

Throws:

IOException - when IO error cause

read

public int read()

precondition: you need to call setInput() first.
work like InputStream.read(byte[]) with BUFFER_SIZE, but add more action is save the result to output stream.

Returns:

size that read. or null if cause error

setInput

public void setInput()

set this method before read()

getOutputFile

public String getOutputFile()

Get actual name of the output file.

Returns:

string name with path of the output file

call

public Long call()
          throws Exception

start the URL reader. and close connection while finish

Specified by:

call in interface Callable<Long>

Throws:

Exception