Package CedarBackup2 :: Package extend :: Module mbox :: Class MboxConfig
[show private | hide private]
[frames | no frames]

Type MboxConfig

object --+
         |
        MboxConfig


Class representing mbox configuration.

Mbox configuration is used for backing up mbox email files.

The following restrictions exist on data in this class:

For the mboxFiles and mboxDirs lists, validation is accomplished through the util.ObjectTypeList list implementation that overrides common list methods and transparently ensures that each element is of the proper type.

Unlike collect configuration, no global exclusions are allowed on this level. We only allow relative exclusions at the mbox directory level. Also, there is no configured ignore file. This is because mbox directory backups are not recursive.

Note: Lists within this class are "unordered" for equality comparisons.

Method Summary
  __init__(self, collectMode, compressMode, mboxFiles, mboxDirs)
Constructor for the MboxConfig class.
  __repr__(self)
Official string representation for class instance.
  __str__(self)
Informal string representation for class instance.
  __cmp__(self, other)
Definition of equals operator for this class.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Property Summary
  collectMode: Default collect mode.
  compressMode: Default compress mode.
  mboxFiles: List of mbox files to back up.
  mboxDirs: List of mbox directories to back up.

Method Details

__init__(self, collectMode=None, compressMode=None, mboxFiles=None, mboxDirs=None)
(Constructor)

Constructor for the MboxConfig class.
Parameters:
collectMode - Default collect mode.
compressMode - Default compress mode.
mboxFiles - List of mbox files to back up
mboxDirs - List of mbox directories to back up
Raises:
ValueError - If one of the values is invalid.
Overrides:
__builtin__.object.__init__

__repr__(self)
(Representation operator)

Official string representation for class instance.
Overrides:
__builtin__.object.__repr__

__str__(self)
(Informal representation operator)

Informal string representation for class instance.
Overrides:
__builtin__.object.__str__

__cmp__(self, other)
(Comparison operator)

Definition of equals operator for this class. Lists within this class are "unordered" for equality comparisons.
Parameters:
other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

Property Details

collectMode

Default collect mode.

compressMode

Default compress mode.

mboxFiles

List of mbox files to back up.

mboxDirs

List of mbox directories to back up.

Generated by Epydoc 2.1 on Mon Dec 18 22:53:30 2006 http://epydoc.sf.net