Configuration.ConfigurationFile Class
Namespace: Nucleus.Extensions.Configuration
Assembly: Nucleus.Extensions.dll
Configuration file manager.
Constructor
ConfigurationFile (KnownConfigurationFiles, String) Constructor
ConfigurationFile (KnownConfigurationFiles configurationFile, String environmentName)
Opens the specified file.
Parameters
| Name | Type |
|---|---|
| configurationFile | Nucleus.Extensions.Configuration.ConfigurationFile.KnownConfigurationFiles |
| environmentName | String |
Methods
CommitChanges
CommitChanges ()
Save changes.
GetArray (String[]) Method
GetArray (String[] keys)
Retrieve an existing section from the configuration file, or create the section if it does not exist.
Parameters
| Name | Type |
|---|---|
| keys | String[] |
GetObject (JObject, String) Method
GetObject (JObject section, String key)
Retrieve an existing section from the configuration file, or create a new section if it does not exist.
Parameters
| Name | Type |
|---|---|
| section | Newtonsoft.Json.Linq.JObject |
| key | String |
GetObject (JArray, String, String) Method
GetObject (JArray section, String key, String value)
Retrieve an existing section from the configuration file, or create a new section if it does not exist.
GetSection (String[]) Method
GetSection (String[] keys)
Retrieve an existing section from the configuration file, or create the section if it does not exist.
Parameters
| Name | Type |
|---|---|
| keys | String[] |
GetSection (String) Method
GetSection (String key)
Retrieve an existing section from the configuration file.
Parameters
| Name | Type |
|---|---|
| key | String |
GetSection (JContainer, String) Method
GetSection (JContainer section, String key)
Retrieve an existing section from the configuration file, or create a new section if it does not exist.
Parameters
| Name | Type |
|---|---|
| section | Newtonsoft.Json.Linq.JContainer |
| key | String |
GetToken (String) Method
GetToken (String path)
Retrieve a token from the specified section.
Parameters
| Name | Type |
|---|---|
| path | String |
GetToken (JObject, String) Method
GetToken (JObject section, String key)
Retrieve a token from the specified section.
Parameters
| Name | Type |
|---|---|
| section | Newtonsoft.Json.Linq.JObject |
| key | String |
RemoveObject (JArray, String, String) Method
RemoveObject (JArray section, String key, String value)
Remove an existing section from the configuration file if a match exists.
Set (JObject, String, Object) Method
Set (JObject section, String key, Object value)
Add or replace a value.
Set (JArray, Object) Method
Set (JArray section, Object value)
Add or replace a value.
Parameters
| Name | Type |
|---|---|
| section | Newtonsoft.Json.Linq.JArray |
| value | Object |