Index (kernel 0.1.0 API)

B

BaseAppException - Exception Class in io.github.p4suta.shared.kernel.error: The abstract base each app's domain exception extends: an unchecked exception tagging every failure with an ErrorCategory kind plus an optional technical detail.
BaseAppException(ErrorCategory, String, Throwable) - Constructor for exception class io.github.p4suta.shared.kernel.error.BaseAppException
buildMessage(ErrorCategory, String) - Static method in exception class io.github.p4suta.shared.kernel.error.BaseAppException: Builds the developer/log throwable message [NAME] detail subclasses pass to super; the detail is omitted when absent.

CommonErrorKind - Enum Class in io.github.p4suta.shared.kernel.error: The generic failure categories, each carrying its sysexits exit code, Severity, and client-fault flag on the constant.

dpi() - Method in record class io.github.p4suta.shared.kernel.Resolution: Returns the value of the dpi record component.

equals(Object) - Method in record class io.github.p4suta.shared.kernel.Resolution: Indicates whether some other object is "equal to" this one.
ERROR - Enum constant in enum class io.github.p4suta.shared.kernel.error.Severity: An internal/environmental failure: logged at ERROR.
ErrorCategory - Interface in io.github.p4suta.shared.kernel.error: The contract a failure category implements: a stable name, a client-fault flag, a sysexits-flavored process exit code, and a Severity.
exitCode() - Method in enum class io.github.p4suta.shared.kernel.error.CommonErrorKind
exitCode() - Method in interface io.github.p4suta.shared.kernel.error.ErrorCategory: Returns the sysexits-flavored process exit code for this category.

hashCode() - Method in record class io.github.p4suta.shared.kernel.Resolution: Returns a hash code value for this object.

INFO - Enum constant in enum class io.github.p4suta.shared.kernel.error.Severity: Informational; reserved, no current ErrorCategory uses it.
INTERNAL - Enum constant in enum class io.github.p4suta.shared.kernel.error.CommonErrorKind: An unexpected internal failure.
INVALID_PARAMETER - Enum constant in enum class io.github.p4suta.shared.kernel.error.CommonErrorKind: Bad CLI value or violated precondition.
io.github.p4suta.shared.kernel - package io.github.p4suta.shared.kernel: The framework-free shared kernel: dpi-based pixel/millimeter conversion (Resolution) and exception-neutral precondition checks (Validators).
io.github.p4suta.shared.kernel.error - package io.github.p4suta.shared.kernel.error: The dependency-free error model.
isClientFault() - Method in enum class io.github.p4suta.shared.kernel.error.CommonErrorKind
isClientFault() - Method in interface io.github.p4suta.shared.kernel.error.ErrorCategory: Returns whether this failure is the caller's fault (bad input/usage) rather than internal/environmental.

kind() - Method in exception class io.github.p4suta.shared.kernel.error.BaseAppException: Returns the failure category.

Medians - Class in io.github.p4suta.shared.kernel: Upper-median selection over a primitive array: the element at sorted index n / 2, which for an even count is the upper of the two middle elements (not the averaging "true" median).
mmFromPx(int) - Method in record class io.github.p4suta.shared.kernel.Resolution: Millimeters in px pixels: px * 25.4 / dpi, the inverse of Resolution.pxFromMm(double).

name() - Method in interface io.github.p4suta.shared.kernel.error.ErrorCategory: Returns the stable identifier of this category (the enum constant name); appears in Error[NAME]: ....
NO_OP - Static variable in interface io.github.p4suta.shared.kernel.PageProgressListener: Ignores every callback — the default when no progress is requested.

of(int) - Static method in record class io.github.p4suta.shared.kernel.Resolution
onPage(int, int) - Method in interface io.github.p4suta.shared.kernel.PageProgressListener: Reports that one more unit has finished.
OUT_OF_MEMORY - Enum constant in enum class io.github.p4suta.shared.kernel.error.CommonErrorKind: The JVM ran out of heap.
OUTPUT_CONFLICT - Enum constant in enum class io.github.p4suta.shared.kernel.error.CommonErrorKind: The output path already exists and --force was not given.

PageProgressListener - Interface in io.github.p4suta.shared.kernel: A framework-free per-item progress callback: a corpus-processing service invokes PageProgressListener.onPage(int, int) once per page (or spread) as it completes.
pxFromInch(double) - Method in record class io.github.p4suta.shared.kernel.Resolution: Pixels in inches inches, rounded half-up: Math.round(inches * dpi).
pxFromMm(double) - Method in record class io.github.p4suta.shared.kernel.Resolution: Pixels in mm millimeters, rounded half-up: Math.round(mm * dpi / 25.4).

requireNonNegative(int, String) - Static method in class io.github.p4suta.shared.kernel.Validators: Requires value >= 0.
requireNonNull(T, String) - Static method in class io.github.p4suta.shared.kernel.Validators: Requires value to be non-null.
requirePositive(double, String) - Static method in class io.github.p4suta.shared.kernel.Validators: Requires value > 0; the !(value > 0) test also rejects NaN.
requirePositive(int, String) - Static method in class io.github.p4suta.shared.kernel.Validators: Requires value > 0.
Resolution - Record Class in io.github.p4suta.shared.kernel: A scan resolution: a positive dpi (dots per inch) that converts between physical millimeters/inches and pixels.
Resolution(int) - Constructor for record class io.github.p4suta.shared.kernel.Resolution: Creates an instance of a Resolution record class.

severity() - Method in enum class io.github.p4suta.shared.kernel.error.CommonErrorKind
severity() - Method in interface io.github.p4suta.shared.kernel.error.ErrorCategory: Returns the log severity for this category.
Severity - Enum Class in io.github.p4suta.shared.kernel.error: The log severity an ErrorCategory carries, independent of any logging framework.

technicalDetail() - Method in exception class io.github.p4suta.shared.kernel.error.BaseAppException: Returns the optional diagnostic detail, or null if none.
toString() - Method in record class io.github.p4suta.shared.kernel.Resolution: Returns a string representation of this record class.

upperMedian(int[]) - Static method in class io.github.p4suta.shared.kernel.Medians: Upper median of values; assumed non-empty.
upperMedian(long[]) - Static method in class io.github.p4suta.shared.kernel.Medians: Upper median of values; assumed non-empty.

Validators - Class in io.github.p4suta.shared.kernel: Exception-neutral precondition checks.
valueOf(String) - Static method in enum class io.github.p4suta.shared.kernel.error.CommonErrorKind: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.p4suta.shared.kernel.error.Severity: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.p4suta.shared.kernel.error.CommonErrorKind: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.p4suta.shared.kernel.error.Severity: Returns an array containing the constants of this enum class, in the order they are declared.

WARN - Enum constant in enum class io.github.p4suta.shared.kernel.error.Severity: A client-fault failure (bad input/usage): logged at WARN, not alarming.