1 /*
2 * Copyright (C) 2010, Google Inc.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.lib;
45
46 import java.io.IOException;
47
48 import org.eclipse.jgit.errors.ConfigInvalidException;
49
50 /**
51 * Persistent configuration that can be stored and loaded from a location.
52 */
53 public abstract class StoredConfig extends Config {
54 /** Create a configuration with no default fallback. */
55 public StoredConfig() {
56 super();
57 }
58
59 /**
60 * Create an empty configuration with a fallback for missing keys.
61 *
62 * @param defaultConfig
63 * the base configuration to be consulted when a key is missing
64 * from this configuration instance.
65 */
66 public StoredConfig(Config defaultConfig) {
67 super(defaultConfig);
68 }
69
70 /**
71 * Load the configuration from the persistent store.
72 * <p>
73 * If the configuration does not exist, this configuration is cleared, and
74 * thus behaves the same as though the backing store exists, but is empty.
75 *
76 * @throws IOException
77 * the configuration could not be read (but does exist).
78 * @throws ConfigInvalidException
79 * the configuration is not properly formatted.
80 */
81 public abstract void load() throws IOException, ConfigInvalidException;
82
83 /**
84 * Save the configuration to the persistent store.
85 *
86 * @throws IOException
87 * the configuration could not be written.
88 */
89 public abstract void save() throws IOException;
90
91 @Override
92 public void clear() {
93 super.clear();
94 }
95 }