Class ValidationExceptionManager

Class that manages the validation exceptions for this package.

Inheritance

object

ValidationExceptionManager

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: UnityEditor.PackageManager.ValidationSuite

Assembly: solution.dll

Syntax

public class ValidationExceptionManager

Constructors

ValidationExceptionManager(string)

Constructor for the Validation Exception Manager

Declaration

public ValidationExceptionManager(string packagePath)

Parameters

Type	Name	Description
string	packagePath	Path that contains the exception file.

Properties

HasErrorExceptions

Will return true if the package contains 1 or more validation error exceptions

Declaration

public bool HasErrorExceptions { get; }

Property Value

Type	Description
bool

HasExceptions

Will return true if the package contains 1 or more validation exceptions

Declaration

public bool HasExceptions { get; }

Property Value

Type	Description
bool

HasWarningExceptions

Will return true if the package contains 1 or more validation warning exceptions

Declaration

public bool HasWarningExceptions { get; }

Property Value

Type	Description
bool

Methods

CheckValidationExceptions(string)

Checks the validity of the validation exception list.

Declaration

public IEnumerable<string> CheckValidationExceptions(string packageVersion)

Parameters

Type	Name	Description
string	packageVersion	Package version used for comparison.

Returns

Type	Description
IEnumerable<string>	Returns a list of issues found with the exception list. That list will be empty when no issues are found.

IsErrorException(string, string)

Tests whether a test class has been exceptioned completely with respect to errors.

Declaration

public bool IsErrorException(string validationTest, string packageVersion)

Parameters

Type	Name	Description
string	validationTest	Validation test display name
string	packageVersion	Version of the package this exception is for.

Returns

Type	Description
bool	True if the error is part of the validation exception list.

IsErrorException(string, string, string)

Tests whether the requested error is part of the validation exception list.

Declaration

public bool IsErrorException(string validationTest, string validationMessage, string packageVersion)

Parameters

Type	Name	Description
string	validationTest	Validation test display name
string	validationMessage	Error string, verbatim
string	packageVersion	Version of the package this exception is for.

Returns

Type	Description
bool	True if the error is part of the validation exception list.

IsWarningException(string, string)

Tests whether a test class has been exceptioned completely with respect to warnings.

Declaration

public bool IsWarningException(string validationTest, string packageVersion)

Parameters

Type	Name	Description
string	validationTest	Validation test display name
string	packageVersion	Version of the package this exception is for.

Returns

Type	Description
bool	True if the warning is part of the validation exception list.

IsWarningException(string, string, string)

Tests whether the requested warning is part of the validation exception list.

Declaration

public bool IsWarningException(string validationTest, string validationMessage, string packageVersion)

Parameters

Type	Name	Description
string	validationTest	Validation test display name
string	validationMessage	Warning string, verbatim
string	packageVersion	Version of the package this exception is for.

Returns

Type	Description
bool	True if the warning is part of the validation exception list.