Package CedarBackup2 :: Module config :: Class CollectFile
[show private | hide private]
[frames | no frames]

Type CollectFile

object --+
         |
        CollectFile


Class representing a Cedar Backup collect file.

As with all of the other classes that represent configuration sections, all of these values are optional. It is up to some higher-level construct to decide whether everything they need is filled in. Some validation is done on non-None assignments through the use of the Python property() construct.

The following restrictions exist on data in this class:
Method Summary
  __init__(self, absolutePath, collectMode, archiveMode)
Constructor for the CollectFile 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.
  _getAbsolutePath(self)
Property target used to get the absolute path.
  _getArchiveMode(self)
Property target used to get the archive mode.
  _getCollectMode(self)
Property target used to get the collect mode.
  _setAbsolutePath(self, value)
Property target used to set the absolute path.
  _setArchiveMode(self, value)
Property target used to set the archive mode.
  _setCollectMode(self, value)
Property target used to set the collect mode.
    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
  absolutePath: Absolute path of the file to collect.
  collectMode: Overridden collect mode for this file.
  archiveMode: Overridden archive mode for this file.

Method Details

__init__(self, absolutePath=None, collectMode=None, archiveMode=None)
(Constructor)

Constructor for the CollectFile class.
Parameters:
absolutePath - Absolute path of the file to collect.
collectMode - Overridden collect mode for this file.
archiveMode - Overridden archive mode for this file.
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.
Parameters:
other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

_getAbsolutePath(self)

Property target used to get the absolute path.

_getArchiveMode(self)

Property target used to get the archive mode.

_getCollectMode(self)

Property target used to get the collect mode.

_setAbsolutePath(self, value)

Property target used to set the absolute path. The value must be an absolute path if it is not None. It does not have to exist on disk at the time of assignment.
Raises:
ValueError - If the value is not an absolute path.
ValueError - If the value cannot be encoded properly.

_setArchiveMode(self, value)

Property target used to set the archive mode. If not None, the mode must be one of the values in VALID_ARCHIVE_MODES.
Raises:
ValueError - If the value is not valid.

_setCollectMode(self, value)

Property target used to set the collect mode. If not None, the mode must be one of the values in VALID_COLLECT_MODES.
Raises:
ValueError - If the value is not valid.

Property Details

absolutePath

Absolute path of the file to collect.
Get Method:
_getAbsolutePath(self)
Set Method:
_setAbsolutePath(self, value)

collectMode

Overridden collect mode for this file.
Get Method:
_getCollectMode(self)
Set Method:
_setCollectMode(self, value)

archiveMode

Overridden archive mode for this file.
Get Method:
_getArchiveMode(self)
Set Method:
_setArchiveMode(self, value)

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