Package CedarBackup2 :: Package extend :: Module split :: Class SplitConfig
[hide private]
[frames] | no frames]

Class SplitConfig

source code

object --+
         |
        SplitConfig

Class representing split configuration.

Split configuration is used for splitting staging directories.

The following restrictions exist on data in this class:

Instance Methods [hide private]
 
__init__(self, sizeLimit=None, splitSize=None)
Constructor for the SplitCOnfig 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
 
_setSizeLimit(self, value)
Property target used to set the size limit.
source code
 
_getSizeLimit(self)
Property target used to get the size limit.
source code
 
_setSplitSize(self, value)
Property target used to set the split size.
source code
 
_getSplitSize(self)
Property target used to get the split size.
source code

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

Properties [hide private]
  sizeLimit
Size limit, as a ByteQuantity
  splitSize
Split size, as a ByteQuantity

Inherited from object: __class__

Method Details [hide private]

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

source code 
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: 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.

_setSizeLimit(self, value)

source code 
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)

source code 
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 [hide private]

sizeLimit

Size limit, as a ByteQuantity
Get Method:
CedarBackup2.extend.split.SplitConfig._getSizeLimit(self) - Property target used to get the size limit.
Set Method:
CedarBackup2.extend.split.SplitConfig._setSizeLimit(self, value) - Property target used to set the size limit.

splitSize

Split size, as a ByteQuantity
Get Method:
CedarBackup2.extend.split.SplitConfig._getSplitSize(self) - Property target used to get the split size.
Set Method:
CedarBackup2.extend.split.SplitConfig._setSplitSize(self, value) - Property target used to set the split size.