Models name information, used in CommandLine.Error instances. More...

Inheritance diagram for CommandLine.NameInfo:

Public Member Functions
bool	Equals (NameInfo other)
	Returns a value that indicates whether the current instance and a specified CommandLine.NameInfo have the same value.

override bool	Equals (object obj)
	Determines whether the specified System.Object is equal to the current System.Object.

override int	GetHashCode ()
	Serves as a hash function for a particular type.

Static Public Attributes
static readonly NameInfo	EmptyName = new NameInfo(string.Empty, string.Empty)
	Represents an empty name information. Used when CommandLine.Error are tied to values, rather than options.

Package Functions
	NameInfo (string shortName, string longName)

Properties
string	ShortName `[get]`
	Gets the short name of the name information.

string	LongName `[get]`
	Gets the long name of the name information.

string	NameText `[get]`
	Gets a formatted text with unified name information.

Detailed Description

Models name information, used in CommandLine.Error instances.

Definition at line 10 of file NameInfo.cs.

Constructor & Destructor Documentation

◆ NameInfo()

CommandLine.NameInfo.NameInfo	(	string	shortName,
		string	longName
	)

package

Definition at line 18 of file NameInfo.cs.

        {
            if (shortName == null)
            {
                throw new ArgumentNullException("shortName");
            }
 
            if (longName == null)
            {
                throw new ArgumentNullException("longName");
            }
 
            LongName = longName;
            ShortName = shortName;
        }

Member Function Documentation

◆ Equals() [1/2]

bool CommandLine.NameInfo.Equals ( NameInfo other )

Returns a value that indicates whether the current instance and a specified CommandLine.NameInfo have the same value.

Parameters

other The CommandLine.NameInfo instance to compare.

Returns: true

if this instance of CommandLine.NameInfo and other have the same value; otherwise,

false

Definition at line 64 of file NameInfo.cs.

        {
            if (other == null)
            {
                return false;
            }
 
            return ShortName.Equals(other.ShortName) && LongName.Equals(other.LongName);
        }

◆ Equals() [2/2]

override bool CommandLine.NameInfo.Equals ( object obj )

Determines whether the specified System.Object is equal to the current System.Object.

Parameters

obj	The System.Object to compare with the current System.Object.

Returns: true

if the specified System.Object is equal to the current System.Object; otherwise,

false

Definition at line 86 of file NameInfo.cs.

        {
            NameInfo other = obj as NameInfo;
 
            if (other != null)
            {
                return Equals(other);
            }
 
            return base.Equals(obj);
        }

◆ GetHashCode()

override int CommandLine.NameInfo.GetHashCode ( )

Serves as a hash function for a particular type.

A hash code for the current System.Object.

Definition at line 102 of file NameInfo.cs.

        {
            return new { ShortName, LongName }.GetHashCode();
        }

Member Data Documentation

◆ EmptyName

readonly NameInfo CommandLine.NameInfo.EmptyName = new NameInfo(string.Empty, string.Empty)

static

Represents an empty name information. Used when CommandLine.Error are tied to values, rather than options.

Definition at line 16 of file NameInfo.cs.

Property Documentation

◆ LongName

string CommandLine.NameInfo.LongName

get

Gets the long name of the name information.

Definition at line 42 of file NameInfo.cs.

42{ get; }

◆ NameText

string CommandLine.NameInfo.NameText

get

Gets a formatted text with unified name information.

Definition at line 47 of file NameInfo.cs.

◆ ShortName

string CommandLine.NameInfo.ShortName

get

Gets the short name of the name information.

Definition at line 37 of file NameInfo.cs.

37{ get; }

The documentation for this class was generated from the following file:

deps/commandlineparser/src/CommandLine/NameInfo.cs

Public Member Functions

Static Public Attributes

Package Functions

Properties