This is an automated email from the ASF dual-hosted git repository.
paulk-asert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git
The following commit(s) were added to refs/heads/master by this push:
new 1dd93872b2 GROOVY-12032: Provide a DGM clamp method
1dd93872b2 is described below
commit 1dd93872b2b328d25e4f60b7fbfe1b45f6d7ac7c
Author: Paul King <[email protected]>
AuthorDate: Sat May 23 00:02:12 2026 +1000
GROOVY-12032: Provide a DGM clamp method
---
.../groovy/runtime/DefaultGroovyMethods.java | 50 ++++++++++++++++++++++
1 file changed, 50 insertions(+)
diff --git
a/src/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
b/src/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
index 78db239c5f..f5a6093490 100644
--- a/src/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
+++ b/src/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
@@ -2022,6 +2022,56 @@ public class DefaultGroovyMethods extends
DefaultGroovyMethodsSupport {
}
}
+
//--------------------------------------------------------------------------
+ // clamp
+
+ /**
+ * Constrains a Comparable value to lie within the inclusive range
+ * <code>[lower, upper]</code>. Returns <code>lower</code> if
<code>self</code>
+ * is less than <code>lower</code>, <code>upper</code> if
<code>self</code> is
+ * greater than <code>upper</code>, otherwise <code>self</code>.
+ * <pre class="language-groovy groovyTestCase">
+ * assert 10.clamp(1, 15) == 10
+ * assert 10.clamp(1, 5) == 5
+ * assert 10.clamp(12, 20) == 12
+ * assert 'a'.clamp('b', 'z') == 'b'
+ * </pre>
+ *
+ * @param self a Comparable value
+ * @param lower the inclusive lower bound
+ * @param upper the inclusive upper bound
+ * @return the clamped value
+ * @throws IllegalArgumentException if <code>lower</code> is greater than
<code>upper</code>
+ * @since 6.0.0
+ */
+ public static <T extends Comparable<? super T>> T clamp(T self, T lower, T
upper) {
+ if (ScriptBytecodeAdapter.compareGreaterThan(lower, upper)) {
+ throw new IllegalArgumentException("lower bound (" + lower + ")
must not be greater than upper bound (" + upper + ")");
+ }
+ if (ScriptBytecodeAdapter.compareLessThan(self, lower)) return lower;
+ if (ScriptBytecodeAdapter.compareGreaterThan(self, upper)) return
upper;
+ return self;
+ }
+
+ /**
+ * Constrains a Comparable value to lie within the given Range.
+ * <pre class="language-groovy groovyTestCase">
+ * assert 10.clamp(12..20) == 12
+ * assert 10.clamp(1..5) == 5
+ * </pre>
+ *
+ * @param self a Comparable value
+ * @param range a Range defining the inclusive bounds
+ * @return the clamped value
+ * @since 6.0.0
+ */
+ @SuppressWarnings("unchecked")
+ public static <T extends Comparable<? super T>> T clamp(T self, Range<T>
range) {
+ T lower = range.isReverse() ? (T) range.getTo() : (T) range.getFrom();
+ T upper = range.isReverse() ? (T) range.getFrom() : (T) range.getTo();
+ return clamp(self, lower, upper);
+ }
+
//--------------------------------------------------------------------------
// collate
