This package contains
- ShieldClause (NuGet: Vishnu.ShieldClause)
A simple package with extensible shield clauses
- HandleClause (NuGet : Vishnu.HandleClause)
A package for handling exceptions based on Attributes, Inline and Exception Chaining
If you like or are using this project please give it a star. Thanks!
1. Vishnu.ShieldClause [ NuGet: Vishnu.ShieldClause ]
A simple package with extensible shield clauses.
public void ValidateContent(User user, string input)
{
Shield.Against.Null(User, nameof(user));
Shield.Throws.ArugmentNullException<string>((input) => { return input == null ? true : false; }, null, "param1"));
Shield.Throws.ArugmentNullException(Validate(""), null, "param1"));
Shield.Throws.ArgumentException((true || true), "param1"));
}
public bool Validate(string input)
{
if(string.IsNullOrEmpty(input))
{
return true;
}
}- Shield.Against.NullOrEmpty
- Shield.Against.NullOrWhiteSpace
- Shield.Against.OutOfRange
- Shield.Against.LesserThan<T>
- Shield.Against.GreaterThan<T>
- Shield.Against.IsTypeOf<T>
- Shield.Against.NullOrEmpty<T>
- Shield.Throws.ArgumentException
- Shield.Throws.ArgumentNullException
- Shield.Throws.TimeoutException
- Shield.Throws.NotSupportedException // use extension methods on IShieldClause for adding more functionality in "Against"
namespace Vishnu.ShieldClause
{
public static class ShieldClauseExtension
{
public static void Tst(this IShieldClause shieldClause, int input, string parameterName)
{
}
}
}
// use extension methods on ExceptionContainer for adding more functionality in "Throw"
namespace Vishnu.ShieldClause
{
public static class ShieldClauseExtension
{
public static void FileNotFoundException(this ExceptionContainer container, bool when, int input, string parameterName)
{
}
}
}
2. Vishnu.HandleClause [ NuGet: Vishnu.HandleClause ]
A package for handling exception and invokes specific action based on the exception
- Handle Attribute
- Inline
- Exception chaining
Attribute Handle, supresses or handles the exceptions raised by any method. Optionally allows to invoke other action if any exception is handled or supressed. Handle attribute allows inheritance.
- Import namespace
using Vishnu.HandleClause;- Decorate the method with Handle attribute and specify the type of exceptions to be handled.
public class Foo
{
// Handles supress only one exception
[Handle(typeof(ArgumentNullException))]
public void Update(string value)
{
var result = Check(value);
}
// Handle multiple exceptions. Any custom exceptions can also be specifieed
[Handle(new Type[] { typeof(ArgumentNullException), typeof(ArgumentException), typeof(CustomException) })]
public int Sycnchorize()
{
return 0;
}
}- Pass the method in Handle.Method
public void Test()
{
Foo foo = new Foo();
// call the specific method to be invoked.
Handle.Method<string>(foo.Update, "value");
Handle.Method(foo.Sycnchorize);
// pass the action to be excecuted if the exception is handled.
Handle.Method(foo.Sycnchorize, ExceptionHandledCallback);
}
// Action invoked if the exception is handled.
private void ExceptionHandledCallback(Exception ex)
{
//
}- Handle.Method(Action action, Action<Exception> exceptionHandledAction = null)
- Handle.Method<TInput>(Action<TInput> action, TInput input, Action<Exception> exceptionHandledAction = null)
- TResult result = Handle.Method<TResult>(Func<TResult> action, Action<Exception> exceptionHandledAction = null)
- TResult result = Handle.Method<TInput, TResult>(Func<TInput, TResult> action, TInput input, Action<Exception> exceptionHandledAction = null)
- TResult result = Handle.Method<TInput1, TInput2, TResult>(Func<TInput1, TInput2, TResult> action, TInput1 input1, TInput2 input2, Action<Exception> exceptionHandledAction = null)
- TResult result = Handle.Method<TInput1, TInput2, TInput3, TResult>(Func<TInput1, TInput2, TInput3, TResult> action, TInput1 input1, TInput2 input2, TInput3 input3, Action<Exception> exceptionHandledAction = null)Inline exception handling allows to handle or supress only one exception. Optionally, it allows to invoke an action if the exception is handled.
- Declare namespace
using Vishnu.HandleClause;- Use Handle.Inline static method and pass the action to be invoked as parameter. Optionally exception handled call back can also be passed.
public class Boo
{
public void Update()
{
.....
}
public int Update(string value)
{
....
return 0;
}
}
public void Test()
{
Boo boo = new Boo();
// handles ArgumentException
Handle.Inline<ArgumentException>(boo.Update);
Handle.Inline<ArgumentException, string, int>(boo.Update, "hello");
// Handles ArgumentException and also invokes ExceptionHandledCallback if exception is handled.
Handle.Inline<ArgumentException, string, int>(boo.Update, "hello", this.ExceptionHandledCallback);
}
- Handle.Inline<TException>(Action action, Action<Exception> exceptionHanldedAction = null) where TException : Exception
- Handle.Inline<TException, TInput>(Action<TInput> action, TInput input, Action<Exception> exceptionHanldedAction = null) where TException : Exception
- TResult result = Handle.Inline<TException, TResult>(Func<TResult> action, Action<Exception> exceptionHanldedAction = null) where TException : Exception
- TResult result = Handle.Inline<TException, TInput, TResult>(Func<TInput, TResult> action, TInput input, Action<Exception> exceptionHanldedAction = null) where TException : Exception
- TResult result = Handle.Inline<TException, TInput1, TInput2, TResult>(Func<TInput1, TInput2, TResult> action, TInput1 input1, TInput2 input2, Action<Exception> exceptionHanldedAction = null) where TException : Exception
- TResult result = Handle.Inline<TException, TInput1, TInput2, TInput3, TResult>(Func<TInput1, TInput2, TInput3, TResult> action, TInput1 input1, TInput2 input2, TInput3 input3, Action<Exception> exceptionHanldedAction = null) where TException : ExceptionException chaining allows to handle multiple exception. Optionally, it allows to invoke an action if the exception is handled.
- Declare namespace
using Vishnu.HandleClause;- Use 'Case' to handle specific exception and we can chain multiple exception by using 'Or'. Finally call Execute to invoke the specific action. Optionally exception handled call back can also be passed.
public class Boo
{
public void Update()
{
.....
}
public int Update(string value)
{
....
return 0;
}
}
public void Test()
{
int result = Handle
.Case<ArgumentNullException>() // exception
.Or<CustomException>() // chain exception using Or
.Or<ArgumentException>()
.UseSync() // only synch methods allowed
.Execute<string int>(new Boo().Update, "test"); // call the method
// Handles ArgumentException and also invokes ExceptionHandledCallback if exception is handled.
int result = Handle
.Case<ArgumentNullException>() // exception
.UseSync() // only synch methods allowed
.Execute(new Boo().Update, ExceptionHandledCallback); // call the method
}
Syntax : [] - Optional
- Handle .Case<Exception> [.Or<Exception> .Or<Exception> ....] .UseSync() .Execute[<Parameters, ReturnValue>](action, [callback])
Overloaded execute methods
- Execute<TInput>(Action<TInput> action, TInput input, Action<Exception> exceptionHanldedAction = null)
- Execute(Action action, Action<Exception> exceptionHanldedAction = null)
- var result = Execute<TResult>(Func<TResult> action, Action<Exception> exceptionHanldedAction = null)
- var result = Execute<TInput, TResult>(Func<TInput, TResult> action, TInput input, Action<Exception> exceptionHanldedAction = null)
- var result = Execute<TInput1, TInput2, TResult>(Func<TInput1, TInput2, TResult> action, TInput1 input1, TInput2 input2, Action<Exception> exceptionHanldedAction = null)
- var result = Execute<TInput1, TInput2, TInput3, TResult>(Func<TInput1, TInput2, TInput3, TResult> action, TInput1 input1, TInput2 input2, TInput3 input3, Action<Exception> exceptionHanldedAction = null)