net.sourceforge.javadpkg.io

Interface DataSource

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DataByteArraySource, DataFileSource, DataStreamSource

public interface DataSource
extends Closeable

The source for reading data.

Version:

1.0, 31.12.2015 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
InputStream	getInputStream() Returns a stream for reading the data.
long	getLength() Returns the length of the data which can be read from the source in bytes.
String	getName() Returns the name of the source.
boolean	isResettable() Returns the flag if the source can be reseted.
void	reset() Resets the source.

Methods inherited from interface java.io.Closeable

close

Method Detail

getName

String getName()

Returns the name of the source.

This name is used e.g. for detail messages of exceptions.

Returns:

The name.

getLength

long getLength()

Returns the length of the data which can be read from the source in bytes.

Returns:

The length or -1, if the length is unknown.

isResettable

boolean isResettable()

Returns the flag if the source can be reseted.

Returns:

The flag: true, if the source can be reseted, false otherwise.

See Also:

reset()

reset

void reset()
    throws IOException

Resets the source.

If the source can't be reseted an IOException will be thrown.

If the source can be reseted the next call of the getInputStream() method will return a new InputStream which reads the source from the beginning again.

Throws:

IOException - If an I/O error occurs or if the source doesn't support a reset.

See Also:

isResettable()

getInputStream

InputStream getInputStream()
                    throws IOException

Returns a stream for reading the data.

The method will always return the same InputStream if the source is still open. If the InputStream.close() method is called the source will behave the same as the Closeable.close() method was called.

If the reset() method was successfully called the method will return a different InputStream.

Returns:

The stream.

Throws:

IOException - If an I/O error occurs.