RiceXmlListGetterListener (Rice Client Contrib 1910.0005 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

PermissionsXmlDTO, RoleMembersXmlDTO.WithinRole, RolePermissionsXmlDTO.WithinRole, RolesXmlDTO
```
public interface RiceXmlListGetterListener<E,T>
extends Serializable
```
Helper interface for use with the RiceXmlExportList class.
If semi-"streaming" of child elements is desired during JAXB marshalling, then the parent element assigns an instance of RiceXmlExportList to the appropriate list field/property, and gives the list an implementation of this interface for the list to invoke whenever it needs to create a new instance of the next child element. This allows the implementation to create and then discard child elements during marshalling.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`E`	`gettingNextItem(T nextItem, int index)`	A listener method that converts the given item into the one expected by the list.

- Method Detail
  - gettingNextItem
```
E gettingNextItem(T nextItem,
                  int index)
```
    A listener method that converts the given item into the one expected by the list. It is invoked whenever the associated list's "get" method is called.
    
    Parameters:
    
    nextItem - The item to convert.
    
    index - The index being accessed on the RiceXmlExportList instance.
    
    Returns:
    
    The converted element that the list is expected to return.