#include <fcoll.h>
Public Types | |
enum | MatchPath { IGNORE, MATCH } |
Public Member Functions | |
FileCollection () | |
FileCollection constructor. | |
FileCollection (const FileCollection &src) | |
Copy constructor. | |
const FileCollection & | operator= (const FileCollection &src) |
Copy assignment operator. | |
virtual void | close ()=0 |
Closes the FileCollection. | |
virtual ConstEntries | entries () const |
virtual ConstEntryPointer | getEntry (const string &name, MatchPath matchpath=MATCH) const |
virtual istream * | getInputStream (const ConstEntryPointer &entry)=0 |
virtual istream * | getInputStream (const string &entry_name, MatchPath matchpath=MATCH)=0 |
Returns a pointer to an opened istream for the specified entry name. | |
virtual string | getName () const |
Returns the name of the FileCollection. | |
virtual int | size () const |
Returns the number of entries in the FileCollection. | |
bool | isValid () const |
The member function returns true if the collection is valid. | |
virtual FileCollection * | clone () const =0 |
Create a heap allocated clone of the object this method is called for. | |
virtual | ~FileCollection () |
FileCollection destructor. | |
Protected Attributes | |
string | _filename |
Entries | _entries |
bool | _valid |
Definition at line 21 of file fcoll.h.
zipios::FileCollection::FileCollection | ( | ) | [inline, explicit] |
zipios::FileCollection::FileCollection | ( | const FileCollection & | src | ) | [inline] |
zipios::FileCollection::~FileCollection | ( | ) | [virtual] |
const FileCollection & zipios::FileCollection::operator= | ( | const FileCollection & | src | ) | [inline] |
virtual void zipios::FileCollection::close | ( | ) | [pure virtual] |
Closes the FileCollection.
Implemented in zipios::CollectionCollection, zipios::DirectoryCollection, and zipios::ZipFile.
ConstEntries zipios::FileCollection::entries | ( | ) | const [virtual] |
Returns a vector of const pointers to the entries in the FileCollection.
InvalidStateException | Thrown if the collection is invalid. |
Reimplemented in zipios::CollectionCollection, and zipios::DirectoryCollection.
ConstEntryPointer zipios::FileCollection::getEntry | ( | const string & | name, | |
MatchPath | matchpath = MATCH | |||
) | const [virtual] |
Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name. To ignore the path part of the filename in search of a match, specify FileCollection::IGNORE as the second argument.
name | A string containing the name of the entry to get. | |
matchpath | Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be ignored. |
InvalidStateException | Thrown if the collection is invalid. |
Reimplemented in zipios::CollectionCollection, and zipios::DirectoryCollection.
virtual istream* zipios::FileCollection::getInputStream | ( | const ConstEntryPointer & | entry | ) | [pure virtual] |
Returns a pointer to an opened istream for the specified FileEntry. It is the callers responsibility to delete the stream when he is done with it. Returns 0, if there is no such FileEntry in the FileCollection.
entry | A ConstEntryPointer to the FileEntry to get an istream to. |
InvalidStateException | Thrown if the collection is invalid. |
Implemented in zipios::CollectionCollection, zipios::DirectoryCollection, and zipios::ZipFile.
virtual istream* zipios::FileCollection::getInputStream | ( | const string & | entry_name, | |
MatchPath | matchpath = MATCH | |||
) | [pure virtual] |
Returns a pointer to an opened istream for the specified entry name.
It is the callers responsibility to delete the stream when he is done with it. Returns 0, if there is no entry with the specified name in the FileCollection.
matchpath | Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be ignored. |
InvalidStateException | Thrown if the collection is invalid. |
Implemented in zipios::CollectionCollection, zipios::DirectoryCollection, and zipios::ZipFile.
string zipios::FileCollection::getName | ( | ) | const [virtual] |
Returns the name of the FileCollection.
InvalidStateException | Thrown if the collection is invalid. |
int zipios::FileCollection::size | ( | ) | const [virtual] |
Returns the number of entries in the FileCollection.
InvalidStateException | Thrown if the collection is invalid. |
Reimplemented in zipios::CollectionCollection, and zipios::DirectoryCollection.
bool zipios::FileCollection::isValid | ( | ) | const [inline] |
virtual FileCollection* zipios::FileCollection::clone | ( | ) | const [pure virtual] |
Create a heap allocated clone of the object this method is called for.
The caller is responsible for deallocating the clone when he is done with it.
Implemented in zipios::CollectionCollection, zipios::DirectoryCollection, and zipios::ZipFile.