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

Type RestrictedContentList

object --+        
         |        
      list --+    
             |    
 UnorderedList --+
                 |
                RestrictedContentList


Class representing a list containing only object with certain values.

This is an unordered list.

We override the append, insert and extend methods to ensure that any item added to the list is among the valid values. We use a standard comparison, so pretty much anything can be in the list of valid values.

The valuesDescr value will be used in exceptions, i.e. "Item must be one of values in VALID_ACTIONS" if valuesDescr is "VALID_ACTIONS".
Method Summary
  __init__(self, valuesList, valuesDescr)
Initializes a list restricted to containing certain values.
  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)
  __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(cmpfunc=None) -- stable sort *IN PLACE*; cmpfunc(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, valuesList, valuesDescr)
(Constructor)

Initializes a list restricted to containing certain values.
Parameters:
valuesList - List of valid values.
valuesDescr - Short string describing list of values.
Overrides:
__builtin__.list.__init__

append(self, item)

Overrides the standard append method.
Raises:
ValueError - If item is not in the values list.
Overrides:
__builtin__.list.append

extend(self, seq)

Overrides the standard insert method.
Raises:
ValueError - If item is not in the values list.
Overrides:
__builtin__.list.extend

insert(self, index, item)

Overrides the standard insert method.
Raises:
ValueError - If item is not in the values list.
Overrides:
__builtin__.list.insert

Generated by Epydoc 2.1 on Thu Dec 22 20:45:13 2005 http://epydoc.sf.net