// 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
{
///
/// Appends a prefix to the header of each field of the reference member.
///
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter, AllowMultiple = false, Inherited = true)]
public class HeaderPrefixAttribute : Attribute, IMemberReferenceMapper, IParameterReferenceMapper
{
///
/// Gets the prefix.
///
public string? Prefix { get; private set; }
///
/// Gets a value indicating if the prefix should inherit parent prefixes.
///
public bool Inherit { get; private set; }
///
/// Appends a prefix to the header of each field of the reference member.
///
public HeaderPrefixAttribute() { }
///
/// Appends a prefix to the header of each field of the reference member.
///
/// The prefix.
public HeaderPrefixAttribute(string prefix)
{
Prefix = prefix;
}
///
/// Appends a prefix to the header of each field of the reference member.
///
/// Inherits parent object prefixes.
public HeaderPrefixAttribute(bool inherit)
{
Inherit = inherit;
}
///
/// Appends a prefix to the header of each field of the reference member.
///
/// The prefix.
/// Inherits parent object prefixes.
public HeaderPrefixAttribute(string prefix, bool inherit)
{
Prefix = prefix;
Inherit = inherit;
}
///
public void ApplyTo(MemberReferenceMap referenceMap)
{
referenceMap.Data.Inherit = Inherit;
referenceMap.Data.Prefix = Prefix ?? referenceMap.Data.Member.Name + ".";
}
///
public void ApplyTo(ParameterReferenceMap referenceMap)
{
referenceMap.Data.Inherit = Inherit;
referenceMap.Data.Prefix = Prefix ?? referenceMap.Data.Parameter.Name + ".";
}
}
}