Uses of Annotation Interface
org.springframework.lang.Contract

Packages that use Contract

Package	Description
org.springframework.aop.scope	Support for AOP-based scoping of target objects, with configurable backend.
org.springframework.aop.support	Convenience classes for using Spring's AOP API.
org.springframework.beans.factory.annotation	Support package for annotation-driven bean configuration.
org.springframework.core.annotation	Core support package for annotations, meta-annotations, and merged annotations with attribute overrides.
org.springframework.core.convert	Type conversion system API.
org.springframework.expression.spel	SpEL's central implementation package.
org.springframework.test.util	General utility classes for use in unit and integration tests.
org.springframework.util	Miscellaneous utility classes, such as utilities for working with strings, classes, collections, reflection, etc.
org.springframework.util.function	Useful generic java.util.function helper classes.

Uses of Contract in org.springframework.aop.scope

Methods in org.springframework.aop.scope with annotations of type Contract

Modifier and Type	Method	Description
static boolean	ScopedProxyUtils.isScopedTarget(@Nullable String beanName)	Determine if the beanName is the name of a bean that references the target bean within a scoped proxy.

Uses of Contract in org.springframework.aop.support

Methods in org.springframework.aop.support with annotations of type Contract

Modifier and Type	Method	Description
static boolean	AopUtils.isAopProxy(@Nullable Object object)	Check whether the given object is a JDK dynamic proxy or a CGLIB proxy.
static boolean	AopUtils.isCglibProxy(@Nullable Object object)	Check whether the given object is a CGLIB proxy.
static boolean	AopUtils.isJdkDynamicProxy(@Nullable Object object)	Check whether the given object is a JDK dynamic proxy.

Uses of Contract in org.springframework.beans.factory.annotation

Methods in org.springframework.beans.factory.annotation with annotations of type Contract

Modifier and Type	Method	Description
static boolean	InjectionMetadata.needsRefresh(@Nullable InjectionMetadata metadata, Class<?> clazz)	Check whether the given injection metadata needs to be refreshed.

Uses of Contract in org.springframework.core.annotation

Methods in org.springframework.core.annotation with annotations of type Contract

Modifier and Type	Method	Description
boolean	RepeatableContainers.equals(@Nullable Object other)

Uses of Contract in org.springframework.core.convert

Methods in org.springframework.core.convert with annotations of type Contract

Modifier and Type	Method	Description
static @Nullable TypeDescriptor	TypeDescriptor.array(@Nullable TypeDescriptor elementTypeDescriptor)	Create a new type descriptor as an array of the specified type.
static @Nullable TypeDescriptor	TypeDescriptor.forObject(@Nullable Object source)	Create a new type descriptor for an object.

Uses of Contract in org.springframework.expression.spel

Methods in org.springframework.expression.spel with annotations of type Contract

Modifier and Type	Method	Description
static boolean	CodeFlow.isBooleanCompatible(@Nullable String descriptor)	Determine whether the descriptor is for a boolean primitive or boolean reference type.
static boolean	CodeFlow.isPrimitive(@Nullable String descriptor)	Determine whether the descriptor is for a primitive type or void.
static boolean	CodeFlow.isPrimitiveArray(@Nullable String descriptor)	Determine whether the descriptor is for a primitive array (for example, "[[I").
static boolean	CodeFlow.isPrimitiveOrUnboxableSupportedNumber(@Nullable String descriptor)	Determine if the supplied descriptor is for a supported number.
static boolean	CodeFlow.isPrimitiveOrUnboxableSupportedNumberOrBoolean(@Nullable String descriptor)	Determine if the supplied descriptor is for a supported number type or boolean.

Uses of Contract in org.springframework.test.util

Methods in org.springframework.test.util with annotations of type Contract

Modifier and Type	Method	Description
static void	AssertionErrors.assertFalse(String message, boolean condition)	Assert the given condition is false and raise an AssertionError otherwise.
static void	AssertionErrors.assertNotNull(String message, @Nullable Object object)	Assert that the given object is not null and raise an AssertionError otherwise.
static void	AssertionErrors.assertNull(String message, @Nullable Object object)	Assert that the given object is null and raise an AssertionError otherwise.
static void	AssertionErrors.assertTrue(String message, boolean condition)	Assert the given condition is true and raise an AssertionError otherwise.
static void	AssertionErrors.fail(String message)	Fail a test with the given message.

Uses of Contract in org.springframework.util

Methods in org.springframework.util with annotations of type Contract

