CedarBackup2.extend.split.SplitConfig

Package CedarBackup2 :: Package extend :: Module split :: Class SplitConfig

[show private | hide private]

Type SplitConfig

object --+
         |
        SplitConfig

Class representing split configuration.

Split configuration is used for splitting staging directories.

The following restrictions exist on data in this class:

The size limit must be a ByteQuantity
The split size must be a ByteQuantity

Method Summary
	`__init__(self, sizeLimit, splitSize)` Constructor for the `SplitCOnfig` 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.
	`_getSizeLimit(self)` Property target used to get the size limit.
	`_getSplitSize(self)` Property target used to get the split size.
	`_setSizeLimit(self, value)` Property target used to set the size limit.
	`_setSplitSize(self, value)` Property target used to set the split size.
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
	`sizeLimit`: Size limit, as a ByteQuantity
	`splitSize`: Split size, as a ByteQuantity

Method Details

init(self, sizeLimit=None, splitSize=None)
(Constructor)

Constructor for the SplitCOnfig class.

Parameters:: sizeLimit - Size limit of the files, in bytes; splitSize - Size that files exceeding the limit will be split into, in bytes

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

_getSizeLimit(self)

Property target used to get the size limit.

_getSplitSize(self)

Property target used to get the split size.

_setSizeLimit(self, value)

Property target used to set the size limit. If not None, the value must be a ByteQuantity object.

Raises:: ValueError - If the value is not a ByteQuantity

_setSplitSize(self, value)

Property target used to set the split size. If not None, the value must be a ByteQuantity object.

Raises:: ValueError - If the value is not a ByteQuantity

Property Details

sizeLimit

Size limit, as a ByteQuantity

Get Method:: _getSizeLimit(self)
Set Method:: _setSizeLimit(self, value)

splitSize

Split size, as a ByteQuantity

Get Method:: _getSplitSize(self)
Set Method:: _setSplitSize(self, value)

Generated by Epydoc 2.1 on Sun Mar 25 20:30:08 2007

http://epydoc.sf.net