twisted.python.roots.Collection
class documentationtwisted.python.roots
View Source
(View In Hierarchy)
Known subclasses: twisted.python.roots.Constrained
I represent a static collection of entities.
I contain methods designed to represent collections that can be dynamically created.
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 | putEntity | Store a static reference on 'name' for 'entity'. |
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. |
Initialize me.
Get an entity that was added to me using putEntity.
This method will return 'None' if it fails.
Subclass this to generate an entity on demand.
This method should return 'None' if it fails.
Retrieve an entity from me.
I will first attempt to retrieve an entity statically; static entities will obscure dynamic ones. If that fails, I will retrieve the entity dynamically.
If I cannot retrieve an entity, I will return 'None'.
Store a static reference on 'name' for 'entity'.
Raises a KeyError if the operation fails.
Remove a static reference for 'name'.
Raises a KeyError if the operation fails.
Store an entity for 'name', based on the content of 'request'.
Remove an entity for 'name', based on the content of 'request'.
Retrieve a list of all name, entity pairs that I store references to.
See getStaticEntity.
A list of all name, entity that I can generate on demand.
See getDynamicEntity.
Retrieve a list of all name, entity pairs I contain.
See getEntity.
Retrieve a list of the names of entities that I store references to.
See getStaticEntity.
Retrieve a list of the names of entities that I store references to.
See getDynamicEntity.
Retrieve a list of all names for entities that I contain.
See getEntity.