doc: added missing javadocs

This commit is contained in:
zaaarf 2023-03-04 15:18:21 +01:00
parent 8983a271f8
commit a3b33e66e8
No known key found for this signature in database
GPG key ID: AD8563472FD43386
4 changed files with 50 additions and 2 deletions

View file

@ -4,15 +4,30 @@ package ftbsc.lll.exceptions;
* Thrown when the injection of a patch fails. * Thrown when the injection of a patch fails.
*/ */
public class InjectionException extends RuntimeException { public class InjectionException extends RuntimeException {
/**
* Constructs a new injection exception with the specified detail message.
* @param message the detail message
*/
public InjectionException(String message) { public InjectionException(String message) {
super(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) { public InjectionException(String message, Throwable cause) {
super(message, 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) { public InjectionException(Throwable cause) {
super(cause); super(cause);
} }
} }

View file

@ -1,18 +1,34 @@
package ftbsc.lll.exceptions; 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. * unconnected nodes.
*/ */
public class InstructionMismatchException extends RuntimeException { 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) { public InstructionMismatchException(String message) {
super(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) { public InstructionMismatchException(String message, Throwable cause) {
super(message, 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) { public InstructionMismatchException(Throwable cause) {
super(cause); super(cause);
} }

View file

@ -4,14 +4,28 @@ package ftbsc.lll.exceptions;
* Thrown when failing to find a pattern. * Thrown when failing to find a pattern.
*/ */
public class PatternNotFoundException extends RuntimeException { 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) { public PatternNotFoundException(String message) {
super(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) { public PatternNotFoundException(String message, Throwable cause) {
super(message, 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) { public PatternNotFoundException(Throwable cause) {
super(cause); super(cause);
} }

View file

@ -56,6 +56,9 @@ public class FieldProxy extends AbstractProxy {
return new Builder(name); return new Builder(name);
} }
/**
* A builder object for {@link FieldProxy}.
*/
public static class Builder extends AbstractProxy.Builder<FieldProxy> { public static class Builder extends AbstractProxy.Builder<FieldProxy> {
/** /**
* The descriptor of the field's type. * The descriptor of the field's type.