View Javadoc

1   /* (c) Copyright 2003 Caleigo AB, All rights reserved. 
2    * 
3    * This library is free software; you can redistribute it and/or
4    * modify it under the terms of the GNU Lesser General Public
5    * License as published by the Free Software Foundation; either
6    * version 2.1 of the License, or (at your option) any later version.
7    * 
8    * This library is distributed in the hope that it will be useful,
9    * but WITHOUT ANY WARRANTY; without even the implied warranty of
10   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11   * Lesser General Public License for more details.
12   * 
13   * You should have received a copy of the GNU Lesser General Public
14   * License along with this library; if not, write to the Free Software
15   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16   *  
17   */
18  
19  package org.caleigo.core;
20  
21  /*** The IPropertyProvider interface provides three basic methods to access
22   * named property objects.
23   *
24   * @author  Dennis Zikovic
25   * @version 1.00
26   * 
27   *//* 
28   *
29   * WHEN        WHO               WHY & WHAT
30   * ------------------------------------------------------------------------------
31   * 2001-07-04  Dennis Zikovic    Creation
32   */
33  public interface IPropertyProvider 
34  {
35      /*** Access method that returns the named property object or null if the
36       * property name could not be identified.
37       */
38      public Object getProperty(String propertyName);
39      
40      /*** Access method that returns the named property object or the provided 
41       * default value object if the property name could not be identified.
42       */
43      public Object getProperty(String propertyName, Object defaultValue);
44      
45      /*** Mutation methods that sets the named property to the provided property
46       * object. If the property value is null then the property may be deleted.
47       */
48      public void setProperty(String propertyName, Object propertyValue);
49  }