| | | 1 | | // ----------------------------------------------------------------------- |
| | | 2 | | // <copyright file="TimeSpanDecompositionExtensions.cs" company="Stéphane ANDRE"> |
| | | 3 | | // Copyright (c) Stéphane ANDRE. All rights reserved. |
| | | 4 | | // </copyright> |
| | | 5 | | // ----------------------------------------------------------------------- |
| | | 6 | | |
| | | 7 | | using System; |
| | | 8 | | using System.Collections.Generic; |
| | | 9 | | using MyNet.Primitives; |
| | | 10 | | |
| | | 11 | | #pragma warning disable IDE0130 // Namespace does not match folder structure |
| | | 12 | | namespace MyNet.Temporal.Decomposition; |
| | | 13 | | #pragma warning restore IDE0130 // Namespace does not match folder structure |
| | | 14 | | |
| | | 15 | | public static class TimeSpanDecompositionExtensions |
| | | 16 | | { |
| | | 17 | | extension(TimeSpan timeSpan) |
| | | 18 | | { |
| | | 19 | | /// <summary> |
| | | 20 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 21 | | /// </summary> |
| | | 22 | | /// <returns>A list of <see cref="TimeUnitValue"/> objects representing the value of each time unit in the decom |
| | 0 | 23 | | public IReadOnlyList<TimeUnitValue> Decompose() => timeSpan.Decompose(TimeSpanDecompositionPresets.Humanized); |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 27 | | /// </summary> |
| | | 28 | | /// <param name="options">The options to use for the decomposition.</param> |
| | | 29 | | /// <returns>A list of <see cref="TimeUnitValue"/> objects representing the value of each time unit in the decom |
| | 336 | 30 | | public IReadOnlyList<TimeUnitValue> Decompose(TimeSpanDecompositionOptions options) => TimeSpanDecomposer.Defaul |
| | | 31 | | |
| | | 32 | | /// <summary> |
| | | 33 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 34 | | /// </summary> |
| | | 35 | | /// <param name="configure">The configuration action to customize the decomposition.</param> |
| | | 36 | | /// <returns>A list of <see cref="TimeUnitValue"/> objects representing the value of each time unit in the decom |
| | | 37 | | public IReadOnlyList<TimeUnitValue> Decompose(Action<TimeSpanDecompositionBuilder> configure) |
| | | 38 | | { |
| | 6 | 39 | | ArgumentNullException.ThrowIfNull(configure); |
| | | 40 | | |
| | 6 | 41 | | var builder = new TimeSpanDecompositionBuilder(TimeSpanDecomposer.Default, timeSpan); |
| | 6 | 42 | | configure(builder); |
| | | 43 | | |
| | 6 | 44 | | return builder.Decompose(); |
| | | 45 | | } |
| | | 46 | | |
| | | 47 | | /// <summary> |
| | | 48 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 49 | | /// </summary> |
| | | 50 | | /// <param name="decomposer">The custom decomposer to use for the decomposition.</param> |
| | | 51 | | /// <param name="options">The options to use for the decomposition.</param> |
| | | 52 | | /// <returns>A list of <see cref="TimeUnitValue"/> objects representing the value of each time unit in the decom |
| | | 53 | | public IReadOnlyList<TimeUnitValue> Decompose(ITimeSpanDecomposer decomposer, TimeSpanDecompositionOptions optio |
| | | 54 | | { |
| | 0 | 55 | | ArgumentNullException.ThrowIfNull(decomposer); |
| | 0 | 56 | | return decomposer.Decompose(timeSpan, options); |
| | | 57 | | } |
| | | 58 | | |
| | | 59 | | /// <summary> |
| | | 60 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 61 | | /// </summary> |
| | | 62 | | /// <param name="decomposer">The custom decomposer to use for the decomposition.</param> |
| | | 63 | | /// <param name="configure">The configuration action to customize the decomposition.</param> |
| | | 64 | | /// <returns>A list of <see cref="TimeUnitValue"/> objects representing the value of each time unit in the decom |
| | | 65 | | public IReadOnlyList<TimeUnitValue> Decompose(ITimeSpanDecomposer decomposer, Action<TimeSpanDecompositionBuilde |
| | | 66 | | { |
| | 0 | 67 | | ArgumentNullException.ThrowIfNull(decomposer); |
| | 0 | 68 | | ArgumentNullException.ThrowIfNull(configure); |
| | | 69 | | |
| | 0 | 70 | | var builder = new TimeSpanDecompositionBuilder(decomposer, timeSpan); |
| | | 71 | | |
| | 0 | 72 | | configure(builder); |
| | | 73 | | |
| | 0 | 74 | | return builder.Decompose(); |
| | | 75 | | } |
| | | 76 | | |
| | | 77 | | /// <summary> |
| | | 78 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 79 | | /// </summary> |
| | | 80 | | /// <returns>A list of <see cref="TimeUnitValue"/> objects representing the value of each time unit in the decom |
| | 3 | 81 | | public IReadOnlyList<TimeUnitValue> Humanized() => timeSpan.Decompose(TimeSpanDecompositionPresets.Humanized); |
| | | 82 | | |
| | | 83 | | /// <summary> |
| | | 84 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 85 | | /// </summary> |
| | | 86 | | /// <returns>A list of <see cref="TimeUnitValue"/> objects representing the value of each time unit in the decom |
| | 3 | 87 | | public IReadOnlyList<TimeUnitValue> Compact() => timeSpan.Decompose(TimeSpanDecompositionPresets.Compact); |
| | | 88 | | |
| | | 89 | | /// <summary> |
| | | 90 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 91 | | /// </summary> |
| | | 92 | | /// <returns>A list of <see cref="TimeUnitValue"/> objects representing the value of each time unit in the decom |
| | 3 | 93 | | public IReadOnlyList<TimeUnitValue> Full() => timeSpan.Decompose(TimeSpanDecompositionPresets.Full); |
| | | 94 | | |
| | | 95 | | /// <summary> |
| | | 96 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 97 | | /// </summary> |
| | | 98 | | /// <returns>A <see cref="TimeUnitValue"/> object representing the value of the largest time unit in the decompo |
| | 3 | 99 | | public TimeUnitValue Largest() => timeSpan.Largest(TimeSpanDecompositionPresets.LargestUnit); |
| | | 100 | | |
| | | 101 | | /// <summary> |
| | | 102 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 103 | | /// </summary> |
| | | 104 | | /// <param name="options">The options to customize the decomposition.</param> |
| | | 105 | | /// <returns>A <see cref="TimeUnitValue"/> object representing the value of the largest time unit in the decompo |
| | | 106 | | public TimeUnitValue Largest(TimeSpanDecompositionOptions options) |
| | | 107 | | { |
| | 3 | 108 | | var result = timeSpan.Decompose(options); |
| | | 109 | | |
| | 3 | 110 | | return result.Count > 0 ? result[0] : new(0, options.MinUnit); |
| | | 111 | | } |
| | | 112 | | |
| | | 113 | | /// <summary> |
| | | 114 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 115 | | /// </summary> |
| | | 116 | | /// <param name="configure">A delegate to configure the decomposition options.</param> |
| | | 117 | | /// <returns>A <see cref="TimeUnitValue"/> object representing the value of the largest time unit in the decompo |
| | | 118 | | public TimeUnitValue Largest(Action<TimeSpanDecompositionBuilder> configure) |
| | | 119 | | { |
| | 0 | 120 | | var result = timeSpan.Decompose(configure); |
| | | 121 | | |
| | 0 | 122 | | return result.Count > 0 ? result[0] : new(0, TimeUnit.Millisecond); |
| | | 123 | | } |
| | | 124 | | |
| | | 125 | | /// <summary> |
| | | 126 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 127 | | /// </summary> |
| | | 128 | | /// <returns>A <see cref="TimeUnitValue"/> object representing the value of the smallest time unit in the decomp |
| | 0 | 129 | | public TimeUnitValue Smallest() => timeSpan.Largest(TimeSpanDecompositionPresets.SmallestUnit); |
| | | 130 | | |
| | | 131 | | /// <summary> |
| | | 132 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 133 | | /// </summary> |
| | | 134 | | /// <param name="options">The options to customize the decomposition.</param> |
| | | 135 | | /// <returns>A <see cref="TimeUnitValue"/> object representing the value of the smallest time unit in the decomp |
| | | 136 | | public TimeUnitValue Smallest(TimeSpanDecompositionOptions options) |
| | | 137 | | { |
| | 3 | 138 | | var result = timeSpan.Decompose(options); |
| | | 139 | | |
| | 3 | 140 | | return result.Count > 0 ? result[^1] : new(0, options.MinUnit); |
| | | 141 | | } |
| | | 142 | | |
| | | 143 | | /// <summary> |
| | | 144 | | /// Decomposes the <see cref="TimeSpan"/> into its constituent time units (e.g., years, months, days, hours, min |
| | | 145 | | /// </summary> |
| | | 146 | | /// <param name="configure">A delegate to configure the decomposition options.</param> |
| | | 147 | | /// <returns>A <see cref="TimeUnitValue"/> object representing the value of the smallest time unit in the decomp |
| | | 148 | | public TimeUnitValue Smallest(Action<TimeSpanDecompositionBuilder> configure) |
| | | 149 | | { |
| | 0 | 150 | | var result = timeSpan.Decompose(configure); |
| | | 151 | | |
| | 0 | 152 | | return result.Count > 0 ? result[^1] : new(0, TimeUnit.Millisecond); |
| | | 153 | | } |
| | | 154 | | } |
| | | 155 | | } |
| | | 156 | | |