001    /*
002     * Copyright 2002-2004 the original author or authors.
003     * 
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not
005     * use this file except in compliance with the License. You may obtain a copy of
006     * the License at
007     * 
008     * http://www.apache.org/licenses/LICENSE-2.0
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
012     * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
013     * License for the specific language governing permissions and limitations under
014     * the License.
015     */
016    package org.springframework.richclient.settings.xml;
017    
018    import org.springframework.richclient.settings.SettingsException;
019    
020    /**
021     * Interface for supporting pluggable xml persistence implementations.
022     * 
023     * @author Peter De Bruycker
024     */
025    public interface XmlSettingsReaderWriter {
026            /**
027             * Writes the given settings to the backing store.
028             * 
029             * @param settings
030             *            the settings
031             * @throws SettingsException
032             *             wraps any exception thrown by the backing store
033             */
034            void write(RootXmlSettings settings) throws SettingsException;
035    
036            /**
037             * Reads the settings with the given key from the backing store.
038             * 
039             * @param key
040             *            the key
041             * @return the settings
042             * @throws SettingsException
043             *             wraps any exception thrown by the backing store
044             */
045            RootXmlSettings read(String key) throws SettingsException;
046    }