I_CmsIdentifiableObjectContainer


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/util/I_CmsIdentifiableObjectContainer.java,v $
3    * Date   : $Date: 2006/03/27 14:52:41 $
4    * Version: $Revision: 1.6 $
5    *
6    * This library is part of OpenCms -
7    * the Open Source Content Mananagement System
8    *
9    * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10   *
11   * This library is free software; you can redistribute it and/or
12   * modify it under the terms of the GNU Lesser General Public
13   * License as published by the Free Software Foundation; either
14   * version 2.1 of the License, or (at your option) any later version.
15   *
16   * This library is distributed in the hope that it will be useful,
17   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   * Lesser General Public License for more details.
20   *
21   * For further information about Alkacon Software GmbH, please see the
22   * company website: http://www.alkacon.com
23   *
24   * For further information about OpenCms, please see the
25   * project website: http://www.opencms.org
26   * 
27   * You should have received a copy of the GNU Lesser General Public
28   * License along with this library; if not, write to the Free Software
29   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30   */
31  
32  package org.opencms.util;
33  
34  import java.util.List  ;
35  
36  /**
37   * Container for identifiable objects.<p>
38   * 
39   * @author Michael Moossen  
40   * 
41   * @version $Revision: 1.6 $ 
42   * 
43   * @since 6.0.0 
44   */
45  public interface I_CmsIdentifiableObjectContainer {
46  
47      // TODO: This interface should really be in a workplace package!
48      int todo = 0;
49  
50      /**
51       * Appends the specified object to the end of this container. <p>
52       * 
53       * @param id the object identifier
54       * @param object the object add to the container
55       * 
56       * @see java.util.List#add(Object)
57       */
58      void addIdentifiableObject(String   id, Object   object);
59  
60      /**
61       * Inserts the specified object at the specified position in this container.<p>
62       * 
63       * Shifts the object currently at that position (if any) and any subsequent 
64       * objects to the right (adds one to their indices).<p>
65       * 
66       * @param id the object identifier
67       * @param object the object add to the container
68       * @param position the insertion point
69       * 
70       * @see java.util.List#add(int, Object)
71       */
72      void addIdentifiableObject(String   id, Object   object, float position);
73  
74      /**
75       * Resets the container.<p>
76       */
77      void clear();
78  
79      /**
80       * Returns the list of objects.<p>
81       *
82       * @return the a list of <code>{@link Object}</code>s.
83       */
84      List   elementList();
85  
86      /**
87       * Returns an object by id.<p>
88       * 
89       * @param id the id of the object
90       * 
91       * @return the object if found, or <code>null</code>
92       * 
93       * @see java.util.Map#get(Object)
94       */
95      Object   getObject(String   id);
96  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags