← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/monodevelop/oneiric

« back to all changes in this revision

Viewing changes to contrib/NGit/NGit/StoredConfig.cs

  • Committer: Bazaar Package Importer
  • Author(s): Jo Shields
  • Date: 2011-06-27 17:03:13 UTC
  • mto: (1.8.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 54.
  • Revision ID: james.westby@ubuntu.com-20110627170313-6cvz3s19x6e9hqe9
Import upstream version 2.5.92+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
contrib/NGit/NGit/StoredConfig.cs
 
1
/*
 
2
This code is derived from jgit (http://eclipse.org/jgit).
 
3
Copyright owners are documented in jgit'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
using NGit;
 
45
using Sharpen;
 
46
 
 
47
namespace NGit
 
48
{
 
49
        /// <summary>Persistent configuration that can be stored and loaded from a location.</summary>
 
50
        /// <remarks>Persistent configuration that can be stored and loaded from a location.</remarks>
 
51
        public abstract class StoredConfig : Config
 
52
        {
 
53
                /// <summary>Create a configuration with no default fallback.</summary>
 
54
                /// <remarks>Create a configuration with no default fallback.</remarks>
 
55
                public StoredConfig() : base()
 
56
                {
 
57
                }
 
58
 
 
59
                /// <summary>Create an empty configuration with a fallback for missing keys.</summary>
 
60
                /// <remarks>Create an empty configuration with a fallback for missing keys.</remarks>
 
61
                /// <param name="defaultConfig">
 
62
                /// the base configuration to be consulted when a key is missing
 
63
                /// from this configuration instance.
 
64
                /// </param>
 
65
                public StoredConfig(Config defaultConfig) : base(defaultConfig)
 
66
                {
 
67
                }
 
68
 
 
69
                /// <summary>Load the configuration from the persistent store.</summary>
 
70
                /// <remarks>
 
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
                /// </remarks>
 
76
                /// <exception cref="System.IO.IOException">the configuration could not be read (but does exist).
 
77
                ///     </exception>
 
78
                /// <exception cref="NGit.Errors.ConfigInvalidException">the configuration is not properly formatted.
 
79
                ///     </exception>
 
80
                public abstract void Load();
 
81
 
 
82
                /// <summary>Save the configuration to the persistent store.</summary>
 
83
                /// <remarks>Save the configuration to the persistent store.</remarks>
 
84
                /// <exception cref="System.IO.IOException">the configuration could not be written.</exception>
 
85
                public abstract void Save();
 
86
        }
 
87
}