XmlSettingsReaderWriter.java

/*
 * Copyright 2002-2004 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.springframework.richclient.settings.xml;

import org.springframework.richclient.settings.SettingsException;

/**
 * Interface for supporting pluggable xml persistence implementations.
 * 
 * @author Peter De Bruycker
 */
public interface XmlSettingsReaderWriter {
	/**
	 * Writes the given settings to the backing store.
	 * 
	 * @param settings
	 *            the settings
	 * @throws SettingsException
	 *             wraps any exception thrown by the backing store
	 */
	void write(RootXmlSettings settings) throws SettingsException;

	/**
	 * Reads the settings with the given key from the backing store.
	 * 
	 * @param key
	 *            the key
	 * @return the settings
	 * @throws SettingsException
	 *             wraps any exception thrown by the backing store
	 */
	RootXmlSettings read(String key) throws SettingsException;
}