Class Directory

object --+    
         |    
     _File --+
             |
            Directory

NAME
====

B{C{Directory}} - Define a directory filestream helper.

SYNOPSIS
========

C{Directory([I{requires}, I{provides}, I{flavor}, I{mode}, I{owner}, I{group}, I{tags}])}

DESCRIPTION
===========

The C{Directory} class defines a directory filestream helper.

PARAMETERS
==========
The following parameters apply to the Directory class.

B{requires}: (None) Marks this directory with the specified requirements.
This parameter is a deps.Dependency object.

B{provides}: (None) Marks this directory as providing certain features or
characteristics.  This parameter is a deps.Dependency object.

B{flavor}: (None) Marks this directory with the specified flavor.  File
flavors are aggregated to determine trove flavors.  This parameter
is a deps.Flavor object.

B{owner}: ('root') Marks this directory as owned by I{owner}.
This parameter is a string

B{group}: ('root') Marks this directory as belonging to I{group}.  This
parameter is a string

B{mode}: (0644) Defines the access permissons of this directory.  This
parameter is an integer.

B{tags} : (None) Tags associated with this directory.  When a file with a
tag is installed, removed, or changed, the listed tag handler is executed.
See documentation on tag handlers for more information.  This parameter
is a list of strings.

USER COMMANDS
=============
The following user commands are applicable to C{Directory}:

    - L{get(I{pathId})} : Returns a filestream with the settings
      represented by this class.

EXAMPLES
========

C{dir = Directory(contents = 'foo')}
C{dir.get()}

Creates a directory filestream helper, and retrieves the filestream
associated with it.