onixbyte/onixbyte-bom
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

style: reformatted javadocs

Browse Source
This commit is contained in:
zihluwang
2024-12-26 20:16:00 +08:00
parent 2d3a0745f5
commit ade73ae8e3
1 changed files with 10 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
devkit-core/src/main/java/com/onixbyte/devkit/core/exceptions/NotImplementedException.java
+10 -15
View File
@@ -18,14 +18,12 @@
package com.onixbyte.devkit.core.exceptions; package com.onixbyte.devkit.core.exceptions;
/** /**
* The {@code NotImplementedException} class is a custom runtime exception * The {@code NotImplementedException} class is a custom runtime exception that represents a situation where a
* that represents a situation where a particular method or functionality is * particular method or functionality is not implemented or is currently unavailable in the codebase.
* not implemented or is currently unavailable in the codebase.
* <p> * <p>
* This exception is typically thrown when developers need to indicate that a * This exception is typically thrown when developers need to indicate that a specific part of the code is incomplete
* specific part of the code is incomplete or requires further implementation. * or requires further implementation. It serves as a placeholder to highlight unfinished sections of the application
* It serves as a placeholder to highlight unfinished sections of the * during development and testing phases.
* application during development and testing phases.
* <p> * <p>
* Usage Example: * Usage Example:
* <pre> * <pre>
@@ -54,15 +52,13 @@ package com.onixbyte.devkit.core.exceptions;
public class NotImplementedException extends RuntimeException { public class NotImplementedException extends RuntimeException {
/** /**
* Creates a new {@code NotImplementedException} with no specific error * Creates a new {@code NotImplementedException} with no specific error message.
* message.
*/ */
public NotImplementedException() { public NotImplementedException() {
} }
/** /**
* Creates a new {@code NotImplementedException} with the provided error * Creates a new {@code NotImplementedException} with the provided error message.
* message.
* *
* @param message the error message associated with this exception * @param message the error message associated with this exception
*/ */
@@ -71,8 +67,7 @@ public class NotImplementedException extends RuntimeException {
} }
/** /**
* Creates a new {@code NotImplementedException} with the specified error * Creates a new {@code NotImplementedException} with the specified error message and a cause for this exception.
* message and a cause for this exception.
* *
* @param message the error message associated with this exception * @param message the error message associated with this exception
* @param cause the cause of this exception * @param cause the cause of this exception
@@ -91,8 +86,8 @@ public class NotImplementedException extends RuntimeException {
} }
/** /**
* Creates a new {@code NotImplementedException} with the specified error * Creates a new {@code NotImplementedException} with the specified error message, cause, suppression flag, and
* message, cause, suppression flag, and stack trace writable flag. * stack trace writable flag.
* *
* @param message the error message associated with this * @param message the error message associated with this
* exception * exception