Package io.opencensus.internal
Class Utils
java.lang.Object
io.opencensus.internal.Utils
General internal utility methods.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
checkArgument
(boolean isValid, Object errorMessage) Throws anIllegalArgumentException
if the argument is false.static void
checkArgument
(boolean expression, String errorMessageTemplate, Object... errorMessageArgs) Throws anIllegalArgumentException
if the argument is false.static void
checkIndex
(int index, int size) Validates an index in an array or other container.static <T> void
checkListElementNotNull
(List<T> list, Object errorMessage) Throws aNullPointerException
if any of the list elements is null.static <K,
V> void checkMapElementNotNull
(Map<K, V> map, Object errorMessage) Throws aNullPointerException
if any of the map elements is null.static <T> T
checkNotNull
(T arg, Object errorMessage) Throws aNullPointerException
if the argument is null.static void
checkState
(boolean isValid, Object errorMessage) Throws anIllegalStateException
if the argument is false.static boolean
equalsObjects
(Object x, Object y) Compares two Objects for equality.private static String
Substitutes each%s
intemplate
with an argument.
-
Constructor Details
-
Utils
private Utils()
-
-
Method Details
-
checkArgument
Throws anIllegalArgumentException
if the argument is false. This method is similar toPreconditions.checkArgument(boolean, Object)
from Guava.- Parameters:
isValid
- whether the argument check passed.errorMessage
- the message to use for the exception. Will be converted to a string usingString.valueOf(Object)
.
-
checkArgument
public static void checkArgument(boolean expression, String errorMessageTemplate, @Nullable Object... errorMessageArgs) Throws anIllegalArgumentException
if the argument is false. This method is similar toPreconditions.checkArgument(boolean, Object)
from Guava.- Parameters:
expression
- a boolean expressionerrorMessageTemplate
- a template for the exception message should the check fail. The message is formed by replacing each%s
placeholder in the template with an argument. These are matched by position - the first%s
getserrorMessageArgs[0]
, etc. Unmatched arguments will be appended to the formatted message in square braces. Unmatched placeholders will be left as-is.errorMessageArgs
- the arguments to be substituted into the message template. Arguments are converted to strings usingString.valueOf(Object)
.- Throws:
IllegalArgumentException
- ifexpression
is falseNullPointerException
- if the check fails and eithererrorMessageTemplate
orerrorMessageArgs
is null (don't let this happen)
-
checkState
Throws anIllegalStateException
if the argument is false. This method is similar toPreconditions.checkState(boolean, Object)
from Guava.- Parameters:
isValid
- whether the state check passed.errorMessage
- the message to use for the exception. Will be converted to a string usingString.valueOf(Object)
.
-
checkIndex
public static void checkIndex(int index, int size) Validates an index in an array or other container. This method throws anIllegalArgumentException
if the size is negative and throws anIndexOutOfBoundsException
if the index is negative or greater than or equal to the size. This method is similar toPreconditions.checkElementIndex(int, int)
from Guava.- Parameters:
index
- the index to validate.size
- the size of the array or container.
-
checkNotNull
Throws aNullPointerException
if the argument is null. This method is similar toPreconditions.checkNotNull(Object, Object)
from Guava.- Parameters:
arg
- the argument to check for null.errorMessage
- the message to use for the exception. Will be converted to a string usingString.valueOf(Object)
.- Returns:
- the argument, if it passes the null check.
-
checkListElementNotNull
Throws aNullPointerException
if any of the list elements is null.- Parameters:
list
- the argument list to check for null.errorMessage
- the message to use for the exception. Will be converted to a string usingString.valueOf(Object)
.
-
checkMapElementNotNull
Throws aNullPointerException
if any of the map elements is null.- Parameters:
map
- the argument map to check for null.errorMessage
- the message to use for the exception. Will be converted to a string usingString.valueOf(Object)
.
-
equalsObjects
Compares two Objects for equality. This functionality is provided byObjects.equal(Object, Object)
in Java 7. -
format
Substitutes each%s
intemplate
with an argument. These are matched by position: the first%s
getsargs[0]
, etc. If there are more arguments than placeholders, the unmatched arguments will be appended to the end of the formatted message in square braces.Copied from
Preconditions.format(String, Object...)
from Guava- Parameters:
template
- a non-null string containing 0 or more%s
placeholders.args
- the arguments to be substituted into the message template. Arguments are converted to strings usingString.valueOf(Object)
. Arguments can be null.
-