com.partnersoft.io

Interface InputSource

public interface InputSource

A generic input source. Provides input streams and readers upon request.

Copyright 2006 Partner Software, Inc.

Author:

Paul Reavis

Method Summary

Methods

Modifier and Type	Method and Description
java.io.BufferedInputStream	createBufferedInputStream() Creates a buffered input stream to read from this source.
java.io.BufferedReader	createBufferedReader() Creates a buffered reader to read from this source.
java.io.InputStream	createInputStream() Creates an input stream to read from this source.
java.io.Reader	createReader() Creates a reader to read text from this source.
java.net.URI	getAbsoluteURI() Absolute URI for this source.
java.lang.String	getName() Simple name for this source.
java.net.URI	getURI() Relative URI for this source.

Method Detail

getName

java.lang.String getName()

Simple name for this source.

getURI

java.net.URI getURI()

Relative URI for this source.

getAbsoluteURI

java.net.URI getAbsoluteURI()

Absolute URI for this source.

createInputStream

java.io.InputStream createInputStream()
                                      throws java.io.IOException

Creates an input stream to read from this source. Starts at the beginning. You must close the stream using InputStream.close() when you are done with it. Note that this stream is NOT buffered. This is usually a bad thing, unless you are doing your own buffering or doing a single bulk read. So, don't use this method unless you know what you're doing - use createBufferedInputStream() instead.

Returns:

stream you can read from

Throws:

java.io.IOException - if the read fails

createBufferedInputStream

java.io.BufferedInputStream createBufferedInputStream()
                                                      throws java.io.IOException

Creates a buffered input stream to read from this source. Starts at the beginning. You must close the stream using OutputStream.close() when you are done with it. This stream is buffered. This is usually a good thing. So, generally use this method instead of createInputStream() unless you know what you're doing.

Returns:

stream you can read from

Throws:

java.io.IOException - if the read fails

createReader

java.io.Reader createReader()
                            throws java.io.IOException

Creates a reader to read text from this source. Starts at the beginning. You must close the reader using Reader.close() when you are done with it. Note that this reader is NOT buffered. This is usually a bad thing, unless you are doing your own buffering or doing a single bulk read. So, don't use this method unless you know what you're doing - use createBufferedReader() instead.

Returns:

reader you can read from

Throws:

java.io.IOException - if the read fails

createBufferedReader

java.io.BufferedReader createBufferedReader()
                                            throws java.io.IOException

Creates a buffered reader to read from this source. Starts at the beginning of the file. You must close the reader using Reader.close() when you are done with it. This reader is buffered. This is usually a good thing. So, generally use this method instead of createReader() unless you know what you're doing.

Returns:

reader you can read from

Throws:

java.io.IOException - if the read fails