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

Type ReferenceConfig

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.

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. We don't do any validation on the contents of any of the fields, although we generally expect them to be strings.
Method Summary
  __init__(self, author, revision, description, generator)
Constructor for the ReferenceConfig 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
  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.

Method Details

__init__(self, author=None, revision=None, description=None, generator=None)
(Constructor)

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:
__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.

Property Details

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.

Generated by Epydoc 2.1 on Thu Mar 29 20:58:26 2007 http://epydoc.sf.net