From a3b33e66e8f3fef28058281fa5607118e04e7614 Mon Sep 17 00:00:00 2001 From: zaaarf Date: Sat, 4 Mar 2023 15:18:21 +0100 Subject: doc: added missing javadocs --- .../java/ftbsc/lll/exceptions/InjectionException.java | 17 ++++++++++++++++- .../lll/exceptions/InstructionMismatchException.java | 18 +++++++++++++++++- .../ftbsc/lll/exceptions/PatternNotFoundException.java | 14 ++++++++++++++ src/main/java/ftbsc/lll/proxies/FieldProxy.java | 3 +++ 4 files changed, 50 insertions(+), 2 deletions(-) diff --git a/src/main/java/ftbsc/lll/exceptions/InjectionException.java b/src/main/java/ftbsc/lll/exceptions/InjectionException.java index d8809dd..3695a92 100644 --- a/src/main/java/ftbsc/lll/exceptions/InjectionException.java +++ b/src/main/java/ftbsc/lll/exceptions/InjectionException.java @@ -4,15 +4,30 @@ package ftbsc.lll.exceptions; * Thrown when the injection of a patch fails. */ public class InjectionException extends RuntimeException { + + /** + * Constructs a new injection exception with the specified detail message. + * @param message the detail message + */ public InjectionException(String message) { super(message); } + /** + * Constructs a new injection exception with the specified detail message and cause. + * @param message the detail message + * @param cause the cause, may be null (indicating nonexistent or unknown cause) + */ public InjectionException(String message, Throwable cause) { super(message, cause); } + /** + * Constructs a new injection exception with the specified cause and a + * detail message of {@code (cause==null ? null : cause.toString())} + * @param cause the cause, may be null (indicating nonexistent or unknown cause) + */ public InjectionException(Throwable cause) { super(cause); } -} \ No newline at end of file +} diff --git a/src/main/java/ftbsc/lll/exceptions/InstructionMismatchException.java b/src/main/java/ftbsc/lll/exceptions/InstructionMismatchException.java index b9e0d05..33c4b35 100644 --- a/src/main/java/ftbsc/lll/exceptions/InstructionMismatchException.java +++ b/src/main/java/ftbsc/lll/exceptions/InstructionMismatchException.java @@ -1,18 +1,34 @@ package ftbsc.lll.exceptions; +import ftbsc.lll.tools.InsnSequence; + /** - * Thrown when attempting to build an {@link ftbsc.lll.tools.InsnSequence} between two + * Thrown when attempting to build an {@link InsnSequence} between two * unconnected nodes. */ public class InstructionMismatchException extends RuntimeException { + /** + * Constructs a new instruction mismatch exception with the specified detail message. + * @param message the detail message + */ public InstructionMismatchException(String message) { super(message); } + /** + * Constructs a new instruction mismatch exception with the specified detail message and cause. + * @param message the detail message + * @param cause the cause, may be null (indicating nonexistent or unknown cause) + */ public InstructionMismatchException(String message, Throwable cause) { super(message, cause); } + /** + * Constructs a new instruction mismatch exception with the specified cause and a + * detail message of {@code (cause==null ? null : cause.toString())} + * @param cause the cause, may be null (indicating nonexistent or unknown cause) + */ public InstructionMismatchException(Throwable cause) { super(cause); } diff --git a/src/main/java/ftbsc/lll/exceptions/PatternNotFoundException.java b/src/main/java/ftbsc/lll/exceptions/PatternNotFoundException.java index d84fefd..2d50623 100644 --- a/src/main/java/ftbsc/lll/exceptions/PatternNotFoundException.java +++ b/src/main/java/ftbsc/lll/exceptions/PatternNotFoundException.java @@ -4,14 +4,28 @@ package ftbsc.lll.exceptions; * Thrown when failing to find a pattern. */ public class PatternNotFoundException extends RuntimeException { + /** + * Constructs a new pattern not found exception with the specified detail message. + * @param message the detail message + */ public PatternNotFoundException(String message) { super(message); } + /** + * Constructs a new pattern not found exception with the specified detail message and cause. + * @param message the detail message + * @param cause the cause, may be null (indicating nonexistent or unknown cause) + */ public PatternNotFoundException(String message, Throwable cause) { super(message, cause); } + /** + * Constructs a new pattern not found exception with the specified cause and a + * detail message of {@code (cause==null ? null : cause.toString())} + * @param cause the cause, may be null (indicating nonexistent or unknown cause) + */ public PatternNotFoundException(Throwable cause) { super(cause); } diff --git a/src/main/java/ftbsc/lll/proxies/FieldProxy.java b/src/main/java/ftbsc/lll/proxies/FieldProxy.java index af6f8df..0edd735 100644 --- a/src/main/java/ftbsc/lll/proxies/FieldProxy.java +++ b/src/main/java/ftbsc/lll/proxies/FieldProxy.java @@ -56,6 +56,9 @@ public class FieldProxy extends AbstractProxy { return new Builder(name); } + /** + * A builder object for {@link FieldProxy}. + */ public static class Builder extends AbstractProxy.Builder { /** * The descriptor of the field's type. -- cgit v1.2.3-56-ga3b1