ubc.cs.JLog.Foundation.iAttributes Maven / Gradle / Ivy

Go to download
/*
    This file is part of JLog.

    Created by Glendon Holst for Alan Mackworth and the 
    "Computational Intelligence: A Logical Approach" text.
    
    Copyright 1998, 2000, 2002 by University of British Columbia and 
    Alan Mackworth.
    
    This notice must remain in all files which belong to, or are derived 
    from JLog.
    
    Check  or 
     for further information
    about JLog, or to contact the authors.
     
    JLog is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    JLog is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with JLog; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    URLs:  or 
*/
//#########################################################################
//	Attributes
//#########################################################################

package ubc.cs.JLog.Foundation;

import java.lang.*;
import java.util.*;

/**
* An inteface to represent getting and setting attribute Key-Value pairs via Hashtables.
*  
* @author       Glendon Holst
* @version      %I%, %G%
*/
public interface iAttributes
{

 /**
  * Returns a hashtable of every attribute associated with this object.  Each attribute must
  * have a String name key, and its associated value (non-null).
  *
  * @return		The Hashtable of attribute name-value pairings.
  */
 public Hashtable   getAttributes();
 
 /**
  * Set the attributes of the object to those in the given Hashtable.  Errors such as 
  * Non-applicable attributes, or invalid values can be handled as the receiving object
  * prefers (e.g., silently ignore, or throw exception).
  *
  * @param attributes		The Hashtable of attribute name-value pairings.
  */
 public void		setAttributes(Hashtable attributes);
 
};