CedarBackup2.extend.subversion.SubversionConfig

Package CedarBackup2 :: Package extend :: Module subversion :: Class SubversionConfig |
[hide private]
[frames] | no frames]

# Class SubversionConfig

source code

    object --+
             |
            SubversionConfig

Class representing Subversion configuration.

Subversion configuration is used for backing up Subversion repositories.

The following restrictions exist on data in this class:

- The collect mode must be one of the values in VALID_COLLECT_MODES.
- The compress mode must be one of the values in VALID_COMPRESS_MODES.
- The repositories list must be a list of `Repository` objects.
- The repositoryDirs list must be a list of `RepositoryDir` objects.

For the two lists, validation is accomplished through the util.ObjectTypeList list implementation that overrides common list methods and transparently ensures that each element has the correct type.

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

Instance Methods | [hide private]
__init__(self, collectMode=None, compressMode=None, repositories=None, repositoryDirs=None) Constructor for the `SubversionConfig` 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) Definition of equals operator for this class. | 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
_setCompressMode(self, value) Property target used to set the compress mode. | source code
_getCompressMode(self) Property target used to get the compress mode. | source code
_setRepositories(self, value) Property target used to set the repositories list. | source code
_getRepositories(self) Property target used to get the repositories list. | source code
_setRepositoryDirs(self, value) Property target used to set the repositoryDirs list. | source code
_getRepositoryDirs(self) Property target used to get the repositoryDirs list. | source code
Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties | [hide private]
| collectMode Default collect mode.
| compressMode Default compress mode.
| repositories List of Subversion repositories to back up.
| repositoryDirs List of Subversion parent directories to back up.
Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, collectMode=None, compressMode=None, repositories=None, repositoryDirs=None) (Constructor) | source code
Constructor for the `SubversionConfig` class. Parameters: `collectMode` - Default collect mode. `compressMode` - Default compress mode. `repositories` - List of Subversion repositories to back up. `repositoryDirs` - List of Subversion parent directories to back up. 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
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.

### _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.

### _setCompressMode(self, value) | source code
Property target used to set the compress mode. If not `None`, the mode must be one of the values in VALID_COMPRESS_MODES. Raises: `ValueError` - If the value is not valid.

### _setRepositories(self, value) | source code
Property target used to set the repositories list. Either the value must be `None` or each element must be a `Repository`. Raises: `ValueError` - If the value is not a `Repository`

### _setRepositoryDirs(self, value) | source code
Property target used to set the repositoryDirs list. Either the value must be `None` or each element must be a `Repository`. Raises: `ValueError` - If the value is not a `Repository`

Property Details | [hide private]

### collectMode Default collect mode. 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.

### compressMode Default compress mode. Get Method: _getCompressMode(self) - Property target used to get the compress mode. Set Method: _setCompressMode(self, value) - Property target used to set the compress mode.

### repositories List of Subversion repositories to back up. Get Method: _getRepositories(self) - Property target used to get the repositories list. Set Method: _setRepositories(self, value) - Property target used to set the repositories list.

### repositoryDirs List of Subversion parent directories to back up. Get Method: _getRepositoryDirs(self) - Property target used to get the repositoryDirs list. Set Method: _setRepositoryDirs(self, value) - Property target used to set the repositoryDirs list.