FileInputStream Class Reference
[IO: Local and Remote]

#include <FileInputStream.h>

Inheritance diagram for FileInputStream:

[legend]

Collaboration diagram for FileInputStream:

[legend]

List of all members.

Public Member Functions
virtual void	Close ()
	Closes the stream if it is not already closed. All system resources used by the stream are released.
	FileInputStream (const std::string &url)
virtual std::string	GetLocation () const
virtual bool	IsDone () const
virtual bool	IsOpen () const
virtual char	Peek ()
virtual char	Read ()
virtual	~FileInputStream ()

---

Detailed Description

Handles loading files from the local filesystem

Definition at line 10 of file FileInputStream.h.

---

Constructor & Destructor Documentation

FileInputStream::FileInputStream

(

const std::string &

url

)

Definition at line 10 of file FileInputStream.cpp.

FileInputStream::~FileInputStream

(

)

[virtual]

Definition at line 19 of file FileInputStream.cpp.

References Close().

---

Member Function Documentation

void FileInputStream::Close

(

)

[virtual]

Closes the stream if it is not already closed. All system resources used by the stream are released.

Implements InputStream.

Definition at line 70 of file FileInputStream.cpp.

References IsOpen().

Referenced by ~FileInputStream().

virtual std::string FileInputStream::GetLocation

(

)

const [inline, virtual]

Returns:

An identifier for the source of this input stream.

Implements InputStream.

Definition at line 22 of file FileInputStream.h.

bool FileInputStream::IsDone

(

)

const [virtual]

Returns:

true if the end of the stream has been reached, and false if there are still more bytes to be read.

Implements InputStream.

Definition at line 29 of file FileInputStream.cpp.

Referenced by Peek(), and Read().

bool FileInputStream::IsOpen

(

)

const [virtual]

Returns:

true if the stream is open, and false if it is closed.

Implements InputStream.

Definition at line 24 of file FileInputStream.cpp.

Referenced by Close(), Peek(), and Read().

char FileInputStream::Peek

(

)

[virtual]

Returns:

The next byte of data from the document without advancing the stream. throws IllegalStateException - If the stream is closed throws IllegalStateException - If the last byte has already been read from the stream throws FileException, NetworkException, IllegalStateException - Implementation Specific

Implements InputStream.

Definition at line 53 of file FileInputStream.cpp.

References IsDone(), and IsOpen().

char FileInputStream::Read

(

)

[virtual]

Returns:

The next byte of data from the document and advances the stream. throws IllegalStateException - If the stream is closed throws IllegalStateException - If the last byte has already been read from the stream throws FileException, NetworkException, IllegalStateException - Implementation Specific

Implements InputStream.

Definition at line 34 of file FileInputStream.cpp.

References IsDone(), and IsOpen().

---

The documentation for this class was generated from the following files:

• FileInputStream.h
• FileInputStream.cpp