t.p.r.Constrained(Collection) : class documentation

Part of twisted.python.roots View Source View In Hierarchy

Known subclasses: twisted.python.roots.Homogenous, twisted.python.roots.Locked

A collection that has constraints on its names and/or entities.
Method nameConstraint A method that determines whether an entity may be added to me with a given name.
Method entityConstraint A method that determines whether an entity may be added to me.
Method reallyPutEntity Undocumented
Method putEntity Store an entity if it meets both constraints.

Inherited from Collection:

Method __init__ Initialize me.
Method getStaticEntity Get an entity that was added to me using putEntity.
Method getDynamicEntity Subclass this to generate an entity on demand.
Method getEntity Retrieve an entity from me.
Method delEntity Remove a static reference for 'name'.
Method storeEntity Store an entity for 'name', based on the content of 'request'.
Method removeEntity Remove an entity for 'name', based on the content of 'request'.
Method listStaticEntities Retrieve a list of all name, entity pairs that I store references to.
Method listDynamicEntities A list of all name, entity that I can generate on demand.
Method listEntities Retrieve a list of all name, entity pairs I contain.
Method listStaticNames Retrieve a list of the names of entities that I store references to.
Method listDynamicNames Retrieve a list of the names of entities that I store references to.
Method listNames Retrieve a list of all names for entities that I contain.
def nameConstraint(self, name): (source)
A method that determines whether an entity may be added to me with a given name.

If the constraint is satisfied, return 1; if the constraint is not satisfied, either return 0 or raise a descriptive ConstraintViolation.

def entityConstraint(self, entity): (source)
A method that determines whether an entity may be added to me.

If the constraint is satisfied, return 1; if the constraint is not satisfied, either return 0 or raise a descriptive ConstraintViolation.

def reallyPutEntity(self, name, entity): (source)
Undocumented
def putEntity(self, name, entity): (source)
Store an entity if it meets both constraints.

Otherwise raise a ConstraintViolation.

API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.