org.opencms.workplace.tools
Interface I_CmsIdentifiableObjectContainer

All Known Implementing Classes:
CmsIdentifiableObjectContainer

public interface I_CmsIdentifiableObjectContainer

Container for identifiable objects.

Since:
6.0.0
Version:
$Revision: 1.3 $
Author:
Michael Moossen

Method Summary
 void addIdentifiableObject(java.lang.String id, java.lang.Object object)
          Appends the specified object to the end of this container.
 void addIdentifiableObject(java.lang.String id, java.lang.Object object, float position)
          Inserts the specified object at the specified position in this container.
 void clear()
          Resets the container.
 java.util.List elementList()
          Returns the list of objects.
 java.lang.Object getObject(java.lang.String id)
          Returns an object by id.
 

Method Detail

addIdentifiableObject

public void addIdentifiableObject(java.lang.String id,
                                  java.lang.Object object)
Appends the specified object to the end of this container.

Parameters:
id - the object identifier
object - the object add to the container
See Also:
List.add(Object)

addIdentifiableObject

public void addIdentifiableObject(java.lang.String id,
                                  java.lang.Object object,
                                  float position)
Inserts the specified object at the specified position in this container.

Shifts the object currently at that position (if any) and any subsequent objects to the right (adds one to their indices).

Parameters:
id - the object identifier
object - the object add to the container
position - the insertion point
See Also:
List.add(int, Object)

clear

public void clear()
Resets the container.


elementList

public java.util.List elementList()
Returns the list of objects.

Returns:
the a list of Objects.

getObject

public java.lang.Object getObject(java.lang.String id)
Returns an object by id.

Parameters:
id - the id of the object
Returns:
the object if found, or null
See Also:
Map.get(Object)