This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/master by this push:
new 1d117afe38 Clarify Shorts.java class Javadoc re: exception-factory
exception
1d117afe38 is described below
commit 1d117afe381a998d7b17077949e753a9876cd218
Author: James Bognar <[email protected]>
AuthorDate: Sun Jul 12 21:43:28 2026 -0400
Clarify Shorts.java class Javadoc re: exception-factory exception
Document that the terse exception factories (rex/brex/iaex/isex/uoex/
uoroex/ioex/exex) are self-contained rather than pure delegations to a
domain class, and are the only methods in the class with no @see tag.
This keeps the disjointness-invariant explanation accurate as part of
the TODO-222 Shorts Phase 8 documentation pass.
Co-authored-by: Cursor <[email protected]>
---
.../java/org/apache/juneau/commons/utils/Shorts.java | 20 +++++++++++++-------
1 file changed, 13 insertions(+), 7 deletions(-)
diff --git
a/juneau-core/juneau-commons/src/main/java/org/apache/juneau/commons/utils/Shorts.java
b/juneau-core/juneau-commons/src/main/java/org/apache/juneau/commons/utils/Shorts.java
index 269cd7908d..65d8bdb965 100644
---
a/juneau-core/juneau-commons/src/main/java/org/apache/juneau/commons/utils/Shorts.java
+++
b/juneau-core/juneau-commons/src/main/java/org/apache/juneau/commons/utils/Shorts.java
@@ -30,15 +30,21 @@ import org.apache.juneau.commons.reflect.*;
*
* <p>A single wildcard static import
* ({@code import static org.apache.juneau.commons.utils.Shorts.*;}) exposes
the entire
- * short-name vocabulary. Every method here is a one-line delegation to a
canonical,
- * fully-descriptive method on a domain class — {@code Shorts} holds no logic
of its own, so
- * behavior is identical to calling the canonical method directly. Each alias
documents its
- * target via an {@code @see} tag. Canonical implementations live in {@link
ObjectUtils},
- * {@link StringUtils}, {@link CollectionUtils}, {@link ClassUtils}, {@link
ThrowableUtils},
- * {@link IoUtils}, {@link FileUtils}, {@link AssertionUtils}, {@link
PredicateUtils},
- * {@link SystemUtils}, {@link DateUtils}, and
+ * short-name vocabulary. Almost every method here is a one-line delegation to
a canonical,
+ * fully-descriptive method on a domain class — behavior is identical to
calling the canonical
+ * method directly — and each such alias documents its target via an {@code
@see} tag. Canonical
+ * implementations live in {@link ObjectUtils}, {@link StringUtils}, {@link
CollectionUtils},
+ * {@link ClassUtils}, {@link ThrowableUtils}, {@link IoUtils}, {@link
FileUtils},
+ * {@link AssertionUtils}, {@link PredicateUtils}, {@link SystemUtils}, {@link
DateUtils}, and
* {@link org.apache.juneau.commons.reflect.ReflectionUtils}.
*
+ * <p><b>Documented exception:</b> the terse exception factories ({@code
rex}/{@code brex}/
+ * {@code iaex}/{@code isex}/{@code uoex}/{@code uoroex}/{@code ioex}/{@code
exex}) are
+ * self-contained — they construct the exception directly rather than
delegating to a domain
+ * class — so that the domain {@code *Utils} classes can stay {@code
Shorts}-free (they use the
+ * package-private {@code Exceptions} helper instead). These are the only
methods in this class
+ * with no {@code @see} tag.
+ *
* <p><b>Disjointness invariant:</b> no {@code Shorts} alias name is identical
to the canonical
* (full) method name of any method in any domain class. This lets a developer
wildcard-import
* {@code Shorts.*} alongside any single domain {@code *Utils.*} with zero
method-name
