Package CedarBackup2 :: Module util :: Class ObjectTypeList
[show private | hide private]
[frames | no frames]

Type ObjectTypeList

object --+        
         |        
      list --+    
             |    
 UnorderedList --+
                 |
                ObjectTypeList


Class representing a list containing only objects with a certain type.

This is an unordered list.

We override the append, insert and extend methods to ensure that any item added to the list matches the type that is requested. The comparison uses the built-in isinstance, which should allow subclasses of of the requested type to be added to the list as well.

The objectName value will be used in exceptions, i.e. "Item must be a CollectDir object." if objectName is "CollectDir".
Method Summary
  __init__(self, objectType, objectName)
Initializes a typed list for a particular type.
  append(self, item)
Overrides the standard append method.
  extend(self, seq)
Overrides the standard insert method.
  insert(self, index, item)
Overrides the standard insert method.
    Inherited from UnorderedList
  __eq__(self, other)
Definition of == operator for this class.
  __ge__(self, other)
Definition of ≥ operator for this class.
  __gt__(self, other)
Definition of > operator for this class.
  __le__(self, other)
Definition of ≤ operator for this class.
  __lt__(self, other)
Definition of < operator for this class.
  __ne__(self, other)
Definition of != operator for this class.
    Inherited from list
  __add__(x, y)
x.__add__(y) <==> x+y
  __contains__(x, y)
x.__contains__(y) <==> y in x
  __delitem__(x, y)
x.__delitem__(y) <==> del x[y]
  __delslice__(x, i, j)
Use of negative indices is not supported.
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __getitem__(x, y)
x.__getitem__(y) <==> x[y]
  __getslice__(x, i, j)
Use of negative indices is not supported.
  __hash__(x)
x.__hash__() <==> hash(x)
  __iadd__(x, y)
x.__iadd__(y) <==> x+=y
  __imul__(x, y)
x.__imul__(y) <==> x*=y
  __iter__(x)
x.__iter__() <==> iter(x)
  __len__(x)
x.__len__() <==> len(x)
  __mul__(x, n)
x.__mul__(n) <==> x*n
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __repr__(x)
x.__repr__() <==> repr(x)
  __reversed__(...)
L.__reversed__() -- return a reverse iterator over the list
  __rmul__(x, n)
x.__rmul__(n) <==> n*x
  __setitem__(x, i, y)
x.__setitem__(i, y) <==> x[i]=y
  __setslice__(x, i, j, y)
Use of negative indices is not supported.
  count(L, value)
L.count(value) -> integer -- return number of occurrences of value
  index(...)
L.index(value, [start, [stop]]) -> integer -- return first index of value
  pop(L, index)
L.pop([index]) -> item -- remove and return item at index (default last)
  remove(...)
L.remove(value) -- remove first occurrence of value
  reverse(...)
L.reverse() -- reverse *IN PLACE*
  sort(...)
L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*; cmp(x, y) -> -1, 0, 1
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Method Details

__init__(self, objectType, objectName)
(Constructor)

Initializes a typed list for a particular type.
Parameters:
objectType - Type that the list elements must match.
objectName - Short string containing the "name" of the type.
Overrides:
__builtin__.list.__init__

append(self, item)

Overrides the standard append method.
Raises:
ValueError - If item does not match requested type.
Overrides:
__builtin__.list.append

extend(self, seq)

Overrides the standard insert method.
Raises:
ValueError - If item does not match requested type.
Overrides:
__builtin__.list.extend

insert(self, index, item)

Overrides the standard insert method.
Raises:
ValueError - If item does not match requested type.
Overrides:
__builtin__.list.insert

Generated by Epydoc 2.1 on Mon Dec 18 22:53:32 2006 http://epydoc.sf.net