CommandLine.Core.Value Class Reference

Inheritance diagram for CommandLine.Core.Value:

Public Member Functions
	Value (string text)
	Value (string text, bool explicitlyAssigned)
	Value (string text, bool explicitlyAssigned, bool forced, bool fromSeparator)
bool	Equals (Value other)
override bool	Equals (object obj)
override int	GetHashCode ()

Properties
bool	ExplicitlyAssigned [get]
	Whether this value came from a long option with "=" separating the name from the value.
bool	FromSeparator [get]
	Whether this value came from a sequence specified with a separator (e.g., "--files a.txt,b.txt,c.txt")
bool	Forced [get]
	Whether this value came from args after the – separator (when EnableDashDash = true)
Properties inherited from CommandLine.Core.Token
TokenType	Tag [get]
string	Text [get]

Additional Inherited Members
Static Public Member Functions inherited from CommandLine.Core.Token
static Token	Name (string text)
static Token	Value (string text)
static Token	Value (string text, bool explicitlyAssigned)
static Token	ValueForced (string text)
static Token	ValueFromSeparator (string text)
Protected Member Functions inherited from CommandLine.Core.Token
	Token (TokenType tag, string text)

Detailed Description

Definition at line 88 of file Token.cs.

Constructor & Destructor Documentation

Value() [1/3]

CommandLine.Core.Value.Value

(

string

text

)

Definition at line 90 of file Token.cs.

            : this(text, false, false, false) { }

Value() [2/3]

CommandLine.Core.Value.Value	(	string	text,
		bool	explicitlyAssigned
	)

Definition at line 93 of file Token.cs.

            : this(text, explicitlyAssigned, false, false) { }

Value() [3/3]

CommandLine.Core.Value.Value	(	string	text,
		bool	explicitlyAssigned,
		bool	forced,
		bool	fromSeparator
	)

Definition at line 96 of file Token.cs.

            : base(TokenType.Value, text)
        {
            ExplicitlyAssigned = explicitlyAssigned;
            Forced = forced;
            FromSeparator = fromSeparator;
        }

Member Function Documentation

Equals() [1/2]

override bool CommandLine.Core.Value.Equals

(

object

obj

)

Definition at line 133 of file Token.cs.

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

Equals() [2/2]

bool CommandLine.Core.Value.Equals

(

Value

other

)

Definition at line 121 of file Token.cs.

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

GetHashCode()

override int CommandLine.Core.Value.GetHashCode

(

)

Definition at line 145 of file Token.cs.

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

Property Documentation

ExplicitlyAssigned

bool CommandLine.Core.Value.ExplicitlyAssigned

get

Whether this value came from a long option with "=" separating the name from the value.

Definition at line 107 of file Token.cs.

{ get; }

Forced

bool CommandLine.Core.Value.Forced

get

Whether this value came from args after the – separator (when EnableDashDash = true)

Definition at line 117 of file Token.cs.

{ get; }

FromSeparator

bool CommandLine.Core.Value.FromSeparator

get

Whether this value came from a sequence specified with a separator (e.g., "--files a.txt,b.txt,c.txt")

Definition at line 112 of file Token.cs.

{ get; }

---

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

• deps/commandlineparser/src/CommandLine/Core/Token.cs