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

Class CollectFile

source code

object --+
         |
        CollectFile

Class representing a Cedar Backup collect file.

The following restrictions exist on data in this class:

Instance Methods [hide private]
 
__init__(self, absolutePath=None, collectMode=None, archiveMode=None)
Constructor for the CollectFile class.
source code
 
__repr__(self)
Official string representation for class instance.
source code
 
__str__(self)
Informal string representation for class instance.
source code
 
__cmp__(self, other)
Original Python 2 comparison operator.
source code
 
__eq__(self, other)
Equals operator, implemented in terms of original Python 2 compare operator.
source code
 
__lt__(self, other)
Less-than operator, implemented in terms of original Python 2 compare operator.
source code
 
__gt__(self, other)
Greater-than operator, implemented in terms of original Python 2 compare operator.
source code
 
_setAbsolutePath(self, value)
Property target used to set the absolute path.
source code
 
_getAbsolutePath(self)
Property target used to get the absolute path.
source code
 
_setCollectMode(self, value)
Property target used to set the collect mode.
source code
 
_getCollectMode(self)
Property target used to get the collect mode.
source code
 
_setArchiveMode(self, value)
Property target used to set the archive mode.
source code
 
_getArchiveMode(self)
Property target used to get the archive mode.
source code
 
__ge__(x, y)
x>=y
 
__le__(x, y)
x<=y

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties [hide private]
  absolutePath
Absolute path of the file to collect.
  collectMode
Overridden collect mode for this file.
  archiveMode
Overridden archive mode for this file.

Inherited from object: __class__

Method Details [hide private]

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

source code 

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: object.__init__

__repr__(self)
(Representation operator)

source code 

Official string representation for class instance.

Overrides: object.__repr__

__str__(self)
(Informal representation operator)

source code 

Informal string representation for class instance.

Overrides: object.__str__

__cmp__(self, other)
(Comparison operator)

source code 

Original Python 2 comparison operator.

Parameters:
  • other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

_setAbsolutePath(self, value)

source code 

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.

_setCollectMode(self, value)

source code 

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.

_setArchiveMode(self, value)

source code 

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.

Property Details [hide private]

absolutePath

Absolute path of the file to collect.

Get Method:
_getAbsolutePath(self) - Property target used to get the absolute path.
Set Method:
_setAbsolutePath(self, value) - Property target used to set the absolute path.

collectMode

Overridden collect mode for this file.

Get Method:
_getCollectMode(self) - Property target used to get the collect mode.
Set Method:
_setCollectMode(self, value) - Property target used to set the collect mode.

archiveMode

Overridden archive mode for this file.

Get Method:
_getArchiveMode(self) - Property target used to get the archive mode.
Set Method:
_setArchiveMode(self, value) - Property target used to set the archive mode.