#include <dircoll.h>
|
void | loadEntries () const |
|
void | load (bool recursive, const FilePath &subdir=FilePath()) |
|
|
bool | _entries_loaded |
|
bool | _recursive |
|
FilePath | _filepath |
|
string | _filename |
|
Entries | _entries |
|
bool | _valid |
|
|
enum | MatchPath { IGNORE,
MATCH
} |
|
DirectoryCollection is a FileCollection that obtains its entries from a directory.
Definition at line 19 of file dircoll.h.
zipios::DirectoryCollection::DirectoryCollection |
( |
| ) |
|
|
inlineexplicit |
Default Constructor.
Definition at line 23 of file dircoll.h.
zipios::DirectoryCollection::DirectoryCollection |
( |
const string & |
path, |
|
|
bool |
recursive = true , |
|
|
bool |
load_now = false |
|
) |
| |
|
explicit |
Constructor.
- Parameters
-
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 20 of file dircoll.cpp.
zipios::DirectoryCollection::~DirectoryCollection |
( |
| ) |
|
|
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.
- Returns
- A heap allocated copy of the object this method is called for.
Implements zipios::FileCollection.
Definition at line 114 of file dircoll.cpp.
void zipios::DirectoryCollection::close |
( |
| ) |
|
|
virtual |
ConstEntries zipios::DirectoryCollection::entries |
( |
| ) |
const |
|
virtual |
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.
- Parameters
-
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. |
- Returns
- A ConstEntryPointer to the found entry. The returned pointer equals zero if no entry is found.
- Exceptions
-
Reimplemented from zipios::FileCollection.
Definition at line 49 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.
- Parameters
-
entry | A ConstEntryPointer to the FileEntry to get an istream to. |
- Returns
- an open istream for the specified entry. The istream is allocated on heap and it is the users responsibility to delete it when he is done with it.
- Exceptions
-
Implements zipios::FileCollection.
Definition at line 68 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.
- Parameters
-
matchpath | Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be ignored. |
- Returns
- an open istream for the specified entry. The istream is allocated on heap and it is the users responsibility to delete it when he is done with it.
- Exceptions
-
Implements zipios::FileCollection.
Definition at line 76 of file dircoll.cpp.
int zipios::DirectoryCollection::size |
( |
| ) |
const |
|
virtual |
The documentation for this class was generated from the following files: