Class ValidationError

Reports that there was a validation issue with a Command.

Inheritance

System.Object

ValidationError

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Petabridge.Cmd.Validation

Assembly: cs.temp.dll.dll

Syntax

public sealed class ValidationError

Constructors

ValidationError(String, String, String, String, String, String)

Declaration

public ValidationError(string module, string command, string argument, string value, string errorMessage, string helpInfo = null)

Parameters

Type	Name	Description
System.String	module
System.String	command
System.String	argument
System.String	value
System.String	errorMessage
System.String	helpInfo

Fields

NullCmd

Singleton used for when a null command is given.

Declaration

public static readonly ValidationError NullCmd

Field Value

Type	Description
ValidationError

Properties

Argument

Optional. The name of the argument that failed.

Declaration

public string Argument { get; }

Property Value

Type	Description
System.String

Command

The name of the command that failed.

Declaration

public string Command { get; }

Property Value

Type	Description
System.String

ErrorMessage

The validation error message.

Declaration

public string ErrorMessage { get; }

Property Value

Type	Description
System.String

HelpInfo

Optional. A help message with information on how to resolve the issue.

Declaration

public string HelpInfo { get; }

Property Value

Type	Description
System.String

Module

The module of the command / argument that failed

Declaration

public string Module { get; }

Property Value

Type	Description
System.String

Value

Optional. The value of the argument that failed.

Declaration

public string Value { get; }

Property Value

Type	Description
System.String

Methods

IllegalDuplicateArgument(String, String, String)

Declaration

public static ValidationError IllegalDuplicateArgument(string moduleName, string commandName, string argumentName)

Parameters

Type	Name	Description
System.String	moduleName
System.String	commandName
System.String	argumentName

Returns

Type	Description
ValidationError

MissingArgumentValue(String, String, String)

Declaration

public static ValidationError MissingArgumentValue(string moduleName, string commandName, string argumentName)

Parameters

Type	Name	Description
System.String	moduleName
System.String	commandName
System.String	argumentName

Returns

Type	Description
ValidationError

MissingRequiredArgument(String, String, String)

Declaration

public static ValidationError MissingRequiredArgument(string moduleName, string commandName, string argumentName)

Parameters

Type	Name	Description
System.String	moduleName
System.String	commandName
System.String	argumentName

Returns

Type	Description
ValidationError

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

UnexpectedFlagValue(String, String, String, String)

Declaration

public static ValidationError UnexpectedFlagValue(string moduleName, string commandName, string argumentName, string value)

Parameters

Type	Name	Description
System.String	moduleName
System.String	commandName
System.String	argumentName
System.String	value

Returns

Type	Description
ValidationError

UnknownArgument(String, String, String)

Declaration

public static ValidationError UnknownArgument(string moduleName, string commandName, string argumentName)

Parameters

Type	Name	Description
System.String	moduleName
System.String	commandName
System.String	argumentName

Returns

Type	Description
ValidationError

UnknownCommand(String, String)

Declaration

public static ValidationError UnknownCommand(string moduleName, string commandName)

Parameters

Type	Name	Description
System.String	moduleName
System.String	commandName

Returns

Type	Description
ValidationError

UnknownModule(String, String)

Declaration

public static ValidationError UnknownModule(string expectedModuleName, string actualModuleName)

Parameters

Type	Name	Description
System.String	expectedModuleName
System.String	actualModuleName

Returns

Type	Description
ValidationError