Trigger4Win/libcmdline/Attributes/OptionAttribute.cs

83 lines
3.2 KiB
C#
Raw Normal View History

2015-04-10 02:09:58 +02:00
#region License
// <copyright file="OptionAttribute.cs" company="Giacomo Stelluti Scala">
// Copyright 2015-2013 Giacomo Stelluti Scala
// </copyright>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#endregion
#region Using Directives
using System;
using CommandLine.Parsing;
#endregion
namespace CommandLine
{
/// <summary>
/// Models an option specification.
/// </summary>
[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
public sealed class OptionAttribute : BaseOptionAttribute
{
/// <summary>
/// Initializes a new instance of the <see cref="CommandLine.OptionAttribute"/> class.
/// The default long name will be inferred from target property.
/// </summary>
public OptionAttribute()
{
AutoLongName = true;
}
/// <summary>
/// Initializes a new instance of the <see cref="CommandLine.OptionAttribute"/> class.
/// </summary>
/// <param name="shortName">The short name of the option..</param>
public OptionAttribute(char shortName)
: base(shortName, null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="CommandLine.OptionAttribute"/> class.
/// </summary>
/// <param name="longName">The long name of the option.</param>
public OptionAttribute(string longName)
: base(null, longName)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="CommandLine.OptionAttribute"/> class.
/// </summary>
/// <param name="shortName">The short name of the option.</param>
/// <param name="longName">The long name of the option or null if not used.</param>
public OptionAttribute(char shortName, string longName)
: base(shortName, longName)
{
}
/// <summary>
/// Helper factory method for testing purpose.
/// </summary>
/// <returns>An <see cref="OptionInfo"/> instance.</returns>
internal OptionInfo CreateOptionInfo()
{
return new OptionInfo(ShortName, LongName);
}
}
}