List of all members.
Public Member Functions |
| Object | add (Object collection, Object object) throws ClassCastException |
| Enumeration | elements (Object collection) throws ClassCastException |
| int | size (Object collection) throws ClassCastException |
| Object | clear (Object collection) throws ClassCastException |
Detailed Description
Collection handler for adding/listing elements of a collection. A collection field will use this handler to add elements when it's value is set, and to enumerate then when it's value is retrieved. A collection handler is instantiated only once, must be thread safe and not use any synchronization.
- Author:
- Assaf Arkin
- Version:
- Revision:
- 1.1.1.1
- Date:
- 2003/03/03 07:08:26
Member Function Documentation
| Object org.exolab.castor.mapping.CollectionHandler.add |
( |
Object |
collection, |
|
|
Object |
object | |
|
) |
| | throws ClassCastException |
Add an object to the collection. A collection may not allow the same object to be added more than once. The collection is provided as a parameter and is returned as the return value if the returned collection is a different object. That way the handler can create a new collection or change the collection as necessary (e.g. when resizing an array).
- Parameters:
-
| collection | The collection, null if no collection has been created yet |
| object | The object to add to the collection |
- Returns:
- The collection with the new object if a different instance than the
collection parameter, null otherwise
- Exceptions:
-
| ClassCastException | The collection handler does not support collections of this type |
Referenced by org.exolab.castor.mapping.loader.FieldHandlerImpl.setValue().
| Object org.exolab.castor.mapping.CollectionHandler.clear |
( |
Object |
collection |
) |
throws ClassCastException |
Clears the collection of any objects. The collection is provided as a parameter and is returned as the return value if the returned collection is a different object. That way the handler can create a new collection or change the collection as necessary (e.g. when resizing an array).
- Parameters:
-
| collection | The collection, null if no collection has been created yet |
- Returns:
- The empty collection if a different instance than the
collection parameter, null otherwise
- Exceptions:
-
| ClassCastException | The collection handler does not support collections of this type |
Referenced by org.exolab.castor.mapping.loader.FieldHandlerImpl.resetValue().
| Enumeration org.exolab.castor.mapping.CollectionHandler.elements |
( |
Object |
collection |
) |
throws ClassCastException |
| int org.exolab.castor.mapping.CollectionHandler.size |
( |
Object |
collection |
) |
throws ClassCastException |
Returns the number of elements in the collection.
- Parameters:
-
| collection | The collection |
- Returns:
- Number of elements in the collection
- Exceptions:
-
| ClassCastException | The collection handler does not support collections of this type |
The documentation for this interface was generated from the following file:
1.7.0