blob: 991cc8b76b7b71b451e9da5b9f1a4fa09e75e859 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
// Copyright 2009-2022 Josh Close
// This file is a part of CsvHelper and is dual licensed under MS-PL and Apache 2.0.
// See LICENSE.txt for details or visit http://www.opensource.org/licenses/ms-pl.html for MS-PL and http://opensource.org/licenses/Apache-2.0 for Apache 2.0.
// https://github.com/JoshClose/CsvHelper
using CsvHelper.TypeConversion;
using System;
using System.Diagnostics;
using System.Reflection;
namespace CsvHelper.Configuration
{
/// <summary>
/// Mapping for a constructor parameter.
/// This may contain value type data, a constructor type map,
/// or a reference map, depending on the type of the parameter.
/// </summary>
[DebuggerDisplay("Data = {Data}")]
public class ParameterMap
{
/// <summary>
/// Gets the parameter map data.
/// </summary>
public virtual ParameterMapData Data { get; protected set; }
/// <summary>
/// Type converter options.
/// </summary>
public virtual ParameterMapTypeConverterOption TypeConverterOption { get; protected set; }
/// <summary>
/// Gets or sets the map for a constructor type.
/// </summary>
public virtual ClassMap ConstructorTypeMap { get; set; }
/// <summary>
/// Gets or sets the map for a reference type.
/// </summary>
public virtual ParameterReferenceMap ReferenceMap { get; set; }
/// <summary>
/// Creates an instance of <see cref="ParameterMap"/> using
/// the given information.
/// </summary>
/// <param name="parameter">The parameter being mapped.</param>
public ParameterMap(ParameterInfo parameter)
{
TypeConverterOption = new ParameterMapTypeConverterOption(this);
Data = new ParameterMapData(parameter);
}
/// <summary>
/// When reading, is used to get the field
/// at the index of the name if there was a
/// header specified. It will look for the
/// first name match in the order listed.
/// When writing, sets the name of the
/// field in the header record.
/// The first name will be used.
/// </summary>
/// <param name="names">The possible names of the CSV field.</param>
public virtual ParameterMap Name(params string[] names)
{
if (names == null || names.Length == 0)
{
throw new ArgumentNullException(nameof(names));
}
Data.Names.Clear();
Data.Names.AddRange(names);
Data.IsNameSet = true;
return this;
}
/// <summary>
/// When reading, is used to get the
/// index of the name used when there
/// are multiple names that are the same.
/// </summary>
/// <param name="index">The index of the name.</param>
public virtual ParameterMap NameIndex(int index)
{
Data.NameIndex = index;
return this;
}
/// <summary>
/// When reading, is used to get the field at
/// the given index. When writing, the fields
/// will be written in the order of the field
/// indexes.
/// </summary>
/// <param name="index">The index of the CSV field.</param>
public virtual ParameterMap Index(int index)
{
Data.Index = index;
Data.IsIndexSet = true;
return this;
}
/// <summary>
/// Ignore the parameter when reading and writing.
/// </summary>
public virtual ParameterMap Ignore()
{
Data.Ignore = true;
return this;
}
/// <summary>
/// Ignore the parameter when reading and writing.
/// </summary>
/// <param name="ignore">True to ignore, otherwise false.</param>
public virtual ParameterMap Ignore(bool ignore)
{
Data.Ignore = ignore;
return this;
}
/// <summary>
/// The default value that will be used when reading when
/// the CSV field is empty.
/// </summary>
/// <param name="defaultValue">The default value.</param>
public virtual ParameterMap Default(object? defaultValue)
{
if (defaultValue == null && Data.Parameter.ParameterType.IsValueType)
{
throw new ArgumentException($"Parameter of type '{Data.Parameter.ParameterType.FullName}' can't have a default value of null.");
}
if (defaultValue != null && defaultValue.GetType() != Data.Parameter.ParameterType)
{
throw new ArgumentException($"Default of type '{defaultValue.GetType().FullName}' does not match parameter of type '{Data.Parameter.ParameterType.FullName}'.");
}
Data.Default = defaultValue;
Data.IsDefaultSet = true;
return this;
}
/// <summary>
/// The constant value that will be used for every record when
/// reading and writing. This value will always be used no matter
/// what other mapping configurations are specified.
/// </summary>
/// <param name="constantValue">The constant value.</param>
public virtual ParameterMap Constant(object? constantValue)
{
if (constantValue == null && Data.Parameter.ParameterType.IsValueType)
{
throw new ArgumentException($"Parameter of type '{Data.Parameter.ParameterType.FullName}' can't have a constant value of null.");
}
if (constantValue != null && constantValue.GetType() != Data.Parameter.ParameterType)
{
throw new ArgumentException($"Constant of type '{constantValue.GetType().FullName}' does not match parameter of type '{Data.Parameter.ParameterType.FullName}'.");
}
Data.Constant = constantValue;
Data.IsConstantSet = true;
return this;
}
/// <summary>
/// The field is optional.
/// </summary>
public virtual ParameterMap Optional()
{
Data.IsOptional = true;
return this;
}
/// <summary>
/// Specifies the <see cref="TypeConverter"/> to use
/// when converting the parameter to and from a CSV field.
/// </summary>
/// <param name="typeConverter">The TypeConverter to use.</param>
public virtual ParameterMap TypeConverter(ITypeConverter typeConverter)
{
Data.TypeConverter = typeConverter;
return this;
}
/// <summary>
/// Specifies the <see cref="TypeConverter"/> to use
/// when converting the parameter to and from a CSV field.
/// </summary>
/// <typeparam name="TConverter">The <see cref="System.Type"/> of the
/// <see cref="TypeConverter"/> to use.</typeparam>
public virtual ParameterMap TypeConverter<TConverter>() where TConverter : ITypeConverter
{
TypeConverter(ObjectResolver.Current.Resolve<TConverter>());
return this;
}
internal int GetMaxIndex()
{
return ReferenceMap?.GetMaxIndex() ?? Data.Index;
}
}
}
|
