CommandLine.NamedError Class Reference

Base type of all erros with name information. More...

Inheritance diagram for CommandLine.NamedError:

Public Member Functions
bool	Equals (NamedError other)
	Returns a value that indicates whether the current instance and a specified CommandLine.NamedError 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.
Public Member Functions inherited from CommandLine.Error
bool	Equals (Error other)
	Returns a value that indicates whether the current instance and a specified CommandLine.Error 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.

Package Functions
	NamedError (ErrorType tag, NameInfo nameInfo)
	Initializes a new instance of the CommandLine.NamedError class.
Package Functions inherited from CommandLine.Error
	Error (ErrorType tag, bool stopsProcessing)
	Initializes a new instance of the CommandLine.Error class.
	Error (ErrorType tag)
	Initializes a new instance of the CommandLine.Error class.

Properties
NameInfo	NameInfo [get]
	Name information relative to this error instance.
Properties inherited from CommandLine.Error
ErrorType	Tag [get]
	Error type discriminator, defined as CommandLine.ErrorType enumeration.
bool	StopsProcessing [get]
	Tells if error stops parsing process. Filtered by CommandLine.ErrorExtensions.OnlyMeaningfulOnes(System.Collections.Generic.IEnumerable<Error>).

Detailed Description

Base type of all erros with name information.

Definition at line 294 of file Error.cs.

Constructor & Destructor Documentation

NamedError()

CommandLine.NamedError.NamedError ( ErrorType  tag, NameInfo  nameInfo  )

package

Initializes a new instance of the CommandLine.NamedError class.

Parameters

tag	Error type.
nameInfo	Problematic name.

Definition at line 301 of file Error.cs.

            : base(tag)
        {
            NameInfo = nameInfo;
        }

Member Function Documentation

Equals() [1/2]

bool CommandLine.NamedError.Equals

(

NamedError

other

)

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

Parameters

other

The CommandLine.NamedError instance to compare.

Returns

true

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

false

Definition at line 326 of file Error.cs.

        {
            if (other == null)
            {
                return false;
            }
 
            return Tag.Equals(other.Tag) && NameInfo.Equals(other.NameInfo);
        }

Equals() [2/2]

override bool CommandLine.NamedError.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 348 of file Error.cs.

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

GetHashCode()

override int CommandLine.NamedError.GetHashCode

(

)

Serves as a hash function for a particular type.

A hash code for the current System.Object.

Definition at line 364 of file Error.cs.

        {
            return new { Tag, StopsProcessing, NameInfo }.GetHashCode();
        }

Property Documentation

NameInfo

NameInfo CommandLine.NamedError.NameInfo

get

Name information relative to this error instance.

Definition at line 310 of file Error.cs.

{ get; }

---

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

• deps/commandlineparser/src/CommandLine/Error.cs