258 lines
9.1 KiB
C#
258 lines
9.1 KiB
C#
#region Apache License 2.0
|
|
/*
|
|
Nuclex .NET Framework
|
|
Copyright (C) 2002-2024 Markus Ewald / Nuclex Development Labs
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
#endregion // Apache License 2.0
|
|
|
|
using System;
|
|
using System.Collections;
|
|
using System.Collections.Generic;
|
|
|
|
namespace Nuclex.Support.Collections {
|
|
|
|
/// <summary>Wraps a list and prevents users from modifying it</summary>
|
|
/// <typeparam name="TItem">Type of items to manage in the set</typeparam>
|
|
public class ReadOnlyList<TItem> : IList<TItem>, IList {
|
|
|
|
/// <summary>Initializes a new read-only List wrapper</summary>
|
|
/// <param name="list">List that will be wrapped</param>
|
|
public ReadOnlyList(IList<TItem> list) {
|
|
this.typedList = list;
|
|
this.objectList = (list as IList);
|
|
}
|
|
|
|
/// <summary>Retrieves the index of an item within the List</summary>
|
|
/// <param name="item">Item whose index will be returned</param>
|
|
/// <returns>The zero-based index of the specified item in the List</returns>
|
|
public int IndexOf(TItem item) {
|
|
return this.typedList.IndexOf(item);
|
|
}
|
|
|
|
/// <summary>Accesses the List item with the specified index</summary>
|
|
/// <param name="index">Zero-based index of the List item that will be accessed</param>
|
|
public TItem this[int index] {
|
|
get { return this.typedList[index]; }
|
|
}
|
|
|
|
/// <summary>Determines whether the List contains the specified item</summary>
|
|
/// <param name="item">Item that will be checked for</param>
|
|
/// <returns>True if the specified item is contained in the List</returns>
|
|
public bool Contains(TItem item) {
|
|
return this.typedList.Contains(item);
|
|
}
|
|
|
|
/// <summary>Copies the contents of the List into an array</summary>
|
|
/// <param name="array">Array the List will be copied into</param>
|
|
/// <param name="arrayIndex">
|
|
/// Starting index at which to begin filling the destination array
|
|
/// </param>
|
|
public void CopyTo(TItem[] array, int arrayIndex) {
|
|
this.typedList.CopyTo(array, arrayIndex);
|
|
}
|
|
|
|
/// <summary>The number of items current contained in the list</summary>
|
|
public int Count {
|
|
get { return this.typedList.Count; }
|
|
}
|
|
|
|
/// <summary>Whether the list is write-protected</summary>
|
|
public bool IsReadOnly {
|
|
get { return true; }
|
|
}
|
|
|
|
/// <summary>Returns a new enumerator over the contents of the list</summary>
|
|
/// <returns>The new list content enumerator</returns>
|
|
public IEnumerator<TItem> GetEnumerator() {
|
|
return this.typedList.GetEnumerator();
|
|
}
|
|
|
|
#region IList<> implementation
|
|
|
|
/// <summary>Inserts an item into the list</summary>
|
|
/// <param name="index">Zero-based index before which the item will be inserted</param>
|
|
/// <param name="item">Item that will be inserted into the list</param>
|
|
void IList<TItem>.Insert(int index, TItem item) {
|
|
throw new NotSupportedException(
|
|
"Inserting items is not supported by the read-only list"
|
|
);
|
|
}
|
|
|
|
/// <summary>Removes an item from the list</summary>
|
|
/// <param name="index">Zero-based index of the item that will be removed</param>
|
|
void IList<TItem>.RemoveAt(int index) {
|
|
throw new NotSupportedException(
|
|
"Removing items is not supported by the read-only list"
|
|
);
|
|
}
|
|
|
|
/// <summary>Accesses the list item with the specified index</summary>
|
|
/// <param name="index">Zero-based index of the list item that will be accessed</param>
|
|
TItem IList<TItem>.this[int index] {
|
|
get { return this.typedList[index]; }
|
|
set {
|
|
throw new NotSupportedException(
|
|
"Assigning items is not supported by the read-only list"
|
|
);
|
|
}
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region ICollection<> implementation
|
|
|
|
/// <summary>Adds an item to the end of the list</summary>
|
|
/// <param name="item">Item that will be added to the list</param>
|
|
void ICollection<TItem>.Add(TItem item) {
|
|
throw new NotSupportedException(
|
|
"Adding items is not supported by the read-only list"
|
|
);
|
|
}
|
|
|
|
/// <summary>Removes all items from the List</summary>
|
|
void ICollection<TItem>.Clear() {
|
|
throw new NotSupportedException(
|
|
"Clearing is not supported by the read-only list"
|
|
);
|
|
}
|
|
|
|
/// <summary>Removes the specified item from the list</summary>
|
|
/// <param name="item">Item that will be removed from the list</param>
|
|
/// <returns>True of the specified item was found in the list and removed</returns>
|
|
bool ICollection<TItem>.Remove(TItem item) {
|
|
throw new NotSupportedException(
|
|
"Removing items is not supported by the read-only list"
|
|
);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region IEnumerable implementation
|
|
|
|
/// <summary>Returns a new enumerator over the contents of the list</summary>
|
|
/// <returns>The new list content enumerator</returns>
|
|
IEnumerator IEnumerable.GetEnumerator() {
|
|
return this.objectList.GetEnumerator();
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region IList implementation
|
|
|
|
/// <summary>Removes all items from the list</summary>
|
|
void IList.Clear() {
|
|
throw new NotSupportedException(
|
|
"Clearing is not supported by the read-only list"
|
|
);
|
|
}
|
|
|
|
/// <summary>Adds an item to the end of the list</summary>
|
|
/// <param name="value">Item that will be added to the list</param>
|
|
int IList.Add(object value) {
|
|
throw new NotSupportedException(
|
|
"Adding items is not supported by the read-only list"
|
|
);
|
|
}
|
|
|
|
/// <summary>Determines whether the List contains the specified item</summary>
|
|
/// <param name="value">Item that will be checked for</param>
|
|
/// <returns>True if the specified item is contained in the list</returns>
|
|
bool IList.Contains(object value) {
|
|
return this.objectList.Contains(value);
|
|
}
|
|
|
|
/// <summary>Retrieves the index of an item within the list</summary>
|
|
/// <param name="value">Item whose index will be returned</param>
|
|
/// <returns>The zero-based index of the specified item in the list</returns>
|
|
int IList.IndexOf(object value) {
|
|
return this.objectList.IndexOf(value);
|
|
}
|
|
|
|
/// <summary>Inserts an item into the list</summary>
|
|
/// <param name="index">Zero-based index before which the item will be inserted</param>
|
|
/// <param name="value">Item that will be inserted into the list</param>
|
|
void IList.Insert(int index, object value) {
|
|
throw new NotSupportedException(
|
|
"Inserting items is not supported by the read-only list"
|
|
);
|
|
}
|
|
|
|
/// <summary>Whether the size of the list is fixed</summary>
|
|
bool IList.IsFixedSize {
|
|
get { return this.objectList.IsFixedSize; }
|
|
}
|
|
|
|
/// <summary>Removes the specified item from the list</summary>
|
|
/// <param name="value">Item that will be removed from the list</param>
|
|
/// <returns>True of the specified item was found in the list and removed</returns>
|
|
void IList.Remove(object value) {
|
|
throw new NotSupportedException(
|
|
"Removing items is not supported by the read-only list"
|
|
);
|
|
}
|
|
|
|
/// <summary>Removes an item from the list</summary>
|
|
/// <param name="index">Zero-based index of the item that will be removed</param>
|
|
void IList.RemoveAt(int index) {
|
|
throw new NotSupportedException(
|
|
"Removing items is not supported by the read-only list"
|
|
);
|
|
}
|
|
|
|
/// <summary>Accesses the list item with the specified index</summary>
|
|
/// <param name="index">Zero-based index of the list item that will be accessed</param>
|
|
object IList.this[int index] {
|
|
get { return this.objectList[index]; }
|
|
set {
|
|
throw new NotSupportedException(
|
|
"Assigning items is not supported by the read-only list"
|
|
);
|
|
}
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region ICollection implementation
|
|
|
|
/// <summary>Copies the contents of the list into an array</summary>
|
|
/// <param name="array">Array the list will be copied into</param>
|
|
/// <param name="index">
|
|
/// Starting index at which to begin filling the destination array
|
|
/// </param>
|
|
void ICollection.CopyTo(Array array, int index) {
|
|
this.objectList.CopyTo(array, index);
|
|
}
|
|
|
|
/// <summary>Whether the list is synchronized for multi-threaded usage</summary>
|
|
bool ICollection.IsSynchronized {
|
|
get { return this.objectList.IsSynchronized; }
|
|
}
|
|
|
|
/// <summary>Synchronization root on which the list locks</summary>
|
|
object ICollection.SyncRoot {
|
|
get { return this.objectList.SyncRoot; }
|
|
}
|
|
|
|
#endregion
|
|
|
|
/// <summary>The wrapped list under its type-safe interface</summary>
|
|
private IList<TItem> typedList;
|
|
/// <summary>The wrapped list under its object interface</summary>
|
|
private IList objectList;
|
|
|
|
}
|
|
|
|
} // namespace Nuclex.Support.Collections
|