Lean  $LEAN_TAG$
StringDecimalJsonConverter.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  *
15 */
16 
17 using System;
18 using System.Globalization;
19 
20 namespace QuantConnect.Util
21 {
22  /// <summary>
23  /// Allows for conversion of string numeric values from JSON to the <see cref="decimal"/> type
24  /// </summary>
25  public class StringDecimalJsonConverter : TypeChangeJsonConverter<decimal, string>
26  {
27  private readonly bool _defaultOnFailure;
28 
29  /// <summary>
30  /// Creates an instance of the class, with an optional flag to default to decimal's default value on failure.
31  /// </summary>
32  /// <param name="defaultOnFailure">Default to decimal's default value on failure</param>
33  public StringDecimalJsonConverter(bool defaultOnFailure = false)
34  {
35  _defaultOnFailure = defaultOnFailure;
36  }
37 
38  /// <summary>
39  /// Converts a decimal to a string
40  /// </summary>
41  /// <param name="value">The input value to be converted before serialization</param>
42  /// <returns>String representation of the decimal</returns>
43  protected override string Convert(decimal value)
44  {
45  return value.ToStringInvariant();
46  }
47 
48  /// <summary>
49  /// Converts the input string to a decimal
50  /// </summary>
51  /// <param name="value">The deserialized value that needs to be converted to T</param>
52  /// <returns>The converted value</returns>
53  protected override decimal Convert(string value)
54  {
55  try
56  {
57  return decimal.Parse(value, NumberStyles.Any, CultureInfo.InvariantCulture);
58  }
59  catch (Exception)
60  {
61  if (_defaultOnFailure)
62  {
63  return default(decimal);
64  }
65 
66  throw;
67  }
68  }
69  }
70 }