Added ObjectDisposedException and fixed README.md

wassy92x · Mar 4, 2022 · 78a0a58 · 78a0a58
1 parent a77770b
commit 78a0a58
Show file tree

Hide file tree

Showing 23 changed files with 126 additions and 79 deletions.
diff --git a/Code/src/Index.ts b/Code/src/Index.ts
@@ -10,6 +10,7 @@ export * from './NotFoundException';
 export * from './NotImplementedException';
 export * from './NotPermittedException';
 export * from './NotSupportedException';
+export * from './ObjectDisposedException';
 export * from './OperationAbortedException';
 export * from './TimeoutException';
 export * from './ValidationException';
diff --git a/Code/src/ObjectDisposedException.ts b/Code/src/ObjectDisposedException.ts
@@ -0,0 +1,27 @@
+import {InvalidOperationException} from './InvalidOperationException';
+
+/**
+ * Exception that will be thrown if an operation is invalid because the object is already disposed.
+ */
+export class ObjectDisposedException extends InvalidOperationException {
+ private readonly _objectName: symbol;
+
+ public constructor(objectName: string, cause?: Error);
+ public constructor(objectName: string, message?: string, cause?: Error);
+ public constructor(objectName: string, messageOrCause?: string | Error, cause?: Error) {
+ super(
+ typeof messageOrCause === 'string' ?
+ messageOrCause :
+ 'Cannot access a disposed object.',
+ typeof messageOrCause === 'string' || cause ?
+ cause :
+ messageOrCause
+ );
+ this._objectName = Symbol('Object name');
+ this.data[this._objectName] = objectName;
+ }
+
+ public get objectName(): string {
+ return this.data[this._objectName];
+ }
+}
diff --git a/Docs/assets/search.js b/Docs/assets/search.js
diff --git a/Docs/classes/AggregateException.html b/Docs/classes/AggregateException.html
diff --git a/Docs/classes/ArgumentException.html b/Docs/classes/ArgumentException.html
diff --git a/Docs/classes/ArgumentNullException.html b/Docs/classes/ArgumentNullException.html
diff --git a/Docs/classes/ArgumentOutOfRangeException.html b/Docs/classes/ArgumentOutOfRangeException.html
diff --git a/Docs/classes/ChuckNorrisException.html b/Docs/classes/ChuckNorrisException.html
diff --git a/Docs/classes/Exception.html b/Docs/classes/Exception.html
diff --git a/Docs/classes/IOException.html b/Docs/classes/IOException.html
diff --git a/Docs/classes/InvalidFormatException.html b/Docs/classes/InvalidFormatException.html
diff --git a/Docs/classes/InvalidOperationException.html b/Docs/classes/InvalidOperationException.html
diff --git a/Docs/classes/NotFoundException.html b/Docs/classes/NotFoundException.html
diff --git a/Docs/classes/NotImplementedException.html b/Docs/classes/NotImplementedException.html
diff --git a/Docs/classes/NotPermittedException.html b/Docs/classes/NotPermittedException.html
diff --git a/Docs/classes/NotSupportedException.html b/Docs/classes/NotSupportedException.html
diff --git a/Docs/classes/ObjectDisposedException.html b/Docs/classes/ObjectDisposedException.html
diff --git a/Docs/classes/OperationAbortedException.html b/Docs/classes/OperationAbortedException.html
diff --git a/Docs/classes/TimeoutException.html b/Docs/classes/TimeoutException.html
diff --git a/Docs/classes/ValidationException.html b/Docs/classes/ValidationException.html
diff --git a/Docs/index.html b/Docs/index.html
diff --git a/Docs/modules.html b/Docs/modules.html
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ follow this link: [Docs](https://htmlpreview.github.io/?https://raw.githubuserco
 Baseclass of all other exception classes.
 ```
 import {Exception} from 'grexcept';
-new Exception(message: string, innerException?: Error)
+new Exception(message: string, cause?: Error)
 
 Exception.fromObject(ex: any): Error
 // wrapps object inside a exception object if object is not already a exception or error
@@ -37,32 +37,32 @@ Exception.isError(ex: any): ex is Error
 Exception that will be thrown if multiple errors occurred.
 ```
 import {AggregateException} from 'grexcept';
-new AggregateException(innerException: Error | Error[], message?: string)
-new AggregateException(innerException: Error | Error[])
+new AggregateException(innerExceptions: Error | Error[], message?: string)
+new AggregateException(innerExceptions: Error | Error[])
 ```
 
 ### ArgumentException
 Exception that will be thrown if a value is invalid.
 ```
 import {ArgumentException} from 'grexcept';
-new ArgumentException(argumentName: PropertyKey, message?: string, innerException?: Error)
-new ArgumentException(argumentName: PropertyKey, innerException?: Error)
+new ArgumentException(argumentName: PropertyKey, message?: string, cause?: Error)
+new ArgumentException(argumentName: PropertyKey, cause?: Error)
 ```
 
 ### ArgumentNullException
 Exception that will be thrown if a value is null or undefined.
 ```
 import {ArgumentNullException} from 'grexcept';
-new ArgumentNullException(argumentName: PropertyKey, message?: string, innerException?: Error)
-new ArgumentNullException(argumentName: PropertyKey, innerException?: Error)
+new ArgumentNullException(argumentName: PropertyKey, message?: string, cause?: Error)
+new ArgumentNullException(argumentName: PropertyKey, cause?: Error)
 ```
 
 ### ArgumentOutOfRangeException
 Exception that will be thrown if a value is out of a range.
 ```
 import {ArgumentOutOfRangeException} from 'grexcept';
-new ArgumentOutOfRangeException(argumentName: PropertyKey, actualValue: any, message?: string, innerException?: Error)
-new ArgumentOutOfRangeException(argumentName: PropertyKey, actualValue: any, innerException?: Error)
+new ArgumentOutOfRangeException(argumentName: PropertyKey, actualValue: any, message?: string, cause?: Error)
+new ArgumentOutOfRangeException(argumentName: PropertyKey, actualValue: any, cause?: Error)
 ```
 
 ### ChuckNorrisException
@@ -76,77 +76,85 @@ new ChuckNorrisException(exceptionObject: any)
 Exception that will be thrown if a call of a method is invalid because of the current state of the object.
 ```
 import {InvalidOperationException} from 'grexcept';
-new InvalidOperationException(message?: string, innerException?: Error)
-new InvalidOperationException(innerException?: Error)
+new InvalidOperationException(message?: string, cause?: Error)
+new InvalidOperationException(cause?: Error)
 ```
 
 ### InvalidFormatException
 Exception that will be thrown if an object or string doesn't fulfill the excepted format.
 ```
 import {InvalidFormatException} from 'grexcept';
-new InvalidFormatException(message?: string, innerException?: Error)
-new InvalidFormatException(innerException?: Error)
+new InvalidFormatException(message?: string, cause?: Error)
+new InvalidFormatException(cause?: Error)
 ```
 
 ### IOException
 Exception that will be thrown if an input or output error occurred.
 ```
 import {IOException} from 'grexcept';
-new IOException(message?: string, innerException?: Error)
-new IOException(innerException?: Error)
+new IOException(message?: string, cause?: Error)
+new IOException(cause?: Error)
 ```
 
 ### NotFoundException
 Exception that will be thrown if some resource or entity was not found.
 ```
 import {NotFoundException} from 'grexcept';
-new NotFoundException(entity: string | (new (...args: any[]) => any), message?: string, innerException?: Error)
-new NotFoundException(entity: string | (new (...args: any[]) => any), innerException?: Error)
+new NotFoundException(entity: string | (new (...args: any[]) => any), message?: string, cause?: Error)
+new NotFoundException(entity: string | (new (...args: any[]) => any), cause?: Error)
 ```
 
 ### NotImplementedException
 Exception that will be thrown if some method or operation is not implemented.
 ```
 import {NotImplementedException} from 'grexcept';
-new NotImplementedException(message?: string, innerException?: Error)
-new NotImplementedException(innerException?: Error)
+new NotImplementedException(message?: string, cause?: Error)
+new NotImplementedException(cause?: Error)
 ```
 
 ### NotPermittedException
 Exception that will be thrown if the callee is not permitted to execute this method or operation.
 ```
 import {NotPermittedException} from 'grexcept';
-new NotPermittedException(message?: string, innerException?: Error)
-new NotPermittedException(innerException?: Error)
+new NotPermittedException(message?: string, cause?: Error)
+new NotPermittedException(cause?: Error)
 ```
 
 ### NotSupportedException
 Exception that will be thrown if the called method or operation is not supported.
 ```
 import {NotSupportedException} from 'grexcept';
-new NotSupportedException(message?: string, innerException?: Error)
-new NotSupportedException(innerException?: Error)
+new NotSupportedException(message?: string, cause?: Error)
+new NotSupportedException(cause?: Error)
+```
+
+### ObjectDisposedException
+Exception that will be thrown if an operation is invalid because the object is already disposed.
+```
+import {ObjectDisposedException} from 'grexcept';
+new ObjectDisposedException(objectName: string, message?: string, cause?: Error)
+new ObjectDisposedException(objectName: string, cause?: Error)
 ```
 
 ### OperationAbortedException
 ```
 import {OperationAbortedException} from 'grexcept';
-new OperationAbortedException(reason?: string, innerException?: Error)
-new OperationAbortedException(innerException?: Error)
+new OperationAbortedException(reason?: string, cause?: Error)
+new OperationAbortedException(cause?: Error)
 ```
 
 ### TimeoutException
 Exception that will be thrown if a timeout has been reached and an operation was canceled.
 ```
 import {TimeoutException} from 'grexcept';
-new TimeoutException(timeout: number, reason?: string, innerException?: Error)
-new TimeoutException(timeout: number, innerException?: Error)
+new TimeoutException(timeout: number, reason?: string, cause?: Error)
+new TimeoutException(timeout: number, cause?: Error)
 ```
 
 ### ValidationException
 Exception that will be thrown if a validation of some argument failed.
 ```
 import {ValidationException} from 'grexcept';
-new ValidationException(message?: string, innerException?: Error)
-new ValidationException(innerException?: Error)
+new ValidationException(message?: string, cause?: Error)
+new ValidationException(cause?: Error)
 ```