ReadOnlyDictionary.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using System;
using System.Collections.Generic;

namespace SiliconStudio.Core.Collections
{
    /// <summary>
    /// Read-only dictionary wrapper.
    /// </summary>
    /// <typeparam name="TKey">The type of the key.</typeparam>
    /// <typeparam name="TValue">The type of the value.</typeparam>
    public class ReadOnlyDictionary<TKey, TValue> : IDictionary<TKey, TValue>
    {
        private readonly IDictionary<TKey, TValue> dictionary;

        /// <summary>
        /// Initializes a new instance of the <see cref="ReadOnlyDictionary&lt;TKey, TValue&gt;"/> class.
        /// </summary>
        /// <param name="dictionary">The dictionary.</param>
        public ReadOnlyDictionary(IDictionary<TKey, TValue> dictionary)
        {
            this.dictionary = dictionary;
        }

        /// <inheritdoc/>
        public ICollection<TKey> Keys
        {
            get { return dictionary.Keys; }
        }

        /// <inheritdoc/>
        public ICollection<TValue> Values
        {
            get { return dictionary.Values; }
        }

        /// <inheritdoc/>
        public int Count
        {
            get { return dictionary.Count; }
        }

        /// <inheritdoc/>
        public bool IsReadOnly
        {
            get { return true; }
        }

        /// <inheritdoc/>
        public TValue this[TKey key]
        {
            get { return dictionary[key]; }
            set { throw new NotSupportedException("Read-only dictionary"); }
        }

        /// <inheritdoc/>
        public void Add(TKey key, TValue value)
        {
            throw new NotSupportedException("Read-only dictionary");
        }

        /// <inheritdoc/>
        public bool ContainsKey(TKey key)
        {
            return dictionary.ContainsKey(key);
        }

        /// <inheritdoc/>
        public bool Remove(TKey key)
        {
            throw new NotSupportedException("Read-only dictionary");
        }

        /// <inheritdoc/>
        public bool TryGetValue(TKey key, out TValue value)
        {
            return dictionary.TryGetValue(key, out value);
        }

        /// <inheritdoc/>
        public void Add(KeyValuePair<TKey, TValue> item)
        {
            throw new NotSupportedException("Read-only dictionary");
        }

        /// <inheritdoc/>
        public void Clear()
        {
            throw new NotSupportedException("Read-only dictionary");
        }

        /// <inheritdoc/>
        public bool Contains(KeyValuePair<TKey, TValue> item)
        {
            return dictionary.Contains(item);
        }

        /// <inheritdoc/>
        public void CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex)
        {
            dictionary.CopyTo(array, arrayIndex);
        }

        /// <inheritdoc/>
        public bool Remove(KeyValuePair<TKey, TValue> item)
        {
            throw new NotSupportedException("Read-only dictionary");
        }

        /// <inheritdoc/>
        public IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator()
        {
            return dictionary.GetEnumerator();
        }

        /// <inheritdoc/>
        System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
        {
            return dictionary.GetEnumerator();
        }
    }
}