CedarBackup2.config.ReferenceConfig

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

# Class ReferenceConfig

source code

    object --+
             |
            ReferenceConfig

Class representing a Cedar Backup reference configuration.

The reference information is just used for saving off metadata about configuration and exists mostly for backwards-compatibility with Cedar Backup 1.x.

Instance Methods | [hide private]
__init__(self, author=None, revision=None, description=None, generator=None) Constructor for the `ReferenceConfig` 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
_setAuthor(self, value) Property target used to set the author value. | source code
_getAuthor(self) Property target used to get the author value. | source code
_setRevision(self, value) Property target used to set the revision value. | source code
_getRevision(self) Property target used to get the revision value. | source code
_setDescription(self, value) Property target used to set the description value. | source code
_getDescription(self) Property target used to get the description value. | source code
_setGenerator(self, value) Property target used to set the generator value. | source code
_getGenerator(self) Property target used to get the generator value. | source code
Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties | [hide private]
| author Author of the configuration file.
| revision Revision of the configuration file.
| description Description of the configuration file.
| generator Tool that generated the configuration file.
Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, author=None, revision=None, description=None, generator=None) (Constructor) | source code
Constructor for the `ReferenceConfig` class. Parameters: `author` - Author of the configuration file. `revision` - Revision of the configuration file. `description` - Description of the configuration file. `generator` - Tool that generated the configuration file. 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. Parameters: `other` - Other object to compare to. Returns: -1/0/1 depending on whether self is `<`, `=` or `>` other.

### _setAuthor(self, value) | source code
Property target used to set the author value. No validations.

### _setRevision(self, value) | source code
Property target used to set the revision value. No validations.

### _setDescription(self, value) | source code
Property target used to set the description value. No validations.

### _setGenerator(self, value) | source code
Property target used to set the generator value. No validations.

Property Details | [hide private]

### author Author of the configuration file. Get Method: _getAuthor(self) - Property target used to get the author value. Set Method: _setAuthor(self, value) - Property target used to set the author value.

### revision Revision of the configuration file. Get Method: _getRevision(self) - Property target used to get the revision value. Set Method: _setRevision(self, value) - Property target used to set the revision value.

### description Description of the configuration file. Get Method: _getDescription(self) - Property target used to get the description value. Set Method: _setDescription(self, value) - Property target used to set the description value.

### generator Tool that generated the configuration file. Get Method: _getGenerator(self) - Property target used to get the generator value. Set Method: _setGenerator(self, value) - Property target used to set the generator value.