ObjectWrapper

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

DisposeListener

All Known Implementing Classes:

ObjectWrapperImpl
```
public interface ObjectWrapper
extends DisposeListener
```
Interface that all ObjectWrapper types must implement.

Since:

ITIM 5.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`dispose()` Instruct the ObjectWrapper to remove itself from the ObjectWrapperManager, freeing up resources.
`java.lang.String`	`getKey()` Get the unique key that can be used with the ObjectWrapperManager to get at any object that the implementation of this interface is wrapping.
`void`	`setKey(java.lang.String key)` Set the unique key that can used with ObjectWrapperManager to get at any object the the implementation of this interface is wrapping.

- Method Detail
  - dispose
```
void dispose()
```
    Instruct the ObjectWrapper to remove itself from the ObjectWrapperManager, freeing up resources. Any ObjectWrapper that contains other ObjectWrappers should call dispose on all contained ObjectWrappers.
    
    Specified by:
    
    dispose in interface DisposeListener
  - getKey
```
java.lang.String getKey()
```
    Get the unique key that can be used with the ObjectWrapperManager to get at any object that the implementation of this interface is wrapping. This key should only be set by the ObjectWrapperManager.
    
    Returns:
    
    The unique key used to identify any wrapped object in ObjectWapperManager.
  - setKey
```
void setKey(java.lang.String key)
```
    Set the unique key that can used with ObjectWrapperManager to get at any object the the implementation of this interface is wrapping. This method should only be used by ObjectWrapperManager.
    
    Parameters:
    
    key - The key to set for this object.