Modifier and Type	Method	Description
static String @Nullable []	StringUtils.concatenateStringArrays(String @Nullable [] array1, String @Nullable [] array2)	Concatenate the given String arrays into one, with overlapping array elements included twice.
static boolean	CollectionUtils.contains(@Nullable Enumeration<? extends @Nullable Object> enumeration, @Nullable Object element)	Check whether the given Enumeration contains the given element.
static boolean	CollectionUtils.contains(@Nullable Iterator<? extends @Nullable Object> iterator, @Nullable Object element)	Check whether the given Iterator contains the given element.
static boolean	ObjectUtils.containsElement(@Nullable Object @Nullable [] array, @Nullable Object element)	Check whether the given array contains the given element.
static boolean	CollectionUtils.containsInstance(@Nullable Collection<? extends @Nullable Object> collection, @Nullable Object element)	Check whether the given Collection contains the given element instance.
static boolean	StringUtils.containsWhitespace(@Nullable CharSequence str)	Check whether the given CharSequence contains any whitespace characters.
static boolean	StringUtils.containsWhitespace(@Nullable String str)	Check whether the given String contains any whitespace characters.
static boolean	FileSystemUtils.deleteRecursively(@Nullable File root)	Delete the supplied File - for directories, recursively delete any nested directories or files as well.
static boolean	FileSystemUtils.deleteRecursively(@Nullable Path root)	Delete the supplied Path — for directories, recursively delete any nested directories or files as well.
static @Nullable Object	SerializationUtils.deserialize(byte @Nullable [] bytes)	Deprecated. This utility uses Java Object Serialization, which allows arbitrary code to be run and is known for being the source of many Remote Code Execution (RCE) vulnerabilities.
static @Nullable Class<?>	ClassUtils.determineCommonAncestor(@Nullable Class<?> clazz1, @Nullable Class<?> clazz2)	Determine the common ancestor of the given classes, if any.
static boolean	StringUtils.endsWithIgnoreCase(@Nullable String str, @Nullable String suffix)	Test if the given String ends with the specified suffix, ignoring upper/lower case.
static @Nullable Field	ReflectionUtils.findField(Class<?> clazz, @Nullable String name, @Nullable Class<?> type)	Attempt to find a field on the supplied Class with the supplied name and/or type.
static <T> @Nullable T	CollectionUtils.findValueOfType(@Nullable Collection<?> collection, @Nullable Class<T> type)	Find a single value of the given type in the given Collection.
static <T> @Nullable T	CollectionUtils.firstElement(@Nullable List<T> list)	Retrieve the first element of the given List, accessing the zero index.
static <T> @Nullable T	CollectionUtils.firstElement(@Nullable Set<T> set)	Retrieve the first element of the given Set, using SortedSet.first() or otherwise using the iterator.
static @Nullable String	ClassUtils.getDescriptiveType(@Nullable Object value)	Return a descriptive name for the given object's type: usually simply the class name, but component type class name + "[]" for arrays, and an appended list of implemented interfaces for JDK proxies.
static @Nullable String	StringUtils.getFilename(@Nullable String path)	Extract the filename from the given Java resource path.
static @Nullable String	StringUtils.getFilenameExtension(@Nullable String path)	Extract the filename extension from the given Java resource path.
static void	Assert.hasLength(@Nullable String text, String message)	Assert that the given String is not empty; that is, it must not be null and not the empty String.
static void	Assert.hasLength(@Nullable String text, Supplier<String> messageSupplier)	Assert that the given String is not empty; that is, it must not be null and not the empty String.
static boolean	StringUtils.hasLength(@Nullable CharSequence str)	Check that the given CharSequence is neither null nor of length 0.
static boolean	StringUtils.hasLength(@Nullable String str)	Check that the given String is neither null nor of length 0.
static void	Assert.hasText(@Nullable String text, String message)	Assert that the given String contains valid text content; that is, it must not be null and must contain at least one non-whitespace character.
static void	Assert.hasText(@Nullable String text, Supplier<String> messageSupplier)	Assert that the given String contains valid text content; that is, it must not be null and must contain at least one non-whitespace character.
static boolean	StringUtils.hasText(@Nullable CharSequence str)	Check whether the given CharSequence contains actual text.
static boolean	StringUtils.hasText(@Nullable String str)	Check whether the given String contains actual text.
static boolean	ObjectUtils.isArray(@Nullable Object obj)	Determine whether the given object is an array: either an Object array or a primitive array.
static void	Assert.isAssignable(Class<?> superType, @Nullable Class<?> subType)	Assert that superType.isAssignableFrom(subType) is true.
static void	Assert.isAssignable(Class<?> superType, @Nullable Class<?> subType, String message)	Assert that superType.isAssignableFrom(subType) is true.
static void	Assert.isAssignable(Class<?> superType, @Nullable Class<?> subType, Supplier<String> messageSupplier)	Assert that superType.isAssignableFrom(subType) is true.
static boolean	TypeUtils.isAssignableBound(@Nullable Type lhsType, @Nullable Type rhsType)
static boolean	ClassUtils.isCglibProxyClass(@Nullable Class<?> clazz)	Deprecated. in favor of custom (possibly narrower) checks or simply a check for containing ClassUtils.CGLIB_CLASS_SEPARATOR
static boolean	ClassUtils.isCglibProxyClassName(@Nullable String className)	Deprecated. in favor of custom (possibly narrower) checks or simply a check for containing ClassUtils.CGLIB_CLASS_SEPARATOR
static boolean	CollectionUtils.isEmpty(@Nullable Collection<? extends @Nullable Object> collection)	Return true if the supplied Collection is null or empty.
static boolean	CollectionUtils.isEmpty(@Nullable Map<?, ? extends @Nullable Object> map)	Return true if the supplied Map is null or empty.
static boolean	ObjectUtils.isEmpty(@Nullable Object obj)	Determine whether the given object is empty.
static boolean	ObjectUtils.isEmpty(@Nullable Object @Nullable [] array)	Determine whether the given array is empty: i.e.
static boolean	StringUtils.isEmpty(@Nullable Object str)	Deprecated. in favor of StringUtils.hasLength(String) and StringUtils.hasText(String) (or ObjectUtils.isEmpty(Object))
static boolean	ReflectionUtils.isEqualsMethod(@Nullable Method method)	Determine whether the given method is an "equals" method.
static boolean	ReflectionUtils.isHashCodeMethod(@Nullable Method method)	Determine whether the given method is a "hashCode" method.
static void	Assert.isInstanceOf(Class<?> type, @Nullable Object obj)	Assert that the provided object is an instance of the provided class.
static void	Assert.isInstanceOf(Class<?> type, @Nullable Object obj, String message)	Assert that the provided object is an instance of the provided class.
static void	Assert.isInstanceOf(Class<?> type, @Nullable Object obj, Supplier<String> messageSupplier)	Assert that the provided object is an instance of the provided class.
static void	Assert.isNull(@Nullable Object object, String message)	Assert that an object is null.
static void	Assert.isNull(@Nullable Object object, Supplier<String> messageSupplier)	Assert that an object is null.
static boolean	ReflectionUtils.isObjectMethod(@Nullable Method method)	Determine whether the given method is originally declared by Object.
static boolean	ReflectionUtils.isToStringMethod(@Nullable Method method)	Determine whether the given method is a "toString" method.
static void	Assert.isTrue(boolean expression, String message)	Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.
static void	Assert.isTrue(boolean expression, Supplier<String> messageSupplier)	Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.
static boolean	ResourceUtils.isUrl(@Nullable String resourceLocation)	Return whether the given resource location is a URL: either a special "classpath" pseudo URL or a standard URL.
static boolean	ClassUtils.isVisible(Class<?> clazz, @Nullable ClassLoader classLoader)	Check whether the given class is visible in the given ClassLoader.
static boolean	ClassUtils.isVoidType(@Nullable Class<?> type)	Determine if the given type represents either Void or void.
static <T> @Nullable T	CollectionUtils.lastElement(@Nullable List<T> list)	Retrieve the last element of the given List, accessing the highest index.
static <T> @Nullable T	CollectionUtils.lastElement(@Nullable Set<T> set)	Retrieve the last element of the given Set, using SortedSet.last() or otherwise iterating over all elements (assuming a linked set).
static boolean	StringUtils.matchesCharacter(@Nullable String str, char singleCharacter)	Test if the given String matches the given single character.
static boolean	ClassUtils.matchesTypeName(Class<?> clazz, @Nullable String typeName)	Check whether the given class matches the user-specified type name.
static void	Assert.notEmpty(@Nullable Object @Nullable [] array, String message)	Assert that an array contains elements; that is, it must not be null and must contain at least one element.
static void	Assert.notEmpty(Object @Nullable [] array, Supplier<String> messageSupplier)	Assert that an array contains elements; that is, it must not be null and must contain at least one element.
static void	Assert.notEmpty(@Nullable Collection<?> collection, String message)	Assert that a collection contains elements; that is, it must not be null and must contain at least one element.
static void	Assert.notEmpty(@Nullable Collection<?> collection, Supplier<String> messageSupplier)	Assert that a collection contains elements; that is, it must not be null and must contain at least one element.
static void	Assert.notEmpty(@Nullable Map<?,?> map, String message)	Assert that a Map contains entries; that is, it must not be null and must contain at least one entry.
static void	Assert.notEmpty(@Nullable Map<?,?> map, Supplier<String> messageSupplier)	Assert that a Map contains entries; that is, it must not be null and must contain at least one entry.
static void	Assert.notNull(@Nullable Object object, String message)	Assert that an object is not null.
static void	Assert.notNull(@Nullable Object object, Supplier<String> messageSupplier)	Assert that an object is not null.
static boolean	ObjectUtils.nullSafeEquals(@Nullable Object o1, @Nullable Object o2)	Determine if the given objects are equal, returning true if both are null or false if only one is null.
static @Nullable ClassLoader	ClassUtils.overrideThreadContextClassLoader(@Nullable ClassLoader classLoaderToUse)	Override the thread context ClassLoader with the environment's bean ClassLoader if necessary, i.e.
static @Nullable String	StringUtils.quote(@Nullable String str)	Quote the given String with single quotes.
static @Nullable Object	StringUtils.quoteIfString(@Nullable Object obj)	Turn the given Object into a String with single quotes if it is a String; keeping the Object as-is else.
static @Nullable Class<?>	ClassUtils.resolvePrimitiveClassName(@Nullable String name)	Resolve the given class name as primitive class, if appropriate, according to the JVM's naming rules for primitive classes.
static void	ReflectionUtils.rethrowException(@Nullable Throwable throwable)	Rethrow the given exception, which is presumably the target exception of an InvocationTargetException.
static void	ReflectionUtils.rethrowRuntimeException(@Nullable Throwable ex)	Rethrow the given exception, which is presumably the target exception of an InvocationTargetException.
static byte @Nullable []	SerializationUtils.serialize(@Nullable Object object)	Serialize the given object to a byte array.
static boolean	PatternMatchUtils.simpleMatch(@Nullable String pattern, @Nullable String str)	Match a String against the given pattern, supporting direct equality as well as the following simple pattern styles: xxx*, *xxx, *xxx*, and xxx*yyy (with an arbitrary number of pattern parts).
static boolean	PatternMatchUtils.simpleMatch(String @Nullable [] patterns, @Nullable String str)	Match a String against the given patterns, supporting direct equality as well as the following simple pattern styles: xxx*, *xxx, *xxx*, and xxx*yyy (with an arbitrary number of pattern parts).
static boolean	PatternMatchUtils.simpleMatchIgnoreCase(@Nullable String pattern, @Nullable String str)	Variant of PatternMatchUtils.simpleMatch(String, String) that ignores upper/lower case.
static boolean	PatternMatchUtils.simpleMatchIgnoreCase(String @Nullable [] patterns, @Nullable String str)	Variant of PatternMatchUtils.simpleMatch(String[], String) that ignores upper/lower case.
static String @Nullable []	StringUtils.split(@Nullable String toSplit, @Nullable String delimiter)	Split a String at the first occurrence of the delimiter.
static @Nullable Properties	StringUtils.splitArrayElementsIntoProperties(String @Nullable [] array, String delimiter, @Nullable String charsToDelete)	Take an array of strings and split each element based on the given delimiter.
static boolean	StringUtils.startsWithIgnoreCase(@Nullable String str, @Nullable String prefix)	Test if the given String starts with the specified prefix, ignoring upper/lower case.
static void	Assert.state(boolean expression, String message)	Assert a boolean expression, throwing an IllegalStateException if the expression evaluates to false.
static void	Assert.state(boolean expression, Supplier<String> messageSupplier)	Assert a boolean expression, throwing an IllegalStateException if the expression evaluates to false.
static @Nullable Object	ObjectUtils.unwrapOptional(@Nullable Object obj)	Unwrap the given object which is potentially a Optional.

Uses of Contract in org.springframework.util.function

Methods in org.springframework.util.function with annotations of type Contract

Modifier and Type	Method	Description
static <T> @Nullable SingletonSupplier<T>	SingletonSupplier.ofNullable(@Nullable T instance)	Build a SingletonSupplier with the given singleton instance.
static <T> @Nullable SingletonSupplier<T>	SingletonSupplier.ofNullable(@Nullable Supplier<@Nullable T> supplier)	Build a SingletonSupplier with the given supplier.
static @Nullable Object	SupplierUtils.resolve(@Nullable Object candidate)	Resolve a given Supplier, getting its result or immediately returning the given Object as-is if not a Supplier.
static <T> @Nullable T	SupplierUtils.resolve(@Nullable Supplier<T> supplier)	Resolve the given Supplier, getting its result or immediately returning null if the supplier itself was null.