CommandLine.Error Class Reference

Base type of all errors. More...

Inheritance diagram for CommandLine.Error:

Public Member Functions
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
	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
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 errors.

All errors are defined within the system. There's no reason to create custom derivate types.

Definition at line 109 of file Error.cs.

Constructor & Destructor Documentation

Error() [1/2]

CommandLine.Error.Error ( ErrorType  tag, bool  stopsProcessing  )

package

Initializes a new instance of the CommandLine.Error class.

Parameters

tag	Type discriminator tag.
stopsProcessing	Tells if error stops parsing process.

Definition at line 116 of file Error.cs.

        {
            Tag = tag;
            StopsProcessing = stopsProcessing;
        }

Error() [2/2]

CommandLine.Error.Error ( ErrorType  tag )

package

Initializes a new instance of the CommandLine.Error class.

Parameters

tag	Type discriminator tag.

Definition at line 126 of file Error.cs.

            : this(tag, false) { }

Member Function Documentation

Equals() [1/2]

bool CommandLine.Error.Equals

(

Error

other

)

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

Parameters

other

The CommandLine.Error instance to compare.

Returns

true

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

false

Definition at line 154 of file Error.cs.

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

Equals() [2/2]

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

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

GetHashCode()

override int CommandLine.Error.GetHashCode

(

)

Serves as a hash function for a particular type.

A hash code for the current System.Object.

Definition at line 192 of file Error.cs.

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

Property Documentation

StopsProcessing

bool CommandLine.Error.StopsProcessing

get

Tells if error stops parsing process. Filtered by CommandLine.ErrorExtensions.OnlyMeaningfulOnes(System.Collections.Generic.IEnumerable<Error>).

Definition at line 139 of file Error.cs.

{ get; }

Tag

ErrorType CommandLine.Error.Tag

get

Error type discriminator, defined as CommandLine.ErrorType enumeration.

Definition at line 132 of file Error.cs.

{ get; }

---

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

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