ItemMap


1   /*
2    * Copyright (C) 2003  Christian Cryder [christianc@granitepeaks.com]
3    *
4    * This library is free software; you can redistribute it and/or
5    * modify it under the terms of the GNU Lesser General Public
6    * License as published by the Free Software Foundation; either
7    * version 2.1 of the License, or (at your option) any later version.
8    *
9    * This library is distributed in the hope that it will be useful,
10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12   * Lesser General Public License for more details.
13   *
14   * You should have received a copy of the GNU Lesser General Public
15   * License along with this library; if not, write to the Free Software
16   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17   *
18   * $Id: ItemMap.java,v 1.5 2004/02/01 05:16:27 christianc Exp $
19   */
20  package org.enhydra.barracuda.core.comp;
21  
22  import java.util.*;
23  
24  
25  /**
26   * This interface defines the methods needed to implement
27   * an ItemMap object. An ItemMap can be returned by the getItem()
28   * methods within any of the model implementations. It is used to 
29   * associate a key with a particular value. It is primarily used
30   * by the BSelect component (which can use both key and value information
31   * when rendering). The other components just use the value information.
32   */
33  public interface ItemMap {
34  
35      /**
36       * Returns the key corresponding to this entry.
37       */
38      public Object   getKey();
39  
40      /**
41       * Returns the value corresponding to this entry. 
42       */           
43      public Object   getValue();
44  
45      /**
46       * Replaces the value corresponding to this entry with the specified 
47       * value (optional operation). 
48       */          
49      public Object   setValue(Object   value);
50  
51  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags