diff --git a/Android.bp b/Android.bp
index 7c9cdcfb98264647b4ac939f4bb1bc842dc67815..381e0466efbd3f8be39a8c4a6322321a8086e11b 100644
--- a/Android.bp
+++ b/Android.bp
@@ -326,6 +326,7 @@ java_defaults {
"av-types-aidl-java",
"tv_tuner_resource_manager_aidl_interface-java",
"soundtrigger_middleware-aidl-java",
+ "modules-utils-preconditions",
"modules-utils-os",
"framework-permission-aidl-java",
],
@@ -409,6 +410,7 @@ filegroup {
srcs: [
// TODO: remove these annotations as soon as we can use andoid.support.annotations.*
":framework-annotations",
+ ":modules-utils-preconditions-srcs",
"core/java/android/net/DhcpResults.java",
"core/java/android/util/IndentingPrintWriter.java",
"core/java/android/util/LocalLog.java",
@@ -416,7 +418,6 @@ filegroup {
"core/java/com/android/internal/util/IndentingPrintWriter.java",
"core/java/com/android/internal/util/IState.java",
"core/java/com/android/internal/util/MessageUtils.java",
- "core/java/com/android/internal/util/Preconditions.java",
"core/java/com/android/internal/util/RingBufferIndices.java",
"core/java/com/android/internal/util/State.java",
"core/java/com/android/internal/util/StateMachine.java",
@@ -446,11 +447,11 @@ java_library {
sdk_version: "module_current",
min_sdk_version: "30",
srcs: [
+ ":modules-utils-preconditions-srcs",
"core/java/android/os/HandlerExecutor.java",
"core/java/com/android/internal/util/AsyncChannel.java",
"core/java/com/android/internal/util/AsyncService.java",
"core/java/com/android/internal/util/Protocol.java",
- "core/java/com/android/internal/util/Preconditions.java",
"telephony/java/android/telephony/Annotation.java",
":net-utils-framework-wifi-common-srcs",
],
diff --git a/apex/appsearch/framework/Android.bp b/apex/appsearch/framework/Android.bp
index f92f44bc853f400fe4a94021f501e274ca4252d9..b8fce4f10cd0bc02b8bf59585a20f81e1cad9827 100644
--- a/apex/appsearch/framework/Android.bp
+++ b/apex/appsearch/framework/Android.bp
@@ -52,14 +52,18 @@ filegroup {
java_sdk_library {
name: "framework-appsearch",
srcs: [":framework-appsearch-sources"],
- sdk_version: "core_platform", // TODO(b/146218515) should be module_current
- impl_only_libs: ["framework-minus-apex"], // TODO(b/146218515) should be removed
+ sdk_version: "module_current",
+ static_libs: [
+ // This list must be kept in sync with jarjar.txt
+ "modules-utils-preconditions",
+ ],
libs: ["unsupportedappusage"], // TODO(b/181887768) should be removed
defaults: ["framework-module-defaults"],
permitted_packages: ["android.app.appsearch"],
aidl: {
include_dirs: ["frameworks/base/core/java"], // TODO(b/146218515) should be removed
},
+ jarjar_rules: "jarjar-rules.txt",
apex_available: ["com.android.appsearch"],
unsafe_ignore_missing_latest_api: true, // TODO(b/146218515) should be removed
}
diff --git a/apex/appsearch/framework/jarjar-rules.txt b/apex/appsearch/framework/jarjar-rules.txt
new file mode 100644
index 0000000000000000000000000000000000000000..50c3ee4125a8a595397fbf816f9b20867e794dd1
--- /dev/null
+++ b/apex/appsearch/framework/jarjar-rules.txt
@@ -0,0 +1,6 @@
+# Rename all com.android.internal.util classes to prevent class name collisions
+# between this module and the other versions of the utility classes linked into
+# the framework.
+
+# These must be kept in sync with the sources of framework-utils-appsearch
+rule com.android.internal.util.Preconditions* android.app.appsearch.internal.util.Preconditions@1
diff --git a/apex/appsearch/framework/java/android/app/appsearch/AppSearchManager.java b/apex/appsearch/framework/java/android/app/appsearch/AppSearchManager.java
index bc3c79fea9e4dc7982fdaccd0a180d97044f4edf..59b940a460d38b1a5ab3aec1fb7838ef266032dd 100644
--- a/apex/appsearch/framework/java/android/app/appsearch/AppSearchManager.java
+++ b/apex/appsearch/framework/java/android/app/appsearch/AppSearchManager.java
@@ -205,7 +205,7 @@ public class AppSearchManager {
AppSearchSession.createSearchSession(
searchContext,
mService,
- mContext.getUserId(),
+ mContext.getUser().getIdentifier(),
getPackageName(),
executor,
callback);
@@ -228,7 +228,7 @@ public class AppSearchManager {
Objects.requireNonNull(executor);
Objects.requireNonNull(callback);
GlobalSearchSession.createGlobalSearchSession(
- mService, mContext.getUserId(), getPackageName(), executor, callback);
+ mService, mContext.getUser().getIdentifier(), getPackageName(), executor, callback);
}
/** Returns the package name that should be used for uid verification. */
diff --git a/core/java/Android.bp b/core/java/Android.bp
index 793d0ef164fa5680c3ae6c864daae6b011da4891..6c001f305ce778c918db7c7396ce57c10b3b6eda 100644
--- a/core/java/Android.bp
+++ b/core/java/Android.bp
@@ -169,6 +169,7 @@ filegroup {
filegroup {
name: "framework-jobscheduler-shared-srcs",
srcs: [
+ ":modules-utils-preconditions-srcs",
"com/android/internal/util/ArrayUtils.java",
"com/android/internal/util/BitUtils.java",
"com/android/internal/util/CollectionUtils.java",
@@ -178,7 +179,6 @@ filegroup {
"com/android/internal/util/FastXmlSerializer.java",
"com/android/internal/util/FunctionalUtils.java",
"com/android/internal/util/ParseUtils.java",
- "com/android/internal/util/Preconditions.java",
"com/android/internal/util/RingBufferIndices.java",
"com/android/internal/util/StatLogger.java",
"com/android/internal/util/XmlUtils.java",
@@ -189,9 +189,9 @@ filegroup {
filegroup {
name: "framework-permission-s-shared-srcs",
srcs: [
+ ":modules-utils-preconditions-srcs",
"com/android/internal/infra/AndroidFuture.java",
"com/android/internal/infra/ServiceConnector.java",
- "com/android/internal/util/Preconditions.java",
"com/android/internal/infra/AndroidFuture.aidl",
"com/android/internal/infra/IAndroidFuture.aidl",
"android/os/HandlerExecutor.java",
@@ -323,6 +323,7 @@ aidl_interface {
filegroup {
name: "framework-telephony-common-shared-srcs",
srcs: [
+ ":modules-utils-preconditions-srcs",
"android/os/RegistrantList.java",
"android/os/Registrant.java",
"android/util/IndentingPrintWriter.java",
@@ -336,7 +337,6 @@ filegroup {
"com/android/internal/util/HexDump.java",
"com/android/internal/util/IState.java",
"com/android/internal/util/IndentingPrintWriter.java",
- "com/android/internal/util/Preconditions.java",
"com/android/internal/util/State.java",
"com/android/internal/util/StateMachine.java",
"com/android/internal/util/UserIcons.java",
@@ -348,10 +348,10 @@ filegroup {
filegroup {
name: "framework-cellbroadcast-shared-srcs",
srcs: [
+ ":modules-utils-preconditions-srcs",
"android/os/HandlerExecutor.java",
"android/util/LocalLog.java",
"com/android/internal/util/IState.java",
- "com/android/internal/util/Preconditions.java",
"com/android/internal/util/State.java",
"com/android/internal/util/StateMachine.java",
],
@@ -360,10 +360,10 @@ filegroup {
filegroup {
name: "framework-ims-common-shared-srcs",
srcs: [
+ ":modules-utils-preconditions-srcs",
"android/os/RegistrantList.java",
"android/os/Registrant.java",
"com/android/internal/os/SomeArgs.java",
- "com/android/internal/util/Preconditions.java",
],
}
diff --git a/core/java/com/android/internal/util/Preconditions.java b/core/java/com/android/internal/util/Preconditions.java
deleted file mode 100644
index d2d822083a95eabb476640101f49a47853d0653b..0000000000000000000000000000000000000000
--- a/core/java/com/android/internal/util/Preconditions.java
+++ /dev/null
@@ -1,771 +0,0 @@
-/*
- * Copyright (C) 2011 The Android Open Source Project
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.android.internal.util;
-
-import android.annotation.IntRange;
-import android.annotation.NonNull;
-import android.compat.annotation.UnsupportedAppUsage;
-import android.os.Build;
-import android.text.TextUtils;
-
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Objects;
-
-/**
- * Simple static methods to be called at the start of your own methods to verify
- * correct arguments and state.
- */
-public class Preconditions {
-
- /**
- * Ensures that an expression checking an argument is true.
- *
- * @param expression the expression to check
- * @throws IllegalArgumentException if {@code expression} is false
- */
- @UnsupportedAppUsage
- public static void checkArgument(boolean expression) {
- if (!expression) {
- throw new IllegalArgumentException();
- }
- }
-
- /**
- * Ensures that an expression checking an argument is true.
- *
- * @param expression the expression to check
- * @param errorMessage the exception message to use if the check fails; will
- * be converted to a string using {@link String#valueOf(Object)}
- * @throws IllegalArgumentException if {@code expression} is false
- */
- @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
- public static void checkArgument(boolean expression, final Object errorMessage) {
- if (!expression) {
- throw new IllegalArgumentException(String.valueOf(errorMessage));
- }
- }
-
- /**
- * Ensures that an expression checking an argument is true.
- *
- * @param expression the expression to check
- * @param messageTemplate a printf-style message template to use if the check fails; will
- * be converted to a string using {@link String#format(String, Object...)}
- * @param messageArgs arguments for {@code messageTemplate}
- * @throws IllegalArgumentException if {@code expression} is false
- */
- public static void checkArgument(
- final boolean expression,
- final @NonNull String messageTemplate,
- final Object... messageArgs) {
- if (!expression) {
- throw new IllegalArgumentException(String.format(messageTemplate, messageArgs));
- }
- }
-
- /**
- * Ensures that an string reference passed as a parameter to the calling
- * method is not empty.
- *
- * @param string an string reference
- * @return the string reference that was validated
- * @throws IllegalArgumentException if {@code string} is empty
- */
- public static @NonNull <T extends CharSequence> T checkStringNotEmpty(final T string) {
- if (TextUtils.isEmpty(string)) {
- throw new IllegalArgumentException();
- }
- return string;
- }
-
- /**
- * Ensures that an string reference passed as a parameter to the calling
- * method is not empty.
- *
- * @param string an string reference
- * @param errorMessage the exception message to use if the check fails; will
- * be converted to a string using {@link String#valueOf(Object)}
- * @return the string reference that was validated
- * @throws IllegalArgumentException if {@code string} is empty
- */
- public static @NonNull <T extends CharSequence> T checkStringNotEmpty(final T string,
- final Object errorMessage) {
- if (TextUtils.isEmpty(string)) {
- throw new IllegalArgumentException(String.valueOf(errorMessage));
- }
- return string;
- }
-
- /**
- * Ensures that an string reference passed as a parameter to the calling method is not empty.
- *
- * @param string an string reference
- * @param messageTemplate a printf-style message template to use if the check fails; will be
- * converted to a string using {@link String#format(String, Object...)}
- * @param messageArgs arguments for {@code messageTemplate}
- * @return the string reference that was validated
- * @throws IllegalArgumentException if {@code string} is empty
- */
- public static @NonNull <T extends CharSequence> T checkStringNotEmpty(
- final T string,
- final @NonNull String messageTemplate,
- final Object... messageArgs) {
- if (TextUtils.isEmpty(string)) {
- throw new IllegalArgumentException(String.format(messageTemplate, messageArgs));
- }
- return string;
- }
-
- /**
- * Ensures that an object reference passed as a parameter to the calling
- * method is not null.
- *
- * @param reference an object reference
- * @return the non-null reference that was validated
- * @throws NullPointerException if {@code reference} is null
- * @deprecated - use {@link java.util.Objects.requireNonNull} instead.
- */
- @Deprecated
- @UnsupportedAppUsage
- public static @NonNull <T> T checkNotNull(final T reference) {
- if (reference == null) {
- throw new NullPointerException();
- }
- return reference;
- }
-
- /**
- * Ensures that an object reference passed as a parameter to the calling
- * method is not null.
- *
- * @param reference an object reference
- * @param errorMessage the exception message to use if the check fails; will
- * be converted to a string using {@link String#valueOf(Object)}
- * @return the non-null reference that was validated
- * @throws NullPointerException if {@code reference} is null
- * @deprecated - use {@link java.util.Objects#requireNonNull} instead.
- */
- @Deprecated
- @UnsupportedAppUsage
- public static @NonNull <T> T checkNotNull(final T reference, final Object errorMessage) {
- if (reference == null) {
- throw new NullPointerException(String.valueOf(errorMessage));
- }
- return reference;
- }
-
- /**
- * Ensures that an object reference passed as a parameter to the calling
- * method is not null.
- *
- * @param messageTemplate a printf-style message template to use if the check fails; will
- * be converted to a string using {@link String#format(String, Object...)}
- * @param messageArgs arguments for {@code messageTemplate}
- * @throws NullPointerException if {@code reference} is null
- */
- public static @NonNull <T> T checkNotNull(
- final T reference,
- final @NonNull String messageTemplate,
- final Object... messageArgs) {
- if (reference == null) {
- throw new NullPointerException(String.format(messageTemplate, messageArgs));
- }
- return reference;
- }
-
- /**
- * Ensures the truth of an expression involving the state of the calling
- * instance, but not involving any parameters to the calling method.
- *
- * @param expression a boolean expression
- * @throws IllegalStateException if {@code expression} is false
- */
- @UnsupportedAppUsage
- public static void checkState(final boolean expression) {
- checkState(expression, null);
- }
-
- /**
- * Ensures the truth of an expression involving the state of the calling
- * instance, but not involving any parameters to the calling method.
- *
- * @param expression a boolean expression
- * @param errorMessage the exception message to use if the check fails; will
- * be converted to a string using {@link String#valueOf(Object)}
- * @throws IllegalStateException if {@code expression} is false
- */
- @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
- public static void checkState(final boolean expression, String errorMessage) {
- if (!expression) {
- throw new IllegalStateException(errorMessage);
- }
- }
-
- /**
- * Ensures the truth of an expression involving the state of the calling
- * instance, but not involving any parameters to the calling method.
- *
- * @param expression a boolean expression
- * @param messageTemplate a printf-style message template to use if the check fails; will
- * be converted to a string using {@link String#format(String, Object...)}
- * @param messageArgs arguments for {@code messageTemplate}
- * @throws IllegalStateException if {@code expression} is false
- */
- public static void checkState(
- final boolean expression,
- final @NonNull String messageTemplate,
- final Object... messageArgs) {
- if (!expression) {
- throw new IllegalStateException(String.format(messageTemplate, messageArgs));
- }
- }
-
- /**
- * Ensures the truth of an expression involving whether the calling identity is authorized to
- * call the calling method.
- *
- * @param expression a boolean expression
- * @throws SecurityException if {@code expression} is false
- */
- public static void checkCallAuthorization(final boolean expression) {
- if (!expression) {
- throw new SecurityException("Calling identity is not authorized");
- }
- }
-
- /**
- * Ensures the truth of an expression involving whether the calling identity is authorized to
- * call the calling method.
- *
- * @param expression a boolean expression
- * @param message the message of the security exception to be thrown
- * @throws SecurityException if {@code expression} is false
- */
- public static void checkCallAuthorization(final boolean expression, final String message) {
- if (!expression) {
- throw new SecurityException(message);
- }
- }
-
- /**
- * Ensures the truth of an expression involving whether the calling identity is authorized to
- * call the calling method.
- *
- * @param expression a boolean expression
- * @param messageTemplate a printf-style message template to use if the check fails; will
- * be converted to a string using {@link String#format(String, Object...)}
- * @param messageArgs arguments for {@code messageTemplate}
- * @throws SecurityException if {@code expression} is false
- */
- public static void checkCallAuthorization(
- final boolean expression,
- final @NonNull String messageTemplate,
- final Object... messageArgs) {
- if (!expression) {
- throw new SecurityException(String.format(messageTemplate, messageArgs));
- }
- }
-
- /**
- * Ensures the truth of an expression involving whether the calling user is authorized to
- * call the calling method.
- *
- * @param expression a boolean expression
- * @throws SecurityException if {@code expression} is false
- */
- public static void checkCallingUser(final boolean expression) {
- if (!expression) {
- throw new SecurityException("Calling user is not authorized");
- }
- }
-
- /**
- * Check the requested flags, throwing if any requested flags are outside
- * the allowed set.
- *
- * @return the validated requested flags.
- */
- public static int checkFlagsArgument(final int requestedFlags, final int allowedFlags) {
- if ((requestedFlags & allowedFlags) != requestedFlags) {
- throw new IllegalArgumentException("Requested flags 0x"
- + Integer.toHexString(requestedFlags) + ", but only 0x"
- + Integer.toHexString(allowedFlags) + " are allowed");
- }
-
- return requestedFlags;
- }
-
- /**
- * Ensures that that the argument numeric value is non-negative (greater than or equal to 0).
- *
- * @param value a numeric int value
- * @param errorMessage the exception message to use if the check fails
- * @return the validated numeric value
- * @throws IllegalArgumentException if {@code value} was negative
- */
- public static @IntRange(from = 0) int checkArgumentNonnegative(final int value,
- final String errorMessage) {
- if (value < 0) {
- throw new IllegalArgumentException(errorMessage);
- }
-
- return value;
- }
-
- /**
- * Ensures that that the argument numeric value is non-negative (greater than or equal to 0).
- *
- * @param value a numeric int value
- *
- * @return the validated numeric value
- * @throws IllegalArgumentException if {@code value} was negative
- */
- public static @IntRange(from = 0) int checkArgumentNonnegative(final int value) {
- if (value < 0) {
- throw new IllegalArgumentException();
- }
-
- return value;
- }
-
- /**
- * Ensures that that the argument numeric value is non-negative (greater than or equal to 0).
- *
- * @param value a numeric long value
- * @return the validated numeric value
- * @throws IllegalArgumentException if {@code value} was negative
- */
- public static long checkArgumentNonnegative(final long value) {
- if (value < 0) {
- throw new IllegalArgumentException();
- }
-
- return value;
- }
-
- /**
- * Ensures that that the argument numeric value is non-negative (greater than or equal to 0).
- *
- * @param value a numeric long value
- * @param errorMessage the exception message to use if the check fails
- * @return the validated numeric value
- * @throws IllegalArgumentException if {@code value} was negative
- */
- public static long checkArgumentNonnegative(final long value, final String errorMessage) {
- if (value < 0) {
- throw new IllegalArgumentException(errorMessage);
- }
-
- return value;
- }
-
- /**
- * Ensures that that the argument numeric value is positive (greater than 0).
- *
- * @param value a numeric int value
- * @param errorMessage the exception message to use if the check fails
- * @return the validated numeric value
- * @throws IllegalArgumentException if {@code value} was not positive
- */
- public static int checkArgumentPositive(final int value, final String errorMessage) {
- if (value <= 0) {
- throw new IllegalArgumentException(errorMessage);
- }
-
- return value;
- }
-
- /**
- * Ensures that the argument floating point value is non-negative (greater than or equal to 0).
- * @param value a floating point value
- * @param errorMessage the exteption message to use if the check fails
- * @return the validated numeric value
- * @throws IllegalArgumentException if {@code value} was negative
- */
- public static float checkArgumentNonNegative(final float value, final String errorMessage) {
- if (value < 0) {
- throw new IllegalArgumentException(errorMessage);
- }
-
- return value;
- }
-
- /**
- * Ensures that the argument floating point value is positive (greater than 0).
- * @param value a floating point value
- * @param errorMessage the exteption message to use if the check fails
- * @return the validated numeric value
- * @throws IllegalArgumentException if {@code value} was not positive
- */
- public static float checkArgumentPositive(final float value, final String errorMessage) {
- if (value <= 0) {
- throw new IllegalArgumentException(errorMessage);
- }
-
- return value;
- }
-
- /**
- * Ensures that the argument floating point value is a finite number.
- *
- * <p>A finite number is defined to be both representable (that is, not NaN) and
- * not infinite (that is neither positive or negative infinity).</p>
- *
- * @param value a floating point value
- * @param valueName the name of the argument to use if the check fails
- *
- * @return the validated floating point value
- *
- * @throws IllegalArgumentException if {@code value} was not finite
- */
- public static float checkArgumentFinite(final float value, final String valueName) {
- if (Float.isNaN(value)) {
- throw new IllegalArgumentException(valueName + " must not be NaN");
- } else if (Float.isInfinite(value)) {
- throw new IllegalArgumentException(valueName + " must not be infinite");
- }
-
- return value;
- }
-
- /**
- * Ensures that the argument floating point value is within the inclusive range.
- *
- * <p>While this can be used to range check against +/- infinity, note that all NaN numbers
- * will always be out of range.</p>
- *
- * @param value a floating point value
- * @param lower the lower endpoint of the inclusive range
- * @param upper the upper endpoint of the inclusive range
- * @param valueName the name of the argument to use if the check fails
- *
- * @return the validated floating point value
- *
- * @throws IllegalArgumentException if {@code value} was not within the range
- */
- public static float checkArgumentInRange(float value, float lower, float upper,
- String valueName) {
- if (Float.isNaN(value)) {
- throw new IllegalArgumentException(valueName + " must not be NaN");
- } else if (value < lower) {
- throw new IllegalArgumentException(
- String.format(
- "%s is out of range of [%f, %f] (too low)", valueName, lower, upper));
- } else if (value > upper) {
- throw new IllegalArgumentException(
- String.format(
- "%s is out of range of [%f, %f] (too high)", valueName, lower, upper));
- }
-
- return value;
- }
-
- /**
- * Ensures that the argument floating point value is within the inclusive range.
- *
- * <p>While this can be used to range check against +/- infinity, note that all NaN numbers
- * will always be out of range.</p>
- *
- * @param value a floating point value
- * @param lower the lower endpoint of the inclusive range
- * @param upper the upper endpoint of the inclusive range
- * @param valueName the name of the argument to use if the check fails
- *
- * @return the validated floating point value
- *
- * @throws IllegalArgumentException if {@code value} was not within the range
- */
- public static double checkArgumentInRange(double value, double lower, double upper,
- String valueName) {
- if (Double.isNaN(value)) {
- throw new IllegalArgumentException(valueName + " must not be NaN");
- } else if (value < lower) {
- throw new IllegalArgumentException(
- String.format(
- "%s is out of range of [%f, %f] (too low)", valueName, lower, upper));
- } else if (value > upper) {
- throw new IllegalArgumentException(
- String.format(
- "%s is out of range of [%f, %f] (too high)", valueName, lower, upper));
- }
-
- return value;
- }
-
- /**
- * Ensures that the argument int value is within the inclusive range.
- *
- * @param value a int value
- * @param lower the lower endpoint of the inclusive range
- * @param upper the upper endpoint of the inclusive range
- * @param valueName the name of the argument to use if the check fails
- *
- * @return the validated int value
- *
- * @throws IllegalArgumentException if {@code value} was not within the range
- */
- @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
- public static int checkArgumentInRange(int value, int lower, int upper,
- String valueName) {
- if (value < lower) {
- throw new IllegalArgumentException(
- String.format(
- "%s is out of range of [%d, %d] (too low)", valueName, lower, upper));
- } else if (value > upper) {
- throw new IllegalArgumentException(
- String.format(
- "%s is out of range of [%d, %d] (too high)", valueName, lower, upper));
- }
-
- return value;
- }
-
- /**
- * Ensures that the argument long value is within the inclusive range.
- *
- * @param value a long value
- * @param lower the lower endpoint of the inclusive range
- * @param upper the upper endpoint of the inclusive range
- * @param valueName the name of the argument to use if the check fails
- *
- * @return the validated long value
- *
- * @throws IllegalArgumentException if {@code value} was not within the range
- */
- public static long checkArgumentInRange(long value, long lower, long upper,
- String valueName) {
- if (value < lower) {
- throw new IllegalArgumentException(
- String.format(
- "%s is out of range of [%d, %d] (too low)", valueName, lower, upper));
- } else if (value > upper) {
- throw new IllegalArgumentException(
- String.format(
- "%s is out of range of [%d, %d] (too high)", valueName, lower, upper));
- }
-
- return value;
- }
-
- /**
- * Ensures that the array is not {@code null}, and none of its elements are {@code null}.
- *
- * @param value an array of boxed objects
- * @param valueName the name of the argument to use if the check fails
- *
- * @return the validated array
- *
- * @throws NullPointerException if the {@code value} or any of its elements were {@code null}
- */
- public static <T> T[] checkArrayElementsNotNull(final T[] value, final String valueName) {
- if (value == null) {
- throw new NullPointerException(valueName + " must not be null");
- }
-
- for (int i = 0; i < value.length; ++i) {
- if (value[i] == null) {
- throw new NullPointerException(
- String.format("%s[%d] must not be null", valueName, i));
- }
- }
-
- return value;
- }
-
- /**
- * Ensures that the {@link Collection} is not {@code null}, and none of its elements are
- * {@code null}.
- *
- * @param value a {@link Collection} of boxed objects
- * @param valueName the name of the argument to use if the check fails
- *
- * @return the validated {@link Collection}
- *
- * @throws NullPointerException if the {@code value} or any of its elements were {@code null}
- */
- public static @NonNull <C extends Collection<T>, T> C checkCollectionElementsNotNull(
- final C value, final String valueName) {
- if (value == null) {
- throw new NullPointerException(valueName + " must not be null");
- }
-
- long ctr = 0;
- for (T elem : value) {
- if (elem == null) {
- throw new NullPointerException(
- String.format("%s[%d] must not be null", valueName, ctr));
- }
- ++ctr;
- }
-
- return value;
- }
-
- /**
- * Ensures that the {@link Collection} is not {@code null}, and contains at least one element.
- *
- * @param value a {@link Collection} of boxed elements.
- * @param valueName the name of the argument to use if the check fails.
-
- * @return the validated {@link Collection}
- *
- * @throws NullPointerException if the {@code value} was {@code null}
- * @throws IllegalArgumentException if the {@code value} was empty
- */
- public static <T> Collection<T> checkCollectionNotEmpty(final Collection<T> value,
- final String valueName) {
- if (value == null) {
- throw new NullPointerException(valueName + " must not be null");
- }
- if (value.isEmpty()) {
- throw new IllegalArgumentException(valueName + " is empty");
- }
- return value;
- }
-
- /**
- * Ensures that the given byte array is not {@code null}, and contains at least one element.
- *
- * @param value an array of elements.
- * @param valueName the name of the argument to use if the check fails.
-
- * @return the validated array
- *
- * @throws NullPointerException if the {@code value} was {@code null}
- * @throws IllegalArgumentException if the {@code value} was empty
- */
- @NonNull
- public static byte[] checkByteArrayNotEmpty(final byte[] value, final String valueName) {
- if (value == null) {
- throw new NullPointerException(valueName + " must not be null");
- }
- if (value.length == 0) {
- throw new IllegalArgumentException(valueName + " is empty");
- }
- return value;
- }
-
- /**
- * Ensures that argument {@code value} is one of {@code supportedValues}.
- *
- * @param supportedValues an array of string values
- * @param value a string value
- *
- * @return the validated value
- *
- * @throws NullPointerException if either {@code value} or {@code supportedValues} is null
- * @throws IllegalArgumentException if the {@code value} is not in {@code supportedValues}
- */
- @NonNull
- public static String checkArgumentIsSupported(final String[] supportedValues,
- final String value) {
- checkNotNull(value);
- checkNotNull(supportedValues);
-
- if (!contains(supportedValues, value)) {
- throw new IllegalArgumentException(value + "is not supported "
- + Arrays.toString(supportedValues));
- }
- return value;
- }
-
- private static boolean contains(String[] values, String value) {
- if (values == null) {
- return false;
- }
- for (int i = 0; i < values.length; ++i) {
- if (Objects.equals(value, values[i])) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Ensures that all elements in the argument floating point array are within the inclusive range
- *
- * <p>While this can be used to range check against +/- infinity, note that all NaN numbers
- * will always be out of range.</p>
- *
- * @param value a floating point array of values
- * @param lower the lower endpoint of the inclusive range
- * @param upper the upper endpoint of the inclusive range
- * @param valueName the name of the argument to use if the check fails
- *
- * @return the validated floating point value
- *
- * @throws IllegalArgumentException if any of the elements in {@code value} were out of range
- * @throws NullPointerException if the {@code value} was {@code null}
- */
- public static float[] checkArrayElementsInRange(float[] value, float lower, float upper,
- String valueName) {
- checkNotNull(value, "%s must not be null", valueName);
-
- for (int i = 0; i < value.length; ++i) {
- float v = value[i];
-
- if (Float.isNaN(v)) {
- throw new IllegalArgumentException(valueName + "[" + i + "] must not be NaN");
- } else if (v < lower) {
- throw new IllegalArgumentException(
- String.format("%s[%d] is out of range of [%f, %f] (too low)",
- valueName, i, lower, upper));
- } else if (v > upper) {
- throw new IllegalArgumentException(
- String.format("%s[%d] is out of range of [%f, %f] (too high)",
- valueName, i, lower, upper));
- }
- }
-
- return value;
- }
-
- /**
- * Ensures that all elements in the argument integer array are within the inclusive range
- *
- * @param value an integer array of values
- * @param lower the lower endpoint of the inclusive range
- * @param upper the upper endpoint of the inclusive range
- * @param valueName the name of the argument to use if the check fails
- *
- * @return the validated integer array
- *
- * @throws IllegalArgumentException if any of the elements in {@code value} were out of range
- * @throws NullPointerException if the {@code value} was {@code null}
- */
- public static int[] checkArrayElementsInRange(int[] value, int lower, int upper,
- String valueName) {
- checkNotNull(value, "%s must not be null", valueName);
-
- for (int i = 0; i < value.length; ++i) {
- int v = value[i];
-
- if (v < lower) {
- throw new IllegalArgumentException(
- String.format("%s[%d] is out of range of [%d, %d] (too low)",
- valueName, i, lower, upper));
- } else if (v > upper) {
- throw new IllegalArgumentException(
- String.format("%s[%d] is out of range of [%d, %d] (too high)",
- valueName, i, lower, upper));
- }
- }
-
- return value;
- }
-}