|
| 1 | +// Copyright (c) Six Labors. |
| 2 | +// Licensed under the Apache License, Version 2.0. |
| 3 | + |
| 4 | +using System; |
| 5 | +using System.Collections.Generic; |
| 6 | +using System.Collections.ObjectModel; |
| 7 | +using System.Runtime.CompilerServices; |
| 8 | + |
| 9 | +namespace SixLabors.ImageSharp.Web.Commands |
| 10 | +{ |
| 11 | + /// <summary> |
| 12 | + /// Represents an ordered collection of processing commands. |
| 13 | + /// </summary> |
| 14 | + public sealed class CommandCollection : KeyedCollection<string, KeyValuePair<string, string>> |
| 15 | + { |
| 16 | + /// <summary> |
| 17 | + /// Initializes a new instance of the <see cref="CommandCollection"/> class. |
| 18 | + /// </summary> |
| 19 | + public CommandCollection() |
| 20 | + : this(StringComparer.OrdinalIgnoreCase) |
| 21 | + { |
| 22 | + } |
| 23 | + |
| 24 | + private CommandCollection(IEqualityComparer<string> comparer) |
| 25 | + : base(comparer) |
| 26 | + { |
| 27 | + } |
| 28 | + |
| 29 | + /// <summary> |
| 30 | + /// Gets an <see cref="IEnumerable{String}"/> representing the keys of the collection. |
| 31 | + /// </summary> |
| 32 | + public IEnumerable<string> Keys |
| 33 | + { |
| 34 | + get |
| 35 | + { |
| 36 | + foreach (KeyValuePair<string, string> item in this) |
| 37 | + { |
| 38 | + yield return this.GetKeyForItem(item); |
| 39 | + } |
| 40 | + } |
| 41 | + } |
| 42 | + |
| 43 | + /// <summary> |
| 44 | + /// Gets or sets the value associated with the specified key. |
| 45 | + /// </summary> |
| 46 | + /// <param name="key">The key of the value to get or set.</param> |
| 47 | + /// <returns> |
| 48 | + /// The value associated with the specified key. If the specified key is not found, |
| 49 | + /// a get operation throws a <see cref="KeyNotFoundException"/>, and |
| 50 | + /// a set operation creates a new element with the specified key. |
| 51 | + /// </returns> |
| 52 | + /// <exception cref="ArgumentNullException"><paramref name="key"/> is null.</exception> |
| 53 | + /// <exception cref="KeyNotFoundException">An element with the specified key does not exist in the collection.</exception> |
| 54 | + public new string this[string key] |
| 55 | + { |
| 56 | + get |
| 57 | + { |
| 58 | + if (!this.TryGetValue(key, out string value)) |
| 59 | + { |
| 60 | + ThrowKeyNotFound(); |
| 61 | + } |
| 62 | + |
| 63 | + return value; |
| 64 | + } |
| 65 | + |
| 66 | + set |
| 67 | + { |
| 68 | + if (this.TryGetValue(key, out KeyValuePair<string, string> item)) |
| 69 | + { |
| 70 | + this.SetItem(this.IndexOf(item), new(key, value)); |
| 71 | + } |
| 72 | + else |
| 73 | + { |
| 74 | + this.Add(key, value); |
| 75 | + } |
| 76 | + } |
| 77 | + } |
| 78 | + |
| 79 | + /// <summary> |
| 80 | + /// Adds an element with the provided key and value to the <see cref="CommandCollection"/>. |
| 81 | + /// </summary> |
| 82 | + /// <param name="key">The <see cref="string"/> to use as the key of the element to add.</param> |
| 83 | + /// <param name="value">The <see cref="string"/> to use as the value of the element to add.</param> |
| 84 | + /// <exception cref="ArgumentNullException"><paramref name="key"/> is null.</exception> |
| 85 | + public void Add(string key, string value) => this.Add(new(key, value)); |
| 86 | + |
| 87 | + /// <summary> |
| 88 | + /// Inserts an element into the <see cref="CommandCollection"/> at the |
| 89 | + /// specified index. |
| 90 | + /// </summary> |
| 91 | + /// <param name="index">The zero-based index at which item should be inserted.</param> |
| 92 | + /// <param name="key">The <see cref="string"/> to use as the key of the element to insert.</param> |
| 93 | + /// <param name="value">The <see cref="string"/> to use as the value of the element to insert.</param> |
| 94 | + /// <exception cref="ArgumentOutOfRangeException">index is less than zero. -or- index is greater than <see cref="P:CommandCollection.Count"/>.</exception> |
| 95 | + public void Insert(int index, string key, string value) => this.Insert(index, new(key, value)); |
| 96 | + |
| 97 | + /// <summary> |
| 98 | + /// Gets the value associated with the specified key. |
| 99 | + /// </summary> |
| 100 | + /// <param name="key">The key whose value to get.</param> |
| 101 | + /// <param name="value"> |
| 102 | + /// When this method returns, the value associated with the specified key, if the |
| 103 | + /// key is found; otherwise, the default value for the type of the value parameter. |
| 104 | + /// This parameter is passed uninitialized. |
| 105 | + /// </param> |
| 106 | + /// <returns> |
| 107 | + /// <see langword="true"/> if the object that implements <see cref="CommandCollection"/> contains |
| 108 | + /// an element with the specified key; otherwise, <see langword="false"/>. |
| 109 | + /// </returns> |
| 110 | + /// <exception cref="ArgumentNullException"><paramref name="key"/> is null.</exception> |
| 111 | + public bool TryGetValue(string key, out string value) |
| 112 | + { |
| 113 | + if (this.TryGetValue(key, out KeyValuePair<string, string> keyValue)) |
| 114 | + { |
| 115 | + value = keyValue.Value; |
| 116 | + return true; |
| 117 | + } |
| 118 | + |
| 119 | + value = default; |
| 120 | + return false; |
| 121 | + } |
| 122 | + |
| 123 | + /// <summary> |
| 124 | + /// Searches for an element that matches the conditions defined by the specified |
| 125 | + /// predicate, and returns the zero-based index of the first occurrence within the |
| 126 | + /// entire <see cref="CommandCollection"/>. |
| 127 | + /// </summary> |
| 128 | + /// <param name="match"> |
| 129 | + /// The <see cref="Predicate{T}"/> delegate that defines the conditions of the element to |
| 130 | + /// search for. |
| 131 | + /// </param> |
| 132 | + /// <returns> |
| 133 | + /// The zero-based index of the first occurrence of an element that matches the conditions |
| 134 | + /// defined by match, if found; otherwise, -1. |
| 135 | + /// </returns> |
| 136 | + /// <exception cref="ArgumentNullException"><paramref name="match"/> is null.</exception> |
| 137 | + public int FindIndex(Predicate<string> match) |
| 138 | + { |
| 139 | + Guard.NotNull(match, nameof(match)); |
| 140 | + |
| 141 | + int index = 0; |
| 142 | + foreach (KeyValuePair<string, string> item in this) |
| 143 | + { |
| 144 | + if (match(item.Key)) |
| 145 | + { |
| 146 | + return index; |
| 147 | + } |
| 148 | + |
| 149 | + index++; |
| 150 | + } |
| 151 | + |
| 152 | + return -1; |
| 153 | + } |
| 154 | + |
| 155 | + /// <summary> |
| 156 | + /// Searches for the specified key and returns the zero-based index of the first |
| 157 | + /// occurrence within the entire <see cref="CommandCollection"/>. |
| 158 | + /// </summary> |
| 159 | + /// <param name="key">The key to locate in the <see cref="CommandCollection"/>.</param> |
| 160 | + /// <returns> |
| 161 | + /// The zero-based index of the first occurrence of key within the entire <see cref="CommandCollection"/>, |
| 162 | + /// if found; otherwise, -1. |
| 163 | + /// </returns> |
| 164 | + public int IndexOf(string key) |
| 165 | + { |
| 166 | + if (this.TryGetValue(key, out KeyValuePair<string, string> item)) |
| 167 | + { |
| 168 | + return this.IndexOf(item); |
| 169 | + } |
| 170 | + |
| 171 | + return -1; |
| 172 | + } |
| 173 | + |
| 174 | + /// <inheritdoc/> |
| 175 | + [MethodImpl(MethodImplOptions.AggressiveInlining)] |
| 176 | + protected override string GetKeyForItem(KeyValuePair<string, string> item) => item.Key; |
| 177 | + |
| 178 | + [MethodImpl(MethodImplOptions.NoInlining)] |
| 179 | + private static void ThrowKeyNotFound() => throw new KeyNotFoundException(); |
| 180 | + } |
| 181 | +} |
0 commit comments