CommandLine.Text.Example Class Reference

Models a command line usage example. More...

Inheritance diagram for CommandLine.Text.Example:

Public Member Functions
	Example (string helpText, IEnumerable< UnParserSettings > formatStyles, object sample)
	Initializes a new instance of the CommandLine.Text.Example class.
	Example (string helpText, UnParserSettings formatStyle, object sample)
	Initializes a new instance of the CommandLine.Text.Example class.
	Example (string helpText, object sample)
	Initializes a new instance of the CommandLine.Text.Example class.
bool	Equals (Example other)
	Returns a value that indicates whether the current instance and a specified CommandLine.Text.Example 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.

Properties
string	HelpText [get]
	Example description.
IEnumerable< UnParserSettings >	FormatStyles [get]
	A sequence of format styles.
object	Sample [get]
	A sample instance.

Detailed Description

Models a command line usage example.

Definition at line 12 of file Example.cs.

Constructor & Destructor Documentation

Example() [1/3]

CommandLine.Text.Example.Example	(	string	helpText,
		IEnumerable< UnParserSettings >	formatStyles,
		object	sample
	)

Initializes a new instance of the CommandLine.Text.Example class.

Parameters

helpText	Example description.
formatStyles	A CommandLine.UnParserSettings instances sequence that defines command line arguments format.
sample	A sample instance.

Definition at line 23 of file Example.cs.

        {
            if (string.IsNullOrEmpty(helpText))
            {
                throw new ArgumentException("helpText can't be null or empty", "helpText");
            }
 
            if (formatStyles == null)
            {
                throw new ArgumentNullException("formatStyles");
            }
 
            if (sample == null)
            {
                throw new ArgumentNullException("sample");
            }
 
            HelpText = helpText;
            FormatStyles = formatStyles;
            Sample = sample;
        }

Example() [2/3]

CommandLine.Text.Example.Example	(	string	helpText,
		UnParserSettings	formatStyle,
		object	sample
	)

Initializes a new instance of the CommandLine.Text.Example class.

Parameters

helpText	Example description.
formatStyle	A CommandLine.UnParserSettings instance that defines command line arguments format.
sample	A sample instance.

Definition at line 54 of file Example.cs.

            : this(helpText,
                   new[] { formatStyle },
                   sample
                  ) { }

Example() [3/3]

CommandLine.Text.Example.Example	(	string	helpText,
		object	sample
	)

Initializes a new instance of the CommandLine.Text.Example class.

Parameters

helpText	Example description.
sample	A sample instance.

Definition at line 65 of file Example.cs.

            : this(helpText, Enumerable.Empty<UnParserSettings>(), sample) { }

Member Function Documentation

Equals() [1/2]

bool CommandLine.Text.Example.Equals

(

Example

other

)

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

Parameters

other

The CommandLine.Text.Example instance to compare.

Returns

true

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

false

Definition at line 97 of file Example.cs.

        {
            if (other == null)
            {
                return false;
            }
 
            return HelpText.Equals(other.HelpText) &&
                   FormatStyles.SequenceEqual(other.FormatStyles) &&
                   Sample.Equals(other.Sample);
        }

Equals() [2/2]

override bool CommandLine.Text.Example.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 121 of file Example.cs.

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

GetHashCode()

override int CommandLine.Text.Example.GetHashCode

(

)

Serves as a hash function for a particular type.

A hash code for the current System.Object.

Definition at line 137 of file Example.cs.

        {
            return new { HelpText, FormatStyles, Sample }.GetHashCode();
        }

Property Documentation

FormatStyles

IEnumerable<UnParserSettings> CommandLine.Text.Example.FormatStyles

get

A sequence of format styles.

Definition at line 76 of file Example.cs.

{ get; }

HelpText

string CommandLine.Text.Example.HelpText

get

Example description.

Definition at line 71 of file Example.cs.

{ get; }

Sample

object CommandLine.Text.Example.Sample

get

A sample instance.

Definition at line 81 of file Example.cs.

{ get; }

---

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

• deps/commandlineparser/src/CommandLine/Text/Example.cs