ipersistenceprovider.java

eclipseme的最新版本的source,欢迎j2me程序员使用

/**
 * Copyright (c) 2003-2005 Craig Setera
 * All Rights Reserved.
 * Licensed under the Eclipse Public License - v 1.0
 * For more information see http://www.eclipse.org/legal/epl-v10.html
 */
package eclipseme.core.persistence;

import java.util.Properties;

/**
 * Instances of this interface provide facilities for storing
 * and retrieving persistable objects.
 * <p />
 * Copyright (c) 2003-2005 Craig Setera<br>
 * All Rights Reserved.<br>
 * Licensed under the Eclipse Public License - v 1.0<p/>
 * <br>
 * $Revision: 1.1 $
 * <br>
 * $Date: 2006/02/11 21:26:57 $
 * <br>
 * @author Craig Setera
 */
public interface IPersistenceProvider {
	/**
	 * Load the named boolean value.
	 * 
	 * @param name
	 * @return
	 * @throws PersistenceException
	 */
	public boolean loadBoolean(String name) throws PersistenceException;
	
	/**
	 * Load the named integer value.
	 * 
	 * @param name
	 * @return
	 * @throws PersistenceException
	 */
	public int loadInteger(String name) throws PersistenceException;
	
	/**
	 * Load the named persistable object value.
	 * 
	 * @param name
	 * @return
	 * @throws PersistenceException
	 */
	public IPersistable loadPersistable(String name) throws PersistenceException;

	/**
	 * Load the named properties object value.
	 * 
	 * @param name
	 * @return
	 * @throws PersistenceException
	 */
	public Properties loadProperties(String name) throws PersistenceException;
	
	/**
	 * Load the referenced object value or <code>null</code> if the object
	 * cannot be resolved.
	 * 
	 * @param name
	 * @return
	 * @throws PersistenceException
	 */
	public Object loadReference(String name) throws PersistenceException;
	
	/**
	 * Load the named string value.
	 * 
	 * @param name
	 * @return
	 * @throws PersistenceException
	 */
	public String loadString(String name) throws PersistenceException;

	/**
	 * Store the boolean value using the specified name.
	 * 
	 * @param name
	 * @param debugServer
	 * @throws PersistenceException
	 */
	public void storeBoolean(String name, boolean debugServer) throws PersistenceException;

	/**
	 * Store the integer value using the specified name.
	 * 
	 * @param name
	 * @param value
	 * @throws PersistenceException
	 */
	public void storeInteger(String name, int value) throws PersistenceException;
	
	/**
	 * Store the persistable object value using the specified name.
	 * 
	 * @param name
	 * @param value
	 * @throws PersistenceException
	 */
	public void storePersistable(String name, IPersistable value) throws PersistenceException;
	
	/**
	 * Store the properties object value using the specified name.
	 * 
	 * @param name
	 * @param deviceProperties
	 * @throws PersistenceException
	 */
	public void storeProperties(String name, Properties deviceProperties) throws PersistenceException;

	/**
	 * Store a reference to the specified object using the specified name.
	 * This object must have previously been stored by this persistence 
	 * provider or a persistence exception will be thrown.
	 * 
	 * @param name
	 * @param referenceObject
	 * @throws PersistenceException
	 */
	public void storeReference(String name, Object referenceObject) throws PersistenceException;
	
	/**
	 * Store the string value using the specified name.
	 * 
	 * @param name
	 * @param string
	 * @throws PersistenceException
	 */
	public void storeString(String name, String string) throws PersistenceException;
}