summaryrefslogtreecommitdiff
path: root/ThirdParty/CsvHelper-master/src/CsvHelper/Configuration/Attributes/HeaderPrefixAttribute.cs
blob: 4ae8227f5764706ac13fa5563e56d54c5ac03f70 (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
// 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 System;

namespace CsvHelper.Configuration.Attributes
{
	/// <summary>
	/// Appends a prefix to the header of each field of the reference member.
	/// </summary>
	[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter, AllowMultiple = false, Inherited = true)]
	public class HeaderPrefixAttribute : Attribute, IMemberReferenceMapper, IParameterReferenceMapper
	{
		/// <summary>
		/// Gets the prefix.
		/// </summary>
		public string? Prefix { get; private set; }

		/// <summary>
		/// Gets a value indicating if the prefix should inherit parent prefixes.
		/// </summary>
		public bool Inherit { get; private set; }

		/// <summary>
		/// Appends a prefix to the header of each field of the reference member.
		/// </summary>
		public HeaderPrefixAttribute() { }

		/// <summary>
		/// Appends a prefix to the header of each field of the reference member.
		/// </summary>
		/// <param name="prefix">The prefix.</param>
		public HeaderPrefixAttribute(string prefix)
		{
			Prefix = prefix;
		}

		/// <summary>
		/// Appends a prefix to the header of each field of the reference member.
		/// </summary>
		/// <param name="inherit">Inherits parent object prefixes.</param>
		public HeaderPrefixAttribute(bool inherit)
		{
			Inherit = inherit;
		}

		/// <summary>
		/// Appends a prefix to the header of each field of the reference member.
		/// </summary>
		/// <param name="prefix">The prefix.</param>
		/// <param name="inherit">Inherits parent object prefixes.</param>
		public HeaderPrefixAttribute(string prefix, bool inherit)
		{
			Prefix = prefix;
			Inherit = inherit;
		}

		/// <inheritdoc />
		public void ApplyTo(MemberReferenceMap referenceMap)
		{
			referenceMap.Data.Inherit = Inherit;
			referenceMap.Data.Prefix = Prefix ?? referenceMap.Data.Member.Name + ".";
		}

		/// <inheritdoc />
		public void ApplyTo(ParameterReferenceMap referenceMap)
		{
			referenceMap.Data.Inherit = Inherit;
			referenceMap.Data.Prefix = Prefix ?? referenceMap.Data.Parameter.Name + ".";
		}
	}
}