|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
namespace System.ComponentModel.DataAnnotations.Schema
{
/// <summary>
/// Specifies the database column that a property is mapped to.
/// </summary>
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false)]
public class ColumnAttribute : Attribute
{
private int _order = -1;
private string? _typeName;
/// <summary>
/// Initializes a new instance of the <see cref="ColumnAttribute" /> class.
/// </summary>
public ColumnAttribute()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ColumnAttribute" /> class.
/// </summary>
/// <param name="name">The name of the column the property is mapped to.</param>
public ColumnAttribute(string name)
{
ArgumentException.ThrowIfNullOrWhiteSpace(name);
Name = name;
}
/// <summary>
/// The name of the column the property is mapped to.
/// </summary>
public string? Name { get; }
/// <summary>
/// The zero-based order of the column the property is mapped to.
/// </summary>
public int Order
{
get => _order;
set
{
ArgumentOutOfRangeException.ThrowIfNegative(value);
_order = value;
}
}
/// <summary>
/// The database provider specific data type of the column the property is mapped to.
/// </summary>
[DisallowNull]
public string? TypeName
{
get => _typeName;
set
{
ArgumentException.ThrowIfNullOrWhiteSpace(value);
_typeName = value;
}
}
}
}
|