a folder in the namespace: contains other stream::Entry objects. More...
#include <nstream.h>
Inheritance diagram for nstream::Folder:
Collaboration diagram for nstream::Folder:
Public Types | |
| enum | eType { eType_Folder = 1, eType_File = 2, eType_Invalid = 0 } |
Public Member Functions | |
| virtual | ~Folder (void) throw () |
| virtual smart_ptr< Entry > | getChildByName (IN const char *name)=0 |
| get a child entry directly by its name relative to the parent (returns NULL if no such child exists) | |
| virtual void | resetIteration (void)=0 |
| reset the Folder iteration to point to the first Entry again. | |
| virtual smart_ptr< Entry > | getNextChild (void)=0 |
| get the next child Entry object. Returns null when done. | |
| virtual eType | getType (void) const =0 throw () |
| what type of entry is this? | |
| virtual const char * | getName (void) const =0 throw () |
| this Entry's name in the namespace (that is, relative to the root of the namespace). | |
| virtual smart_ptr< Manager > | getManager (void)=0 |
| the Manager of this namespace | |
Detailed Description
a folder in the namespace: contains other stream::Entry objects.
The iteration model for Folders is very primitive. That is intentional. If you want multiple iterators for a given Folder at the same time, create multiple Folder objects. Remember that you may be creating expensive iterators underneath (open directory handles, database cursors, etc.) so in general keeping multiple iterators open at the same time is discouraged anyway.
Notes to users and implementers:
- Keep in mind that Folders may contain many thousands of child Entry objects--or more.
- The iteration should visit every sub-Entry once and only once, but there is no guarantee about ordering. In particular, callers should assume that child objects are NOT in lexigraphic order.
- A new Folder object should have its iterator already reset and ready for calls to getNextChild(). That is, it is not required to call resetIteration() for the first iteration loop. resetIteration() is a convenience method in case people want to iterate multiple times.
- There are sometimes odd semantics about iteration. For instance, native filesystem directory listings often contain "." (self) and ".." (parent). The semantics of nstream::Folder iteration are clear: any and all child Entry objects should be returned. But non-child Entries will not. And so, for instance, "." and ".." would not be returned when iterating over a filesystem-based Folder.
Definition at line 197 of file nstream.h.
Member Enumeration Documentation
enum nstream::Entry::eType [inherited] |
Constructor & Destructor Documentation
| nstream::Folder::~Folder | ( | void | ) | throw () [virtual] |
Definition at line 49 of file nstream.cpp.
The documentation for this class was generated from the following files:
