Zipios++
|
#include <dircoll.h>
Public Member Functions | |
DirectoryCollection () | |
Default Constructor. | |
DirectoryCollection (const string &path, bool recursive=true, bool load_now=false) | |
Constructor. | |
virtual void | close () |
Closes the FileCollection. | |
virtual ConstEntries | entries () const |
virtual ConstEntryPointer | getEntry (const string &name, MatchPath matchpath=MATCH) const |
virtual istream * | getInputStream (const ConstEntryPointer &entry) |
virtual istream * | getInputStream (const string &entry_name, MatchPath matchpath=MATCH) |
Returns a pointer to an opened istream for the specified entry name. | |
virtual int | size () const |
Returns the number of entries in the FileCollection. | |
virtual FileCollection * | clone () const |
Create a heap allocated clone of the object this method is called for. | |
virtual | ~DirectoryCollection () |
Destructor. | |
Protected Member Functions | |
void | loadEntries () const |
void | load (bool recursive, const FilePath &subdir=FilePath()) |
Protected Attributes | |
bool | _entries_loaded |
bool | _recursive |
FilePath | _filepath |
DirectoryCollection is a FileCollection that obtains its entries from a directory.
zipios::DirectoryCollection::DirectoryCollection | ( | ) | [inline, explicit] |
zipios::DirectoryCollection::DirectoryCollection | ( | const string & | path, |
bool | recursive = true , |
||
bool | load_now = false |
||
) | [explicit] |
Constructor.
path | A directory path name. If the name is not a valid directory the created DirectoryCollection will be invalid. |
load_now | Load directory into memory now. Otherwise it will be done when it is first needed. |
Definition at line 21 of file dircoll.cpp.
zipios::DirectoryCollection::~DirectoryCollection | ( | ) | [virtual] |
Destructor.
Definition at line 119 of file dircoll.cpp.
FileCollection * zipios::DirectoryCollection::clone | ( | ) | const [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.
Implements zipios::FileCollection.
Definition at line 115 of file dircoll.cpp.
void zipios::DirectoryCollection::close | ( | ) | [virtual] |
Closes the FileCollection.
Implements zipios::FileCollection.
Definition at line 34 of file dircoll.cpp.
ConstEntries zipios::DirectoryCollection::entries | ( | ) | const [virtual] |
Returns a vector of const pointers to the entries in the FileCollection.
InvalidStateException | Thrown if the collection is invalid. |
Reimplemented from zipios::FileCollection.
Definition at line 39 of file dircoll.cpp.
ConstEntryPointer zipios::DirectoryCollection::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 from zipios::FileCollection.
Definition at line 50 of file dircoll.cpp.
istream * zipios::DirectoryCollection::getInputStream | ( | const ConstEntryPointer & | entry | ) | [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. |
Implements zipios::FileCollection.
Definition at line 69 of file dircoll.cpp.
istream * zipios::DirectoryCollection::getInputStream | ( | const string & | entry_name, |
MatchPath | matchpath = MATCH |
||
) | [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. |
Implements zipios::FileCollection.
Definition at line 77 of file dircoll.cpp.
int zipios::DirectoryCollection::size | ( | ) | const [virtual] |
Returns the number of entries in the FileCollection.
InvalidStateException | Thrown if the collection is invalid. |
Reimplemented from zipios::FileCollection.
Definition at line 107 of file dircoll.cpp.