SettingsDictionary Class

Provides settings for a job configuration.

Inheritance Hierarchy

System.Object
System.Collections.Generic.Dictionary<String, String>
Ookii.Jumbo.Jet.Jobs.SettingsDictionary

Namespace: Ookii.Jumbo.Jet.Jobs
Assembly: Ookii.Jumbo.Jet (in Ookii.Jumbo.Jet.dll) Version: 2.0.0

Syntax

C++

Copy

[SerializableAttribute]
public sealed class SettingsDictionary : Dictionary<string, string>, 
	IXmlSerializable

<SerializableAttribute>
Public NotInheritable Class SettingsDictionary
	Inherits Dictionary(Of String, String)
	Implements IXmlSerializable

[SerializableAttribute]
public ref class SettingsDictionary sealed : public Dictionary<String^, String^>, 
	IXmlSerializable

[<SealedAttribute>]
[<SerializableAttribute>]
type SettingsDictionary =  
    class
        inherit Dictionary<string, string>
        interface IXmlSerializable
    end

The SettingsDictionary type exposes the following members.

Constructors

	Name	Description
	SettingsDictionary()	Initializes a new instance of the SettingsDictionary class.
	SettingsDictionary(IDictionary<String, String>)	Initializes a new instance of the SettingsDictionary class with elements that are copied from the specified IDictionary<TKey, TValue>.

Top

Properties

	Name	Description
	Comparer	Gets the IEqualityComparer<T> that is used to determine equality of keys for the dictionary. (Inherited from Dictionary<String, String>.)
	Count	Gets the number of key/value pairs contained in the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	Item	Gets or sets the value associated with the specified key. (Inherited from Dictionary<String, String>.)
	Keys	Gets a collection containing the keys in the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	Values	Gets a collection containing the values in the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)

Top

Methods

	Name	Description
	Add	Adds the specified key and value to the dictionary. (Inherited from Dictionary<String, String>.)
	AddSetting	Adds a setting with the specified type.
	Clear	Removes all keys and values from the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	ContainsKey	Determines whether the Dictionary<TKey, TValue> contains the specified key. (Inherited from Dictionary<String, String>.)
	ContainsValue	Determines whether the Dictionary<TKey, TValue> contains a specific value. (Inherited from Dictionary<String, String>.)
	EnsureCapacity	Ensures that the dictionary can hold up to a specified number of entries without any further expansion of its backing storage. (Inherited from Dictionary<String, String>.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetJobOrStageSetting(JobConfiguration, StageConfiguration, String, String)	Gets a setting's string value with the specified default value, checking first in the stage settings and then in the job settings.
	GetJobOrStageSetting<T>(JobConfiguration, StageConfiguration, String, T)	Gets a setting with the specified type and default value, checking first in the stage settings and then in the job settings.
	GetObjectData	Implements the ISerializable interface and returns the data needed to serialize the Dictionary<TKey, TValue> instance. (Inherited from Dictionary<String, String>.)
	GetSetting(String, String)	Gets a string setting with the specified default value.
	GetSetting<T>(String, T)	Gets a setting with the specified type and default value.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	OnDeserialization	Implements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from Dictionary<String, String>.)
	Remove(TKey)	Removes the value with the specified key from the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	Remove(TKey, TValue)	Removes the value with the specified key from the Dictionary<TKey, TValue>, and copies the element to the value parameter. (Inherited from Dictionary<String, String>.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TrimExcess()	Sets the capacity of this dictionary to what it would be if it had been originally initialized with all its entries. (Inherited from Dictionary<String, String>.)
	TrimExcess(Int32)	Sets the capacity of this dictionary to hold up a specified number of entries without any further expansion of its backing storage. (Inherited from Dictionary<String, String>.)
	TryAdd	Attempts to add the specified key and value to the dictionary. (Inherited from Dictionary<String, String>.)
	TryGetSetting<T>	Tries to get a setting with the specified type.
	TryGetValue	Gets the value associated with the specified key. (Inherited from Dictionary<String, String>.)

Top

Reference

Ookii.Jumbo.Jet.Jobs Namespace