Uses of Annotation Interface
org.springframework.lang.Nullable
Package
Description
Core Spring AOP interfaces, built on AOP Alliance AOP interoperability interfaces.
AspectJ integration package.
Classes enabling AspectJ 5 @Annotated classes to be used in Spring AOP.
Support package for declarative AOP configuration,
with XML schema being the primary configuration format.
Package containing Spring's basic AOP infrastructure, compliant with the
AOP Alliance interfaces.
SPI package allowing Spring AOP framework to handle arbitrary advice types.
Bean post-processors for use in ApplicationContexts to simplify AOP usage
by automatically creating AOP proxies without the need to use a ProxyFactoryBean.
Various
TargetSourceCreator
implementations for use with Spring's AOP auto-proxying support.Provides miscellaneous interceptor implementations.
Support for AOP-based scoping of target objects, with configurable backend.
Convenience classes for using Spring's AOP API.
Annotation support for AOP pointcuts.
Various
TargetSource
implementations for use
with Spring AOP.Support for dynamic, refreshable
TargetSource
implementations for use with Spring AOP.Support for recording method invocations relevant to
RuntimeHints
metadata.Support classes for components that contribute generated code equivalent to a
runtime behavior.
Support for registering the need for reflection, resources, java
serialization and proxies at runtime.
Convenience classes for using runtime hints.
Support for generating GraalVM native configuration from runtime hints.
This package contains interfaces and classes for manipulating Java beans.
The core package implementing Spring's lightweight Inversion of Control (IoC) container.
Support package for annotation-driven bean configuration.
AOT support for bean factories.
SPI interfaces and configuration-related convenience classes for bean factories.
Support package for Groovy-based bean definitions.
Support infrastructure for bean definition parsing.
Support package for the Java
ServiceLoader
facility.Classes supporting the
org.springframework.beans.factory
package.Mechanism to determine bean wiring metadata from a bean instance.
Contains an abstract XML-based
BeanFactory
implementation,
including a standard "spring-beans" XSD.Properties editors used to convert from String values to object
types such as java.util.Properties.
Classes supporting the org.springframework.beans package,
such as utility classes for sorting and holding lists of beans.
Spring's generic cache abstraction.
Annotations and supporting classes for declarative cache management.
Support classes for the open source cache in
Caffeine library,
allowing to set up Caffeine caches within Spring's cache abstraction.
Implementation package for
java.util.concurrent
based caches.AOP-based solution for declarative caching demarcation.
Implementation package for JSR-107 (javax.cache aka "JCache") based caches.
Support package for declarative JSR-107 caching configuration.
AOP-based solution for declarative caching demarcation using JSR-107 annotations.
Support classes for the org.springframework.cache package.
Transaction-aware decorators for the org.springframework.cache package.
This package builds on the beans package to add support for
message sources and for the Observer design pattern, and the
ability for application objects to obtain resources using a
consistent API.
Annotation support for the Application Context, including JSR-250 "common"
annotations, component-scanning, and Java-based metadata for creating
Spring-managed objects.
AOT support for application contexts.
Support classes for application events, like standard context events.
Expression parsing support within a Spring application context.
Abstraction for determining the current Locale,
plus global holder that exposes a thread-bound Locale.
Support package for reading and managing the components index.
Classes supporting the org.springframework.context package,
such as abstract base classes for ApplicationContext
implementations and a MessageSource implementation.
Load-time weaving support for a Spring application context, building on Spring's
LoadTimeWeaver
abstraction.Provides basic classes for exception handling and version detection,
and other core helpers that are not specific to any part of the framework.
Core support package for annotations, meta-annotations, and merged
annotations with attribute overrides.
Type conversion system API.
SPI to implement Converters for the type conversion system.
Default implementation of the type conversion system.
Spring's environment abstraction consisting of bean definition
profile and hierarchical property source support.
Generic abstraction for (file-based) resources, used throughout the framework.
Generic abstraction for working with byte buffer implementations.
Support classes for Spring's resource abstraction.
Useful delegates for Spring's logging conventions.
Support package for recording metrics during application startup.
Root package for Spring's serializer interfaces and implementations.
Support classes for Spring's serializer abstraction.
Support for styling values as Strings, with ToStringCreator as central class.
This package defines Spring's core TaskExecutor abstraction,
and provides SyncTaskExecutor and SimpleAsyncTaskExecutor implementations.
Support classes for Spring's TaskExecutor abstraction.
Test support classes for Spring's I/O support.
Support classes for compiling and testing generated code.
Core support package for type introspection.
Support classes for reading annotation and class-level metadata.
Core support package for type filtering (e.g.
Exception hierarchy enabling sophisticated error handling independent
of the data access approach in use.
Support classes for DAO implementations,
providing miscellaneous utility methods.
Core abstractions behind the Spring Expression Language.
Common utility classes behind the Spring Expression Language.
SpEL's central implementation package.
SpEL's abstract syntax tree.
SpEL's standard parser implementation.
SpEL's default implementations for various core abstractions.
Integration with the JSR-310
java.time
package in JDK 8.Support classes for the formatting package,
providing common implementations as well as adapters.
Contains a basic abstraction over client/server-side HTTP.
Contains an abstraction over client-side HTTP.
This package provides support for client HTTP
Observation
.Abstractions for reactive HTTP client support including
ClientHttpRequest
and
ClientHttpResponse
as well as a
ClientHttpConnector
.This package provides generic HTTP support classes,
to be used by higher-level classes like RestTemplate.
JSON encoder and decoder support.
Multipart support.
Provides an encoder and a decoder for
Google Protocol Buffers.
XML encoder and decoder support.
Provides an HttpMessageConverter abstraction to convert between Java objects and HTTP input/output messages.
Provides HttpMessageConverter implementations for handling JSON.
Provides an HttpMessageConverter implementation for handling
Google Protocol Buffers.
Provides HttpMessageConverter implementations for handling XML.
Contains an abstraction over server-side HTTP.
Instrumentation for
observing
HTTP server applications.Abstractions for reactive HTTP server support including a
ServerHttpRequest
and
ServerHttpResponse
along with an
HttpHandler
for processing.Instrumentation for
observing
reactive HTTP server applications.This package provides internal HTTP support classes,
to be used by higher-level client and server classes.
Support package for load time weaving based on class loaders,
as required by JPA providers (but not JPA-specific).
Support for class instrumentation on GlassFish.
Support for class instrumentation on JBoss AS 6 and 7.
Support for class instrumentation on Tomcat.
This package provides a facility for generic JCA message endpoint management.
Provides generic support classes for JCA usage within Spring,
mainly for local setup of a JCA ResourceAdapter and/or ConnectionFactory.
The classes in this package make JDBC easier to use and
reduce the likelihood of common errors.
Provides the core JDBC framework, based on JdbcTemplate
and its associated callback interfaces and helper objects.
Context metadata abstraction for the configuration and execution
of table inserts and stored procedure calls.
JdbcTemplate variant with named parameter support.
Simplification layer for common JDBC interactions.
Classes supporting the
org.springframework.jdbc.core
package.Provides a utility class for easy DataSource access,
a PlatformTransactionManager for a single DataSource,
and various simple DataSource implementations.
Provides extensible support for creating embedded database instances.
Provides extensible support for initializing databases through scripts.
Provides a strategy for looking up JDBC DataSources by name.
The classes in this package represent RDBMS queries, updates, and stored
procedures as threadsafe, reusable objects.
Support classes for the JDBC framework, used by the classes in the
jdbc.core and jdbc.object packages.
Provides a strategy interface for Large OBject handling,
as well as a customizable default implementation.
Provides a convenient holder for disconnected result sets.
Abstraction for handling fields of SQLXML data type.
This package contains integration classes for JMS,
allowing for Spring-style JMS access.
Support package for declarative messaging configuration,
with Java configuration and XML schema support.
Provides a PlatformTransactionManager implementation for a single
JMS ConnectionFactory, and a SingleConnectionFactory adapter.
Core package of the JMS support.
Classes supporting the
org.springframework.jms.core
package.This package contains the base message listener container facility.
Message listener adapter mechanism that delegates to target listener
methods, converting messages to appropriate message content types
(such as String or byte array) that get passed into listener methods.
This package provides JCA-based endpoint management for JMS message listeners.
This package provides generic JMS support classes,
to be used by higher-level classes like JmsTemplate.
Provides a MessageConverter abstraction to convert
between Java objects and JMS messages.
Support classes for Spring's JMS framework.
Provides support for accessing remote MBean resources.
This package provides declarative creation and registration of
Spring-managed beans as JMX MBeans.
Annotations for MBean exposure.
Provides a strategy for MBeanInfo assembly.
Provides generic JMX metadata classes and basic support for reading
JMX metadata in a provider-agnostic manner.
Provides a strategy for ObjectName creation.
Contains support classes for connecting to local and remote
MBeanServer
s
and for exposing an MBeanServer
to remote clients.The classes in this package make JNDI easier to use,
facilitating the accessing of configuration stored in JNDI,
and provide useful superclasses for JNDI access classes.
Support classes for JNDI usage,
including a JNDI-based BeanFactory implementation.
Spring's generic mail infrastructure.
JavaMail support for Spring's mail infrastructure.
Support for working with messaging APIs and protocols.
Provides support for message conversion.
Defines interfaces and implementation classes for messaging templates.
Basic abstractions for working with message handler methods.
Annotations and support classes for handling messages.
Support classes for working with annotated message-handling methods with
non-blocking, reactive contracts.
Support classes for working with annotated message-handling methods.
Common infrastructure for invoking message handler methods.
Common infrastructure for invoking message handler methods with non-blocking,
and reactive contracts.
Support for the RSocket protocol.
Support classes for working with annotated RSocket stream handling methods.
Annotations to declare an RSocket service contract with request methods along
with a proxy factory backed by an
RSocketRequester
.Generic support for Simple Messaging Protocols including protocols such as STOMP.
Support classes for handling messages from simple messaging protocols
(like STOMP).
Provides a "simple" message broker implementation along with an abstract base
class and other supporting types such as a registry for subscriptions.
Configuration support for WebSocket messaging using higher level messaging protocols.
Generic support for simple messaging protocols (like STOMP).
Support for handling messages to "user" destinations (i.e.
Provides implementations of
Message
along with
a MessageBuilder and MessageHeaderAccessor for building and working with messages and
message headers, as well as various MessageChannel
implementations and channel interceptor support.Contains abstractions and implementation classes for establishing TCP connections via
TcpOperations
,
handling messages via
TcpConnectionHandler
,
as well as sending messages via
TcpConnection
.Mock implementations of reactive HTTP server contracts.
A comprehensive set of Servlet API 6.0 mock objects, targeted at usage with
Spring's Web MVC framework.
Mock implementations of Spring's reactive server web API abstractions.
Root package for Spring's O/R Mapping integration classes.
Package providing integration of
Hibernate 5.x
with Spring concepts.
Classes supporting the
org.springframework.orm.hibernate5
package.Package providing integration of JPA (Java Persistence API) with Spring concepts.
Internal support for managing JPA persistence units.
Classes supporting the
org.springframework.orm.jpa
package.Support classes for adapting to specific JPA vendors.
Package providing integration of JAXB
with Spring's O/X Mapping support.
Contains (un)marshallers optimized to store binary data in MIME attachments.
Provides generic support classes for using Spring's O/X Mapping integration
within various scenario's.
Package providing integration of XStream
with Spring's O/X Mapping support.
The classes in this package make R2DBC easier to use and
reduce the likelihood of common errors.
Provides a utility class for easy ConnectionFactory access,
a ReactiveTransactionManager for a single ConnectionFactory,
and various simple ConnectionFactory implementations.
Provides extensible support for initializing databases through scripts.
Core domain types around DatabaseClient.
Classes providing an abstraction over SQL bind markers.
General exceptions for Spring's scheduling support,
independent of any specific scheduling system.
Annotation support for asynchronous method execution.
Scheduling convenience classes for the
java.util.concurrent
and jakarta.enterprise.concurrent
packages, allowing to set up a
ThreadPoolExecutor or ScheduledThreadPoolExecutor as a bean in a Spring
context.Support package for declarative scheduling configuration,
with XML schema being the primary configuration format.
Support classes for the open source scheduler
Quartz,
allowing to set up Quartz Schedulers, JobDetails and
Triggers as beans in a Spring context.
Generic support classes for scheduling.
Core interfaces for Spring's scripting support.
Package providing integration of
BeanShell
(and BeanShell2)
into Spring's scripting infrastructure.
Package providing integration of
Groovy
into Spring's scripting infrastructure.
Support classes for Spring's scripting package.
Support classes for annotation-driven tests.
This package contains the Spring TestContext Framework which
provides annotation-driven unit and integration testing support that is
agnostic of the actual testing framework in use.
Ahead-of-time (AOT) support for the Spring TestContext Framework.
Support for context caching within the Spring TestContext Framework.
Test event support classes for the Spring TestContext Framework.
Core support for integrating the Spring TestContext Framework
with the JUnit Jupiter extension model in JUnit 5.
Support classes for integrating the Spring TestContext Framework
with JUnit 4.12 or higher.
Custom JUnit 4
Statements
used in the Spring TestContext Framework.Support classes for the Spring TestContext Framework.
Support classes for integrating the Spring TestContext Framework
with TestNG.
Transactional support classes for the Spring TestContext Framework.
Web support classes for the Spring TestContext Framework.
General utility classes for use in unit and integration tests.
Contains client-side REST testing support.
Contains built-in
RequestMatcher
implementations.Contains built-in
ResponseCreator
implementations.Support for testing Spring WebFlux server endpoints via
WebTestClient
.Contains server-side support for testing Spring MVC applications.
Support for testing Spring MVC applications via
WebTestClient
with MockMvc
for server request
handling.Server-side support for testing Spring MVC applications with
MockMvc
and HtmlUnit.Contains built-in
RequestBuilder
implementations.Contains built-in
ResultMatcher
and ResultHandler
implementations.Contains built-in
MockMvcBuilder
implementations.Spring's core transaction management APIs (independent of any specific transaction
management system); an exception hierarchy for Spring's transaction infrastructure;
and transaction manager, definition, and status interfaces.
Spring's support for annotation-based transaction demarcation.
Support package for declarative transaction configuration,
with XML schema being the primary configuration format.
Spring's support for listening to transaction events.
AOP-based solution for declarative transaction demarcation.
Transaction SPI implementation for JTA.
Support classes for reactive transaction management.
Support classes for the org.springframework.transaction package.
Generic support for UI layer concepts.
Contains classes defining the application context subinterface
for UI applications.
Classes supporting the org.springframework.ui.context package.
Support classes for setting up
FreeMarker
within a Spring application context.
Miscellaneous utility classes, such as utilities for working with strings,
classes, collections, reflection, etc.
Useful generic
java.util.Comparator
implementations,
such as an invertible comparator and a compound comparator.Useful generic
java.util.concurrent.Future
extensions.Useful generic
java.util.function
helper classes.Useful unit data types.
Miscellaneous utility classes for XML parsing and transformation,
such as error handlers that log warnings via Commons Logging.
Provides data binding and validation functionality,
for usage in business and/or UI layers.
Support classes for annotation-based constraint evaluation,
e.g.
Support classes for integrating a JSR-303 Bean Validation provider
(such as Hibernate Validator) into a Spring ApplicationContext
and in particular with Spring's data binding and validation APIs.
Abstractions and support classes for method validation, independent of the
underlying validation library.
Support classes for handling validation results.
Common, generic interfaces that define minimal boundary points
between Spring's web infrastructure and other framework modules.
This package contains classes used to determine the requested the media types in a request.
Provides web-specific data binding functionality.
Annotations for binding requests to controllers and handler methods
as well as for binding request parameters to method arguments.
Support classes for web data binding.
Core package of the client-side web support.
Contains a variant of the application context interface for web applications,
and the ContextLoaderListener that bootstraps a root web application context.
Support for generic request context holding, in particular for
scoping of application objects per HTTP request or HTTP session.
Support for asynchronous request processing.
Classes supporting the
org.springframework.web.context
package,
such as WebApplicationContext implementations and various utility classes.Support for CORS (Cross-Origin Resource Sharing),
based on a common
CorsProcessor
strategy.Reactive support for CORS (Cross-Origin Resource Sharing),
based on a common
CorsProcessor
strategy.Provides generic filter base classes allowing for bean-style configuration.
Support classes for integrating a JSF web layer with a Spring service layer
which is hosted in a Spring root WebApplicationContext.
ELResolvers for integrating a JSF web layer with a Spring service layer
which is hosted in a Spring root WebApplicationContext.
Common infrastructure for handler method processing, as used by
Spring MVC's
org.springframework.web.servlet.mvc.method
package.Support classes for annotation-based handler method processing.
Generic support classes for handler method processing.
Multipart resolution framework for handling file uploads.
Support classes for the multipart resolution framework.
Top-level package for the
spring-webflux
module that contains
DispatcherHandler
, the main entry
point for WebFlux server endpoint processing including key contracts used to
map requests to handlers, invoke them, and process the result.Spring WebFlux configuration infrastructure.
Provides a foundation for both the reactive client and server subpackages.
Provides a reactive
WebClient
that builds on top of the
org.springframework.http.client.reactive
reactive HTTP adapter layer.Provides the types that make up Spring's functional web framework for Reactive environments.
Classes supporting the
org.springframework.web.reactive.function.server
package.Provides HandlerMapping implementations including abstract base classes.
Support classes for serving static resources.
Support for various programming model styles including the invocation of
different types of handlers, e.g.
RequestCondition
and implementations for matching requests based on different criteria.Infrastructure for handler method processing.
Infrastructure for annotation-based handler method processing.
Support for result handling through view resolution.
Support classes for the integration of
FreeMarker
as Spring web view technology.
Support classes for views based on the JSR-223 script engine abstraction
(as included in Java 6+), e.g.
Abstractions and support classes for reactive WebSocket interactions.
Classes adapting Spring's Reactive WebSocket API to and from WebSocket runtimes.
Server support for WebSocket interactions.
Server-side support classes for WebSocket requests.
Holds implementations of
RequestUpgradeStrategy
.Core interfaces and classes for Spring's generic, reactive web support.
Implementations to adapt to the underlying
org.springframework.http.client.reactive
reactive HTTP adapter
and HttpHandler
.Provides common WebHandler implementations and a
WebHandlerDecorator
.Locale related support classes.
Support for creating a client proxy for an HTTP service annotated with
HttpExchange
methods.Provides servlets that integrate with the application context
infrastructure, and the core interfaces and classes for the
Spring web MVC framework.
Defines the XML configuration namespace for Spring MVC.
Annotation-based setup for Spring MVC.
Provides the types that make up Spring's functional web framework for Servlet environments.
Classes supporting the
org.springframework.web.servlet.function
package.Provides standard HandlerMapping implementations,
including abstract base classes for custom implementations.
Locale support classes for Spring's web MVC framework.
Standard controller implementations for the Servlet MVC framework that comes with
Spring.
Support package for annotation-based Servlet MVC controllers.
Common MVC logic for matching incoming requests based on conditions.
Servlet-based infrastructure for handler method processing,
building on the
org.springframework.web.method
package.MVC infrastructure for annotation-based handler method processing, building on the
org.springframework.web.method.annotation
package.Support package for MVC controllers.
Support classes for serving static resources.
Support classes for Spring's web MVC framework.
This package contains Spring's JSP standard tag library for JSP 2.0+.
Spring's form tag library for JSP views in Spring's Web MVC framework.
Theme support classes for Spring's web MVC framework.
Provides standard View and ViewResolver implementations,
including abstract base classes for custom implementations.
Support classes for the integration of
FreeMarker
as Spring web view technology.
Support classes for providing a View implementation based on JSON serialization.
Support classes for views based on the JSR-223 script engine abstraction
(as included in Java 6+), e.g.
Support classes for providing a View implementation based on XML Marshalling.
Support classes for XSLT,
providing a View implementation for XSLT stylesheets.
Common abstractions and Spring configuration support for WebSocket applications.
Classes adapting Spring's WebSocket API to and from WebSocket providers.
Adapter classes for the Jetty WebSocket API.
Adapter classes for the standard Jakarta WebSocket API.
Client-side abstractions for WebSocket applications.
Client-side support for the Jetty WebSocket API.
Client-side classes for use with standard Jakarta WebSocket endpoints.
Support for annotation-based WebSocket setup in configuration classes.
Convenient
WebSocketHandler
implementations and decorators.WebSocket integration for Spring's messaging module.
Server-side abstractions for WebSocket interactions.
Server-side support for the Jetty 9+ WebSocket API.
Server-side classes for use with standard JSR-356 WebSocket endpoints.
Server-side support classes including container-specific strategies
for upgrading a request.
Top-level SockJS types.
SockJS client implementation of
WebSocketClient
.Support classes for creating SockJS frames including the encoding and decoding
of SockJS message frames.
Support classes for SockJS including an
AbstractSockJsService
implementation.Server-side support for SockJS transports including
TransportHandler
implementations
for processing incoming requests, their
session
counterparts for sending messages over the various transports, and
DefaultSockJsService
.TransportHandler
implementation classes as well as a concrete
SockJsService
.SockJS specific implementations of
WebSocketSession
.Miscellaneous web utility classes, such as HTML escaping and cookie handling.
Dedicated support for matching HTTP request paths.
-
Uses of Nullable in org.springframework.aop
Modifier and TypeMethodDescriptionTargetSource.getTarget()
Return a target instance.Class<?>
TargetClassAware.getTargetClass()
Return the target class behind the implementing object (typically a proxy configuration or an actual proxy).Class<?>
TargetSource.getTargetClass()
Return the type of targets returned by thisTargetSource
.ProxyMethodInvocation.getUserAttribute
(String key) Return the value of the specified user attribute.Modifier and TypeMethodDescriptionvoid
AfterReturningAdvice.afterReturning
(Object returnValue, Method method, Object[] args, Object target) Callback after a given method successfully returned.void
AfterReturningAdvice.afterReturning
(Object returnValue, Method method, Object[] args, Object target) Callback after a given method successfully returned.void
Callback before a given method is invoked.void
ProxyMethodInvocation.setUserAttribute
(String key, Object value) Add the specified user attribute with the given value to this invocation. -
Uses of Nullable in org.springframework.aop.aspectj
Modifier and TypeMethodDescriptionfinal ClassLoader
AbstractAspectJAdvice.getAspectClassLoader()
Return the ClassLoader for aspect instances.AspectInstanceFactory.getAspectClassLoader()
Expose the aspect class loader that this factory uses.SimpleAspectInstanceFactory.getAspectClassLoader()
SingletonAspectInstanceFactory.getAspectClassLoader()
static AspectJPrecedenceInformation
AspectJAopUtils.getAspectJPrecedenceInformationFor
(Advisor anAdvisor) Return the AspectJPrecedenceInformation provided by this advisor or its advice.protected String
AspectJExpressionPointcut.getCurrentProxiedBeanName()
protected Type
AbstractAspectJAdvice.getDiscoveredReturningGenericType()
AspectJExpressionPointcutAdvisor.getExpression()
protected org.aspectj.weaver.tools.JoinPointMatch
AbstractAspectJAdvice.getJoinPointMatch()
Get the current join point match at the join point we are being dispatched on.protected org.aspectj.weaver.tools.JoinPointMatch
AbstractAspectJAdvice.getJoinPointMatch
(ProxyMethodInvocation pmi) AspectJExpressionPointcutAdvisor.getLocation()
String[]
AspectJAdviceParameterNameDiscoverer.getParameterNames
(Constructor<?> ctor) An advice method can never be a constructor in Spring.String[]
AspectJAdviceParameterNameDiscoverer.getParameterNames
(Method method) Deduce the parameter names for an advice method.MethodInvocationProceedingJoinPoint.getTarget()
Returns the Spring AOP target.AspectJAfterAdvice.invoke
(MethodInvocation mi) AspectJAfterThrowingAdvice.invoke
(MethodInvocation mi) AspectJAroundAdvice.invoke
(MethodInvocation mi) MethodInvocationProceedingJoinPoint.proceed()
Modifier and TypeMethodDescriptionvoid
AspectJAfterReturningAdvice.afterReturning
(Object returnValue, Method method, Object[] args, Object target) void
AspectJAfterReturningAdvice.afterReturning
(Object returnValue, Method method, Object[] args, Object target) protected Object[]
AbstractAspectJAdvice.argBinding
(org.aspectj.lang.JoinPoint jp, org.aspectj.weaver.tools.JoinPointMatch jpMatch, Object returnValue, Throwable ex) Take the arguments at the method execution join point and output a set of arguments to the advice method.protected Object[]
AbstractAspectJAdvice.argBinding
(org.aspectj.lang.JoinPoint jp, org.aspectj.weaver.tools.JoinPointMatch jpMatch, Object returnValue, Throwable ex) Take the arguments at the method execution join point and output a set of arguments to the advice method.protected Object[]
AbstractAspectJAdvice.argBinding
(org.aspectj.lang.JoinPoint jp, org.aspectj.weaver.tools.JoinPointMatch jpMatch, Object returnValue, Throwable ex) Take the arguments at the method execution join point and output a set of arguments to the advice method.void
boolean
boolean
boolean
protected Object
AbstractAspectJAdvice.invokeAdviceMethod
(org.aspectj.lang.JoinPoint jp, org.aspectj.weaver.tools.JoinPointMatch jpMatch, Object returnValue, Throwable t) protected Object
AbstractAspectJAdvice.invokeAdviceMethod
(org.aspectj.lang.JoinPoint jp, org.aspectj.weaver.tools.JoinPointMatch jpMatch, Object returnValue, Throwable t) protected Object
AbstractAspectJAdvice.invokeAdviceMethod
(org.aspectj.lang.JoinPoint jp, org.aspectj.weaver.tools.JoinPointMatch jpMatch, Object returnValue, Throwable t) protected Object
AbstractAspectJAdvice.invokeAdviceMethod
(org.aspectj.weaver.tools.JoinPointMatch jpMatch, Object returnValue, Throwable ex) Invoke the advice method.protected Object
AbstractAspectJAdvice.invokeAdviceMethod
(org.aspectj.weaver.tools.JoinPointMatch jpMatch, Object returnValue, Throwable ex) Invoke the advice method.protected Object
AbstractAspectJAdvice.invokeAdviceMethod
(org.aspectj.weaver.tools.JoinPointMatch jpMatch, Object returnValue, Throwable ex) Invoke the advice method.void
AspectJExpressionPointcutAdvisor.setExpression
(String expression) void
AspectJExpressionPointcutAdvisor.setLocation
(String location) void
AspectJAdviceParameterNameDiscoverer.setReturningName
(String returningName) IfafterReturning
advice binds the return value, thereturning
variable name must be specified.void
AspectJAdviceParameterNameDiscoverer.setThrowingName
(String throwingName) IfafterThrowing
advice binds the thrown value, thethrowing
variable name must be specified.ModifierConstructorDescriptionAspectJAdviceParameterNameDiscoverer
(String pointcutExpression) Create a new discoverer that attempts to discover parameter names. -
Uses of Nullable in org.springframework.aop.aspectj.annotation
Modifier and TypeMethodDescriptionprotected static AbstractAspectJAdvisorFactory.AspectJAnnotation
AbstractAspectJAdvisorFactory.findAspectJAnnotationOnMethod
(Method method) Find and return the first AspectJ annotation on the given method (there should only be one anyway...).AspectJAdvisorFactory.getAdvice
(Method candidateAdviceMethod, AspectJExpressionPointcut expressionPointcut, MetadataAwareAspectInstanceFactory aspectInstanceFactory, int declarationOrder, String aspectName) Build a Spring AOP Advice for the given AspectJ advice method.ReflectiveAspectJAdvisorFactory.getAdvice
(Method candidateAdviceMethod, AspectJExpressionPointcut expressionPointcut, MetadataAwareAspectInstanceFactory aspectInstanceFactory, int declarationOrder, String aspectName) AspectJAdvisorFactory.getAdvisor
(Method candidateAdviceMethod, MetadataAwareAspectInstanceFactory aspectInstanceFactory, int declarationOrder, String aspectName) Build a Spring AOP Advisor for the given AspectJ advice method.ReflectiveAspectJAdvisorFactory.getAdvisor
(Method candidateAdviceMethod, MetadataAwareAspectInstanceFactory aspectInstanceFactory, int declarationOrderInAspect, String aspectName) BeanFactoryAspectInstanceFactory.getAspectClassLoader()
LazySingletonAspectInstanceFactoryDecorator.getAspectClassLoader()
BeanFactoryAspectInstanceFactory.getAspectCreationMutex()
LazySingletonAspectInstanceFactoryDecorator.getAspectCreationMutex()
MetadataAwareAspectInstanceFactory.getAspectCreationMutex()
Get the best possible creation mutex for this factory.ModifierConstructorDescriptionBeanFactoryAspectInstanceFactory
(BeanFactory beanFactory, String name, Class<?> type) Create a BeanFactoryAspectInstanceFactory, providing a type that AspectJ should introspect to create AJType metadata.ReflectiveAspectJAdvisorFactory
(BeanFactory beanFactory) Create a newReflectiveAspectJAdvisorFactory
, propagating the givenBeanFactory
to the createdAspectJExpressionPointcut
instances, for bean pointcut handling as well as consistentClassLoader
resolution. -
Uses of Nullable in org.springframework.aop.config
Modifier and TypeMethodDescriptionSimpleBeanFactoryAwareAspectInstanceFactory.getAspectClassLoader()
MethodLocatingFactoryBean.getObject()
AdvisorComponentDefinition.getSource()
PointcutComponentDefinition.getSource()
static BeanDefinition
AopConfigUtils.registerAspectJAnnotationAutoProxyCreatorIfNecessary
(BeanDefinitionRegistry registry) static BeanDefinition
AopConfigUtils.registerAspectJAnnotationAutoProxyCreatorIfNecessary
(BeanDefinitionRegistry registry, Object source) static BeanDefinition
AopConfigUtils.registerAspectJAutoProxyCreatorIfNecessary
(BeanDefinitionRegistry registry) static BeanDefinition
AopConfigUtils.registerAspectJAutoProxyCreatorIfNecessary
(BeanDefinitionRegistry registry, Object source) static BeanDefinition
AopConfigUtils.registerAutoProxyCreatorIfNecessary
(BeanDefinitionRegistry registry) static BeanDefinition
AopConfigUtils.registerAutoProxyCreatorIfNecessary
(BeanDefinitionRegistry registry, Object source) Modifier and TypeMethodDescriptionstatic BeanDefinition
AopConfigUtils.registerAspectJAnnotationAutoProxyCreatorIfNecessary
(BeanDefinitionRegistry registry, Object source) static BeanDefinition
AopConfigUtils.registerAspectJAutoProxyCreatorIfNecessary
(BeanDefinitionRegistry registry, Object source) static BeanDefinition
AopConfigUtils.registerAutoProxyCreatorIfNecessary
(BeanDefinitionRegistry registry, Object source) ModifierConstructorDescriptionAdvisorComponentDefinition
(String advisorBeanName, BeanDefinition advisorDefinition, BeanDefinition pointcutDefinition) AspectComponentDefinition
(String aspectName, BeanDefinition[] beanDefinitions, BeanReference[] beanReferences, Object source) AspectComponentDefinition
(String aspectName, BeanDefinition[] beanDefinitions, BeanReference[] beanReferences, Object source) AspectComponentDefinition
(String aspectName, BeanDefinition[] beanDefinitions, BeanReference[] beanReferences, Object source) -
Uses of Nullable in org.springframework.aop.framework
Modifier and TypeFieldDescriptionprotected Advisor
AbstractAdvisingBeanPostProcessor.advisor
protected final Object
ReflectiveMethodInvocation.target
Modifier and TypeMethodDescriptionProxyFactoryBean.getObject()
Return a proxy.Class<?>
AbstractSingletonProxyFactoryBean.getObjectType()
protected ClassLoader
ProxyProcessorSupport.getProxyClassLoader()
Return the configured proxy ClassLoader for this processor.static Object
AopProxyUtils.getSingletonTarget
(Object candidate) Obtain the singleton target object behind the given proxy, if any.Class<?>
AdvisedSupport.getTargetClass()
final Object
ReflectiveMethodInvocation.getThis()
ReflectiveMethodInvocation.getUserAttribute
(String key) protected Object
ReflectiveMethodInvocation.invokeJoinpoint()
Invoke the joinpoint using reflection.ReflectiveMethodInvocation.proceed()
Modifier and TypeMethodDescriptionboolean
AdvisedSupport.adviceIncluded
(Advice advice) Is the given advice included in any advisor within this proxy configuration?int
AdvisedSupport.countAdvicesOfType
(Class<?> adviceClass) Count advices of the given class.AdvisedSupport.getInterceptorsAndDynamicInterceptionAdvice
(Method method, Class<?> targetClass) Determine a list ofMethodInterceptor
objects for the given method, based on this configuration.AdvisorChainFactory.getInterceptorsAndDynamicInterceptionAdvice
(Advised config, Method method, Class<?> targetClass) Determine a list ofMethodInterceptor
objects for the given advisor chain configuration.DefaultAdvisorChainFactory.getInterceptorsAndDynamicInterceptionAdvice
(Advised config, Method method, Class<?> targetClass) AopProxy.getProxy
(ClassLoader classLoader) Create a new proxy object.ProxyFactory.getProxy
(ClassLoader classLoader) Create a new proxy according to the settings in this factory.Class<?>
AopProxy.getProxyClass
(ClassLoader classLoader) Determine the proxy class.Class<?>
ProxyFactory.getProxyClass
(ClassLoader classLoader) Determine the proxy class according to the settings in this factory.void
ProxyFactoryBean.setProxyClassLoader
(ClassLoader classLoader) Set the ClassLoader to generate the proxy class in.void
ProxyProcessorSupport.setProxyClassLoader
(ClassLoader classLoader) Set the ClassLoader to generate the proxy class in.void
AdvisedSupport.setTargetClass
(Class<?> targetClass) Set a target class to be proxied, indicating that the proxy should be castable to the given class.void
AdvisedSupport.setTargetSource
(TargetSource targetSource) void
ReflectiveMethodInvocation.setUserAttribute
(String key, Object value) ModifierConstructorDescriptionprotected
ReflectiveMethodInvocation
(Object proxy, Object target, Method method, Object[] arguments, Class<?> targetClass, List<Object> interceptorsAndDynamicMethodMatchers) Construct a new ReflectiveMethodInvocation with the given arguments.protected
ReflectiveMethodInvocation
(Object proxy, Object target, Method method, Object[] arguments, Class<?> targetClass, List<Object> interceptorsAndDynamicMethodMatchers) Construct a new ReflectiveMethodInvocation with the given arguments.protected
ReflectiveMethodInvocation
(Object proxy, Object target, Method method, Object[] arguments, Class<?> targetClass, List<Object> interceptorsAndDynamicMethodMatchers) Construct a new ReflectiveMethodInvocation with the given arguments. -
Uses of Nullable in org.springframework.aop.framework.adapter
Modifier and TypeMethodDescriptionAfterReturningAdviceInterceptor.invoke
(MethodInvocation mi) MethodBeforeAdviceInterceptor.invoke
(MethodInvocation mi) ThrowsAdviceInterceptor.invoke
(MethodInvocation mi) -
Uses of Nullable in org.springframework.aop.framework.autoproxy
Modifier and TypeFieldDescriptionprotected static final Object[]
AbstractAutoProxyCreator.DO_NOT_PROXY
Convenience constant for subclasses: Return value for "do not proxy".Modifier and TypeMethodDescriptionConstructor<?>[]
AbstractAutoProxyCreator.determineCandidateConstructors
(Class<?> beanClass, String beanName) static Class<?>
AutoProxyUtils.determineTargetClass
(ConfigurableListableBeanFactory beanFactory, String beanName) Determine the original target class for the specified bean, if possible, otherwise falling back to a regulargetType
lookup.protected Object[]
AbstractAdvisorAutoProxyCreator.getAdvicesAndAdvisorsForBean
(Class<?> beanClass, String beanName, TargetSource targetSource) protected abstract Object[]
AbstractAutoProxyCreator.getAdvicesAndAdvisorsForBean
(Class<?> beanClass, String beanName, TargetSource customTargetSource) Return whether the given bean is to be proxied, what additional advices (e.g.protected Object[]
BeanNameAutoProxyCreator.getAdvicesAndAdvisorsForBean
(Class<?> beanClass, String beanName, TargetSource targetSource) Identify as a bean to proxy if the bean name matches one of the names in the configured list of supported names.DefaultAdvisorAutoProxyCreator.getAdvisorBeanNamePrefix()
Return the prefix for bean names that will cause them to be included for auto-proxying by this object.protected BeanFactory
AbstractAutoProxyCreator.getBeanFactory()
Return the owningBeanFactory
.static String
ProxyCreationContext.getCurrentProxiedBeanName()
Return the name of the currently proxied bean instance.protected TargetSource
AbstractAutoProxyCreator.getCustomTargetSource
(Class<?> beanClass, String beanName) Create a target source for bean instances.TargetSourceCreator.getTargetSource
(Class<?> beanClass, String beanName) Create a special TargetSource for the given bean, if any.Class<?>
AbstractAutoProxyCreator.predictBeanType
(Class<?> beanClass, String beanName) Modifier and TypeMethodDescriptionprotected Advisor[]
AbstractAutoProxyCreator.buildAdvisors
(String beanName, Object[] specificInterceptors) Determine the advisors for the given bean, including the specific interceptors as well as the common interceptor, all adapted to the Advisor interface.protected Advisor[]
AbstractAutoProxyCreator.buildAdvisors
(String beanName, Object[] specificInterceptors) Determine the advisors for the given bean, including the specific interceptors as well as the common interceptor, all adapted to the Advisor interface.protected Object
AbstractAutoProxyCreator.createProxy
(Class<?> beanClass, String beanName, Object[] specificInterceptors, TargetSource targetSource) Create an AOP proxy for the given bean.protected Object
AbstractAutoProxyCreator.createProxy
(Class<?> beanClass, String beanName, Object[] specificInterceptors, TargetSource targetSource) Create an AOP proxy for the given bean.static Class<?>
AutoProxyUtils.determineTargetClass
(ConfigurableListableBeanFactory beanFactory, String beanName) Determine the original target class for the specified bean, if possible, otherwise falling back to a regulargetType
lookup.protected Object[]
AbstractAdvisorAutoProxyCreator.getAdvicesAndAdvisorsForBean
(Class<?> beanClass, String beanName, TargetSource targetSource) protected abstract Object[]
AbstractAutoProxyCreator.getAdvicesAndAdvisorsForBean
(Class<?> beanClass, String beanName, TargetSource customTargetSource) Return whether the given bean is to be proxied, what additional advices (e.g.protected Object[]
BeanNameAutoProxyCreator.getAdvicesAndAdvisorsForBean
(Class<?> beanClass, String beanName, TargetSource targetSource) Identify as a bean to proxy if the bean name matches one of the names in the configured list of supported names.protected Object
AbstractAutoProxyCreator.getCacheKey
(Class<?> beanClass, String beanName) Build a cache key for the given bean class and bean name.AbstractAutoProxyCreator.postProcessAfterInitialization
(Object bean, String beanName) Create a proxy with the configured interceptors if the bean is identified as one to proxy by the subclass.void
DefaultAdvisorAutoProxyCreator.setAdvisorBeanNamePrefix
(String advisorBeanNamePrefix) Set the prefix for bean names that will cause them to be included for auto-proxying by this object.protected boolean
AbstractAutoProxyCreator.shouldProxyTargetClass
(Class<?> beanClass, String beanName) Determine whether the given bean should be proxied with its target class rather than its interfaces.static boolean
AutoProxyUtils.shouldProxyTargetClass
(ConfigurableListableBeanFactory beanFactory, String beanName) Determine whether the given bean should be proxied with its target class rather than its interfaces. -
Uses of Nullable in org.springframework.aop.framework.autoproxy.target
Modifier and TypeMethodDescriptionprotected abstract AbstractBeanFactoryBasedTargetSource
AbstractBeanFactoryBasedTargetSourceCreator.createBeanFactoryBasedTargetSource
(Class<?> beanClass, String beanName) Subclasses must implement this method to return a new AbstractPrototypeBasedTargetSource if they wish to create a custom TargetSource for this bean, ornull
if they are not interested it in, in which case no special target source will be created.protected AbstractBeanFactoryBasedTargetSource
LazyInitTargetSourceCreator.createBeanFactoryBasedTargetSource
(Class<?> beanClass, String beanName) protected final AbstractBeanFactoryBasedTargetSource
QuickTargetSourceCreator.createBeanFactoryBasedTargetSource
(Class<?> beanClass, String beanName) protected final BeanFactory
AbstractBeanFactoryBasedTargetSourceCreator.getBeanFactory()
Return the BeanFactory that this TargetSourceCreators runs in.final TargetSource
AbstractBeanFactoryBasedTargetSourceCreator.getTargetSource
(Class<?> beanClass, String beanName) -
Uses of Nullable in org.springframework.aop.interceptor
Modifier and TypeFieldDescriptionprotected Log
AbstractTraceInterceptor.defaultLogger
The defaultLog
instance used to write trace messages.Modifier and TypeMethodDescriptionprotected AsyncTaskExecutor
AsyncExecutionAspectSupport.determineAsyncExecutor
(Method method) Determine the specific executor to use when executing the given method.protected Object
AsyncExecutionAspectSupport.doSubmit
(Callable<Object> task, AsyncTaskExecutor executor, Class<?> returnType) Delegate for actually executing the given task with the chosen executor.protected Executor
AsyncExecutionAspectSupport.findQualifiedExecutor
(BeanFactory beanFactory, String qualifier) Retrieve a target executor for the given qualifier.protected Executor
AsyncExecutionAspectSupport.getDefaultExecutor
(BeanFactory beanFactory) Retrieve or build a default executor for this advice instance.protected Executor
AsyncExecutionInterceptor.getDefaultExecutor
(BeanFactory beanFactory) This implementation searches for a uniqueTaskExecutor
bean in the context, or for anExecutor
bean named "taskExecutor" otherwise.protected abstract String
AsyncExecutionAspectSupport.getExecutorQualifier
(Method method) Return the qualifier or bean name of the executor to be used when executing the given async method, typically specified in the form of an annotation attribute.protected String
AsyncExecutionInterceptor.getExecutorQualifier
(Method method) Get the qualifier for a specific executor to use when executing the given method.AbstractTraceInterceptor.invoke
(MethodInvocation invocation) Determines whether logging is enabled for the particularMethodInvocation
.AsyncExecutionInterceptor.invoke
(MethodInvocation invocation) Intercept the given method invocation, submit the actual calling of the method to the correct task executor and return immediately to the caller.ConcurrencyThrottleInterceptor.invoke
(MethodInvocation methodInvocation) DebugInterceptor.invoke
(MethodInvocation invocation) ExposeInvocationInterceptor.invoke
(MethodInvocation mi) protected abstract Object
AbstractTraceInterceptor.invokeUnderTrace
(MethodInvocation invocation, Log logger) Subclasses must override this method to perform any tracing around the suppliedMethodInvocation
.Modifier and TypeMethodDescriptionvoid
AsyncExecutionAspectSupport.configure
(Supplier<Executor> defaultExecutor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Configure this aspect with the given executor and exception handler suppliers, applying the corresponding default if a supplier is not resolvable.void
AsyncExecutionAspectSupport.configure
(Supplier<Executor> defaultExecutor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Configure this aspect with the given executor and exception handler suppliers, applying the corresponding default if a supplier is not resolvable.protected Executor
AsyncExecutionAspectSupport.findQualifiedExecutor
(BeanFactory beanFactory, String qualifier) Retrieve a target executor for the given qualifier.protected Executor
AsyncExecutionAspectSupport.getDefaultExecutor
(BeanFactory beanFactory) Retrieve or build a default executor for this advice instance.protected Executor
AsyncExecutionInterceptor.getDefaultExecutor
(BeanFactory beanFactory) This implementation searches for a uniqueTaskExecutor
bean in the context, or for anExecutor
bean named "taskExecutor" otherwise.protected String
CustomizableTraceInterceptor.replacePlaceholders
(String message, MethodInvocation methodInvocation, Object returnValue, Throwable throwable, long invocationTime) Replace the placeholders in the given message with the supplied values, or values derived from those supplied.protected String
CustomizableTraceInterceptor.replacePlaceholders
(String message, MethodInvocation methodInvocation, Object returnValue, Throwable throwable, long invocationTime) Replace the placeholders in the given message with the supplied values, or values derived from those supplied.void
Set the text that will get appended to the trace data.void
Set the text that will get prepended to the trace data.protected void
AbstractTraceInterceptor.writeToLog
(Log logger, String message, Throwable ex) Write the supplied trace message andThrowable
to the suppliedLog
instance.ModifierConstructorDescriptionAsyncExecutionAspectSupport
(Executor defaultExecutor) Create a new instance with a defaultAsyncUncaughtExceptionHandler
.AsyncExecutionAspectSupport
(Executor defaultExecutor, AsyncUncaughtExceptionHandler exceptionHandler) Create a newAsyncExecutionAspectSupport
with the given exception handler.AsyncExecutionInterceptor
(Executor defaultExecutor) Create a new instance with a defaultAsyncUncaughtExceptionHandler
.AsyncExecutionInterceptor
(Executor defaultExecutor, AsyncUncaughtExceptionHandler exceptionHandler) Create a newAsyncExecutionInterceptor
. -
Uses of Nullable in org.springframework.aop.scope
Modifier and TypeMethodDescriptionstatic String
ScopedProxyUtils.getOriginalBeanName
(String targetBeanName) Get the original bean name for the provided target bean name.static boolean
ScopedProxyUtils.isScopedTarget
(String beanName) Determine if thebeanName
is the name of a bean that references the target bean within a scoped proxy. -
Uses of Nullable in org.springframework.aop.support
Modifier and TypeMethodDescriptionprotected Object
DelegatePerTargetObjectIntroductionInterceptor.doProceed
(MethodInvocation mi) Proceed with the suppliedMethodInterceptor
.protected Object
DelegatingIntroductionInterceptor.doProceed
(MethodInvocation mi) Proceed with the suppliedMethodInterceptor
.AbstractBeanFactoryPointcutAdvisor.getAdviceBeanName()
Return the name of the advice bean that this advisor refers to, if any.AbstractExpressionPointcut.getExpression()
Return this pointcut's expression.ExpressionPointcut.getExpression()
Return the String expression for this pointcut.AbstractExpressionPointcut.getLocation()
Return location information about the pointcut expression if available.DelegatePerTargetObjectIntroductionInterceptor.invoke
(MethodInvocation mi) Subclasses may need to override this if they want to perform custom behaviour in around advice.DelegatingIntroductionInterceptor.invoke
(MethodInvocation mi) Subclasses may need to override this if they want to perform custom behaviour in around advice.static Object
AopUtils.invokeJoinpointUsingReflection
(Object target, Method method, Object[] args) Invoke the given target via reflection, as part of an AOP method invocation.Modifier and TypeMethodDescriptionboolean
boolean
boolean
boolean
boolean
boolean
boolean
static Method
AopUtils.getMostSpecificMethod
(Method method, Class<?> targetClass) Given a method, which may come from an interface, and a target class used in the current AOP invocation, find the corresponding target method if there is one.static Object
AopUtils.invokeJoinpointUsingReflection
(Object target, Method method, Object[] args) Invoke the given target via reflection, as part of an AOP method invocation.static boolean
AopUtils.isAopProxy
(Object object) Check whether the given object is a JDK dynamic proxy or a CGLIB proxy.static boolean
AopUtils.isCglibProxy
(Object object) Check whether the given object is a CGLIB proxy.static boolean
AopUtils.isEqualsMethod
(Method method) Determine whether the given method is an "equals" method.static boolean
AopUtils.isFinalizeMethod
(Method method) Determine whether the given method is a "finalize" method.static boolean
AopUtils.isHashCodeMethod
(Method method) Determine whether the given method is a "hashCode" method.static boolean
AopUtils.isJdkDynamicProxy
(Object object) Check whether the given object is a JDK dynamic proxy.static boolean
AopUtils.isToStringMethod
(Method method) Determine whether the given method is a "toString" method.protected void
AbstractExpressionPointcut.onSetExpression
(String expression) Called when a new pointcut expression is set.static Method
AopUtils.selectInvocableMethod
(Method method, Class<?> targetType) Select an invocable method on the target type: either the given method itself if actually exposed on the target type, or otherwise a corresponding method on one of the target type's interfaces or on the target type itself.void
AbstractBeanFactoryPointcutAdvisor.setAdviceBeanName
(String adviceBeanName) Specify the name of the advice bean that this advisor should refer to.void
AbstractExpressionPointcut.setExpression
(String expression) void
AbstractExpressionPointcut.setLocation
(String location) Set the location for debugging.void
DefaultBeanFactoryPointcutAdvisor.setPointcut
(Pointcut pointcut) Specify the pointcut targeting the advice.void
DefaultPointcutAdvisor.setPointcut
(Pointcut pointcut) Specify the pointcut targeting the advice.ModifierConstructorDescriptionControlFlowPointcut
(Class<?> clazz, String methodName) Construct a new pointcut that matches all calls below the given method in the given class.DefaultIntroductionAdvisor
(Advice advice, IntroductionInfo introductionInfo) Create a DefaultIntroductionAdvisor for the given advice. -
Uses of Nullable in org.springframework.aop.support.annotation
Modifier and TypeMethodDescriptionboolean
boolean
boolean
ModifierConstructorDescriptionAnnotationMatchingPointcut
(Class<? extends Annotation> classAnnotationType, Class<? extends Annotation> methodAnnotationType) Create a new AnnotationMatchingPointcut for the given annotation types.AnnotationMatchingPointcut
(Class<? extends Annotation> classAnnotationType, Class<? extends Annotation> methodAnnotationType) Create a new AnnotationMatchingPointcut for the given annotation types.AnnotationMatchingPointcut
(Class<? extends Annotation> classAnnotationType, Class<? extends Annotation> methodAnnotationType, boolean checkInherited) Create a new AnnotationMatchingPointcut for the given annotation types.AnnotationMatchingPointcut
(Class<? extends Annotation> classAnnotationType, Class<? extends Annotation> methodAnnotationType, boolean checkInherited) Create a new AnnotationMatchingPointcut for the given annotation types. -
Uses of Nullable in org.springframework.aop.target
Modifier and TypeMethodDescriptionabstract Object
AbstractPoolingTargetSource.getTarget()
Acquire an object from the pool.EmptyTargetSource.getTarget()
Always returnsnull
.Class<?>
AbstractBeanFactoryBasedTargetSource.getTargetClass()
Class<?>
AbstractLazyCreationTargetSource.getTargetClass()
This default implementation returnsnull
if the target isnull
(it is hasn't yet been initialized), or the target class if the target has already been initialized.Class<?>
EmptyTargetSource.getTargetClass()
Always returns the specified target Class, ornull
if none.Modifier and TypeMethodDescriptionboolean
boolean
boolean
Two HotSwappableTargetSources are equal if the current target objects are equal.boolean
Two invoker interceptors are equal if they have the same target or if the targets or the targets are equal.static EmptyTargetSource
Return an EmptyTargetSource for the given target Class.static EmptyTargetSource
Return an EmptyTargetSource for the given target Class. -
Uses of Nullable in org.springframework.aop.target.dynamic
-
Uses of Nullable in org.springframework.aot.agent
Modifier and TypeMethodDescriptionstatic URL
InstrumentedBridgeMethods.classgetResource
(Class<?> clazz, String name) Deprecated.static InputStream
InstrumentedBridgeMethods.classgetResourceAsStream
(Class<?> clazz, String name) Deprecated.static URL
InstrumentedBridgeMethods.classloadergetResource
(ClassLoader classLoader, String name) Deprecated.static InputStream
InstrumentedBridgeMethods.classloadergetResourceAsStream
(ClassLoader classLoader, String name) Deprecated.<T> T
RecordedInvocation.getReturnValue()
Return the value actually returned by the invoked method.Modifier and TypeMethodDescriptionboolean
static void
RuntimeHintsAgent.premain
(String agentArgs, Instrumentation inst) RecordedInvocation.Builder.returnValue
(Object returnValue) Use the given object as the return value for the invocation.RecordedInvocation.Builder.withArgument
(Object argument) Use the given object as the unique argument.RecordedInvocation.Builder.withArguments
(Object... arguments) Use the given objects as the invocation arguments. -
Uses of Nullable in org.springframework.aot.generate
Modifier and TypeMethodDescriptionorg.springframework.javapoet.CodeBlock
MethodReference.ArgumentCodeGenerator.generateCode
(org.springframework.javapoet.TypeName argumentType) Generate the code for the given argument type.GeneratedClass.getEnclosingClass()
Return the enclosingGeneratedClass
ornull
if this instance represents a top-level class.InMemoryGeneratedFiles.getGeneratedFile
(GeneratedFiles.Kind kind, String path) Return theInputStreamSource
of specified file.InMemoryGeneratedFiles.getGeneratedFileContent
(GeneratedFiles.Kind kind, String path) Return the content of the specified file.Modifier and TypeMethodDescriptionorg.springframework.javapoet.ClassName
ClassNameGenerator.generateClassName
(String featureName, org.springframework.javapoet.ClassName target) Generate a uniqueClassName
based on the specifiedfeatureName
andtarget
.org.springframework.javapoet.CodeBlock
DefaultMethodReference.toInvokeCodeBlock
(MethodReference.ArgumentCodeGenerator argumentCodeGenerator, org.springframework.javapoet.ClassName targetClassName) org.springframework.javapoet.CodeBlock
MethodReference.toInvokeCodeBlock
(MethodReference.ArgumentCodeGenerator argumentCodeGenerator, org.springframework.javapoet.ClassName targetClassName) Return this method reference as aCodeBlock
using the specifiedMethodReference.ArgumentCodeGenerator
.ModifierConstructorDescriptionDefaultMethodReference
(org.springframework.javapoet.MethodSpec method, org.springframework.javapoet.ClassName declaringClass) -
Uses of Nullable in org.springframework.aot.hint
Modifier and TypeMethodDescriptionAbstractTypeReference.getEnclosingType()
TypeReference.getEnclosingType()
Return the enclosing type reference, ornull
if this type reference does not have an enclosing type.ConditionalHint.getReachableType()
Return the type that should be reachable for this hint to apply, ornull
if this hint should always been applied.JavaSerializationHint.getReachableType()
JdkProxyHint.getReachableType()
ResourceBundleHint.getReachableType()
ResourcePatternHint.getReachableType()
TypeHint.getReachableType()
ReflectionHints.getTypeHint
(Class<?> type) Return the reflection hints for the specified type.ReflectionHints.getTypeHint
(TypeReference type) Return the reflection hints for the type defined by the specifiedTypeReference
.Modifier and TypeMethodDescriptionboolean
boolean
boolean
boolean
boolean
ResourcePatternHints.Builder.includes
(TypeReference reachableType, String... includes) Include resources matching the specified patterns.void
RuntimeHintsRegistrar.registerHints
(RuntimeHints hints, ClassLoader classLoader) Contribute hints to the givenRuntimeHints
instance.ResourceHints.registerPattern
(Consumer<ResourcePatternHints.Builder> resourceHint) Register that the resources matching the specified pattern should be made available at runtime.ResourceHints.registerPatternIfPresent
(ClassLoader classLoader, String location, Consumer<ResourcePatternHints.Builder> resourceHint) Register a pattern if the givenlocation
is available on the classpath.ResourceHints.registerResourceBundle
(String baseName, Consumer<ResourceBundleHint.Builder> resourceHint) Register that the resource bundle with the specified base name should be made available at runtime.SerializationHints.registerType
(Class<? extends Serializable> type, Consumer<JavaSerializationHint.Builder> serializationHint) Register that the specified type need to be serialized using java serialization.SerializationHints.registerType
(TypeReference type, Consumer<JavaSerializationHint.Builder> serializationHint) Register that the type defined by the specifiedTypeReference
need to be serialized using java serialization.ReflectionHints.registerTypeIfPresent
(ClassLoader classLoader, String typeName, Consumer<TypeHint.Builder> typeHint) Register or customize reflection hints for the specified type if it is available using the specifiedClassLoader
.ReflectionHints.registerTypeIfPresent
(ClassLoader classLoader, String typeName, MemberCategory... memberCategories) Register or customize reflection hints for the specified type if it is available using the specifiedClassLoader
.ModifierConstructorDescriptionprotected
AbstractTypeReference
(String packageName, String simpleName, TypeReference enclosingType) -
Uses of Nullable in org.springframework.aot.hint.support
Modifier and TypeMethodDescriptionvoid
FilePatternResourceHintsRegistrar.registerHints
(ResourceHints hints, ClassLoader classLoader) -
Uses of Nullable in org.springframework.aot.nativex
ModifierConstructorDescriptionFileNativeConfigurationWriter
(Path basePath, String groupId, String artifactId) FileNativeConfigurationWriter
(Path basePath, String groupId, String artifactId) -
Uses of Nullable in org.springframework.beans
Modifier and TypeFieldDescriptionString[]
AbstractNestablePropertyAccessor.PropertyTokenHolder.keys
Modifier and TypeMethodDescriptionstatic String[]
PropertyAccessorUtils.canonicalPropertyNames
(String[] propertyNames) Determine the canonical names for the given property paths.protected Object
AbstractNestablePropertyAccessor.convertForProperty
(String propertyName, Object oldValue, Object newValue, TypeDescriptor td) BeanWrapperImpl.convertForProperty
(Object value, String propertyName) Convert the given value for the specified property to the latter's type.<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType) Convert the value to the required type (if necessary from a String).<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, Field field) Convert the value to the required type (if necessary from a String).default <T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) Convert the value to the required type (if necessary from a String).<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) Convert the value to the required type (if necessary from a String).<T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, Field field) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) PropertyEditorRegistry.findCustomEditor
(Class<?> requiredType, String propertyPath) Find a custom property editor for the given type and property.PropertyEditorRegistrySupport.findCustomEditor
(Class<?> requiredType, String propertyPath) static Method
BeanUtils.findDeclaredMethod
(Class<?> clazz, String methodName, Class<?>... paramTypes) Find a method with the given method name and the given parameter types, declared on the given class or one of its superclasses.static Method
BeanUtils.findDeclaredMethodWithMinimalParameters
(Class<?> clazz, String methodName) Find a method with the given method name and minimal parameters (best case: none), declared on the given class or one of its superclasses.static PropertyEditor
BeanUtils.findEditorByConvention
(Class<?> targetType) Find a JavaBeans PropertyEditor following the 'Editor' suffix convention (e.g.static Method
BeanUtils.findMethod
(Class<?> clazz, String methodName, Class<?>... paramTypes) Find a method with the given method name and the given parameter types, declared on the given class or one of its superclasses.static Method
BeanUtils.findMethodWithMinimalParameters
(Class<?> clazz, String methodName) Find a method with the given method name and minimal parameters (best case: none), declared on the given class or one of its superclasses.static Method
BeanUtils.findMethodWithMinimalParameters
(Method[] methods, String methodName) Find a method with the given method name and minimal parameters (best case: none) in the given list of methods.static <T> Constructor<T>
BeanUtils.findPrimaryConstructor
(Class<T> clazz) Return the primary constructor of the provided class.static PropertyDescriptor
BeanUtils.findPropertyForMethod
(Method method) Find a JavaBeansPropertyDescriptor
for the given method, with the method either being the read method or the write method for that bean property.static PropertyDescriptor
BeanUtils.findPropertyForMethod
(Method method, Class<?> clazz) Find a JavaBeansPropertyDescriptor
for the given method, with the method either being the read method or the write method for that bean property.Get the raw property value, if any.BeanMetadataAttributeAccessor.getAttribute
(String name) BeanInfoFactory.getBeanInfo
(Class<?> beanClass) Return the bean info for the given class, if supported.BeanInstantiationException.getConstructingMethod()
Return the delegate for bean construction purposes, if known.Constructor<?>
BeanInstantiationException.getConstructor()
Return the offending constructor, if known.ConfigurablePropertyAccessor.getConversionService()
Return the associated ConversionService, if any.PropertyEditorRegistrySupport.getConversionService()
Return the associated ConversionService, if any.PropertyValue.getConvertedValue()
Return the converted value of this property value, after processed type conversion.PropertyEditorRegistrySupport.getDefaultEditor
(Class<?> requiredType) Retrieve the default editor for the given property type, if any.protected abstract AbstractNestablePropertyAccessor.PropertyHandler
AbstractNestablePropertyAccessor.getLocalPropertyHandler
(String propertyName) Return aAbstractNestablePropertyAccessor.PropertyHandler
for the specified localpropertyName
.protected org.springframework.beans.BeanWrapperImpl.BeanPropertyHandler
BeanWrapperImpl.getLocalPropertyHandler
(String propertyName) protected org.springframework.beans.DirectFieldAccessor.FieldPropertyHandler
DirectFieldAccessor.getLocalPropertyHandler
(String propertyName) BeanMetadataAttributeAccessor.getMetadataAttribute
(String name) Look up the given BeanMetadataAttribute in this accessor's set of attributes.String[]
NotWritablePropertyException.getPossibleMatches()
Return suggestions for actual bean property names that closely match the invalid property name, if any.PropertyBatchUpdateException.getPropertyAccessException
(String propertyName) Return the exception for this field, ornull
if there isn't any.PropertyAccessException.getPropertyChangeEvent()
Return the PropertyChangeEvent that resulted in the problem.static PropertyDescriptor
BeanUtils.getPropertyDescriptor
(Class<?> clazz, String propertyName) Retrieve the JavaBeansPropertyDescriptors
for the given property.AbstractNestablePropertyAccessor.getPropertyHandler
(String propertyName) Return theAbstractNestablePropertyAccessor.PropertyHandler
for the specifiedpropertyName
, navigating if necessary.PropertyAccessException.getPropertyName()
Return the name of the affected property, if available.TypeMismatchException.getPropertyName()
Return the name of the affected property, if available.Class<?>
AbstractNestablePropertyAccessor.getPropertyType
(String propertyName) Class<?>
AbstractPropertyAccessor.getPropertyType
(String propertyPath) Class<?>
PropertyAccessor.getPropertyType
(String propertyName) Determine the property type for the specified property, either checking the property descriptor or checking the value in case of an indexed or mapped element.protected Class<?>
PropertyEditorRegistrySupport.getPropertyType
(String propertyPath) Determine the property type for the given property path.AbstractNestablePropertyAccessor.getPropertyTypeDescriptor
(String propertyName) PropertyAccessor.getPropertyTypeDescriptor
(String propertyName) Return a type descriptor for the specified property: preferably from the read method, falling back to the write method.AbstractNestablePropertyAccessor.getPropertyValue
(String propertyName) protected Object
AbstractNestablePropertyAccessor.getPropertyValue
(AbstractNestablePropertyAccessor.PropertyTokenHolder tokens) abstract Object
AbstractPropertyAccessor.getPropertyValue
(String propertyName) Actually get the value of a property.MutablePropertyValues.getPropertyValue
(String propertyName) PropertyAccessor.getPropertyValue
(String propertyName) Get the current value of the specified property.PropertyValues.getPropertyValue
(String propertyName) Return the property value with the given name, if any.Class<?>
TypeMismatchException.getRequiredType()
Return the required target type, if any.BeanMetadataAttribute.getSource()
BeanMetadataAttributeAccessor.getSource()
default Object
BeanMetadataElement.getSource()
Return the configuration sourceObject
for this metadata element (may benull
).abstract Object
AbstractNestablePropertyAccessor.PropertyHandler.getValue()
BeanMetadataAttribute.getValue()
Return the value of the attribute.PropertyAccessException.getValue()
Return the affected value that was about to be set, if any.PropertyValue.getValue()
Return the value of the property.TypeMismatchException.getValue()
Return the offending value (may benull
).protected Class<?>
PropertyEditorRegistrySupport.guessPropertyTypeFromEditors
(String propertyName) Guess the property type of the specified property from the registered custom editors (provided that they were registered for a specific type).abstract TypeDescriptor
AbstractNestablePropertyAccessor.PropertyHandler.nested
(int level) BeanMetadataAttributeAccessor.removeAttribute
(String name) static Method
BeanUtils.resolveSignature
(String signature, Class<?> clazz) Parse a method signature in the formmethodName[([arg_list])]
, wherearg_list
is an optional, comma-separated list of fully-qualified type names, and attempts to resolve that signature against the suppliedClass
.Modifier and TypeMethodDescriptionstatic void
CachedIntrospectionResults.acceptClassLoader
(ClassLoader classLoader) Accept the given ClassLoader as cache-safe, even if its classes would not qualify as cache-safe in this CachedIntrospectionResults class.Add a PropertyValue object, replacing any existing one for the corresponding property or getting merged with it (if applicable).MutablePropertyValues.addPropertyValues
(Map<?, ?> other) Add all property values from the given Map.MutablePropertyValues.addPropertyValues
(PropertyValues other) Copy all given PropertyValues into this object.static String
PropertyAccessorUtils.canonicalPropertyName
(String propertyName) Determine the canonical name for the given property path.static String[]
PropertyAccessorUtils.canonicalPropertyNames
(String[] propertyNames) Determine the canonical names for the given property paths.static void
CachedIntrospectionResults.clearClassLoader
(ClassLoader classLoader) Clear the introspection cache for the given ClassLoader, removing the introspection results for all classes underneath that ClassLoader, and removing the ClassLoader (and its children) from the acceptance list.boolean
protected Object
AbstractNestablePropertyAccessor.convertForProperty
(String propertyName, Object oldValue, Object newValue, TypeDescriptor td) protected Object
AbstractNestablePropertyAccessor.convertForProperty
(String propertyName, Object oldValue, Object newValue, TypeDescriptor td) BeanWrapperImpl.convertForProperty
(Object value, String propertyName) Convert the given value for the specified property to the latter's type.<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType) Convert the value to the required type (if necessary from a String).<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType) Convert the value to the required type (if necessary from a String).<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, Field field) Convert the value to the required type (if necessary from a String).<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, Field field) Convert the value to the required type (if necessary from a String).<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, Field field) Convert the value to the required type (if necessary from a String).default <T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) Convert the value to the required type (if necessary from a String).default <T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) Convert the value to the required type (if necessary from a String).default <T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) Convert the value to the required type (if necessary from a String).<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) Convert the value to the required type (if necessary from a String).<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) Convert the value to the required type (if necessary from a String).<T> T
TypeConverter.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) Convert the value to the required type (if necessary from a String).<T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, Field field) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, Field field) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, Field field) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) <T> T
TypeConverterSupport.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) protected void
PropertyEditorRegistrySupport.copyCustomEditorsTo
(PropertyEditorRegistry target, String nestedProperty) Copy the custom editors registered in this instance to the given target registry.boolean
boolean
boolean
PropertyEditorRegistry.findCustomEditor
(Class<?> requiredType, String propertyPath) Find a custom property editor for the given type and property.PropertyEditorRegistry.findCustomEditor
(Class<?> requiredType, String propertyPath) Find a custom property editor for the given type and property.PropertyEditorRegistrySupport.findCustomEditor
(Class<?> requiredType, String propertyPath) PropertyEditorRegistrySupport.findCustomEditor
(Class<?> requiredType, String propertyPath) static PropertyEditor
BeanUtils.findEditorByConvention
(Class<?> targetType) Find a JavaBeans PropertyEditor following the 'Editor' suffix convention (e.g.static Class<?>
BeanUtils.findPropertyType
(String propertyName, Class<?>... beanClasses) Determine the bean property type for the given property from the given classes/interfaces, if possible.boolean
PropertyEditorRegistrySupport.hasCustomEditorForElement
(Class<?> elementType, String propertyPath) Determine whether this registry contains a custom editor for the specified array/collection element.boolean
PropertyEditorRegistrySupport.hasCustomEditorForElement
(Class<?> elementType, String propertyPath) Determine whether this registry contains a custom editor for the specified array/collection element.static boolean
PropertyAccessorUtils.isNestedOrIndexedProperty
(String propertyPath) Check whether the given property path indicates an indexed or nested property.Merge the current value set with that of the supplied object.void
PropertyEditorRegistry.registerCustomEditor
(Class<?> requiredType, String propertyPath, PropertyEditor propertyEditor) Register the given custom property editor for the given type and property, or for all properties of the given type.void
PropertyEditorRegistry.registerCustomEditor
(Class<?> requiredType, String propertyPath, PropertyEditor propertyEditor) Register the given custom property editor for the given type and property, or for all properties of the given type.void
PropertyEditorRegistrySupport.registerCustomEditor
(Class<?> requiredType, String propertyPath, PropertyEditor propertyEditor) void
PropertyEditorRegistrySupport.registerCustomEditor
(Class<?> requiredType, String propertyPath, PropertyEditor propertyEditor) void
BeanMetadataAttributeAccessor.setAttribute
(String name, Object value) void
ConfigurablePropertyAccessor.setConversionService
(ConversionService conversionService) Specify aConversionService
to use for converting property values, as an alternative to JavaBeans PropertyEditors.void
PropertyEditorRegistrySupport.setConversionService
(ConversionService conversionService) Specify aConversionService
to use for converting property values, as an alternative to JavaBeans PropertyEditors.void
PropertyValue.setConvertedValue
(Object value) Set the converted value of this property value, after processed type conversion.void
AbstractNestablePropertyAccessor.setPropertyValue
(String propertyName, Object value) abstract void
AbstractPropertyAccessor.setPropertyValue
(String propertyName, Object value) Actually set a property value.void
PropertyAccessor.setPropertyValue
(String propertyName, Object value) Set the specified value as current property value.void
Set the configuration sourceObject
for this metadata element.void
Set the configuration sourceObject
for this metadata element.abstract void
void
AbstractNestablePropertyAccessor.setWrappedInstance
(Object object, String nestedPath, Object rootObject) Switch the target object, replacing the cached introspection results only if the class of the new object is different to that of the replaced object.void
AbstractNestablePropertyAccessor.setWrappedInstance
(Object object, String nestedPath, Object rootObject) Switch the target object, replacing the cached introspection results only if the class of the new object is different to that of the replaced object.void
BeanWrapperImpl.setWrappedInstance
(Object object, String nestedPath, Object rootObject) void
BeanWrapperImpl.setWrappedInstance
(Object object, String nestedPath, Object rootObject) ModifierConstructorDescriptionBeanInstantiationException
(Class<?> beanClass, String msg, Throwable cause) Create a new BeanInstantiationException.BeanInstantiationException
(Constructor<?> constructor, String msg, Throwable cause) Create a new BeanInstantiationException.BeanInstantiationException
(Method constructingMethod, String msg, Throwable cause) Create a new BeanInstantiationException.BeanMetadataAttribute
(String name, Object value) Create a new AttributeValue instance.BeansException
(String msg, Throwable cause) Create a new BeansException with the specified message and root cause.BeansException
(String msg, Throwable cause) Create a new BeansException with the specified message and root cause.ConversionNotSupportedException
(PropertyChangeEvent propertyChangeEvent, Class<?> requiredType, Throwable cause) Create a new ConversionNotSupportedException.ConversionNotSupportedException
(PropertyChangeEvent propertyChangeEvent, Class<?> requiredType, Throwable cause) Create a new ConversionNotSupportedException.ConversionNotSupportedException
(Object value, Class<?> requiredType, Throwable cause) Create a new ConversionNotSupportedException.ConversionNotSupportedException
(Object value, Class<?> requiredType, Throwable cause) Create a new ConversionNotSupportedException.ConversionNotSupportedException
(Object value, Class<?> requiredType, Throwable cause) Create a new ConversionNotSupportedException.FatalBeanException
(String msg, Throwable cause) Create a new FatalBeanException with the specified message and root cause.InvalidPropertyException
(Class<?> beanClass, String propertyName, String msg, Throwable cause) Create a new InvalidPropertyException.MutablePropertyValues
(List<PropertyValue> propertyValueList) Construct a new MutablePropertyValues object using the given List of PropertyValue objects as-is.MutablePropertyValues
(Map<?, ?> original) Construct a new MutablePropertyValues object from a Map.MutablePropertyValues
(PropertyValues original) Deep copy constructor.PropertyAccessException
(PropertyChangeEvent propertyChangeEvent, String msg, Throwable cause) Create a new PropertyAccessException.PropertyAccessException
(String msg, Throwable cause) Create a new PropertyAccessException without PropertyChangeEvent.PropertyValue
(String name, Object value) Create a new PropertyValue instance.PropertyValue
(PropertyValue original, Object newValue) Constructor that exposes a new value for an original value holder.TypeMismatchException
(PropertyChangeEvent propertyChangeEvent, Class<?> requiredType, Throwable cause) Create a newTypeMismatchException
.TypeMismatchException
(PropertyChangeEvent propertyChangeEvent, Class<?> requiredType, Throwable cause) Create a newTypeMismatchException
.TypeMismatchException
(Object value, Class<?> requiredType) Create a newTypeMismatchException
without aPropertyChangeEvent
.TypeMismatchException
(Object value, Class<?> requiredType) Create a newTypeMismatchException
without aPropertyChangeEvent
.TypeMismatchException
(Object value, Class<?> requiredType, Throwable cause) Create a newTypeMismatchException
without aPropertyChangeEvent
.TypeMismatchException
(Object value, Class<?> requiredType, Throwable cause) Create a newTypeMismatchException
without aPropertyChangeEvent
.TypeMismatchException
(Object value, Class<?> requiredType, Throwable cause) Create a newTypeMismatchException
without aPropertyChangeEvent
. -
Uses of Nullable in org.springframework.beans.factory
Modifier and TypeFieldDescriptionprotected Field
InjectionPoint.field
protected MethodParameter
InjectionPoint.methodParameter
Modifier and TypeMethodDescription<A extends Annotation>
AListableBeanFactory.findAnnotationOnBean
(String beanName, Class<A> annotationType) Find anAnnotation
ofannotationType
on the specified bean, traversing its interfaces and superclasses if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).<A extends Annotation>
AListableBeanFactory.findAnnotationOnBean
(String beanName, Class<A> annotationType, boolean allowFactoryBeanInit) Find anAnnotation
ofannotationType
on the specified bean, traversing its interfaces and superclasses if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).<A extends Annotation>
AInjectionPoint.getAnnotation
(Class<A> annotationType) Retrieve a field/parameter annotation of the given type, if any.CannotLoadBeanClassException.getBeanClassName()
Return the name of the class we were trying to load.BeanCreationException.getBeanName()
Return the name of the bean requested, if any.BeanDefinitionStoreException.getBeanName()
Return the name of the bean, if available.NoSuchBeanDefinitionException.getBeanName()
Return the name of the missing bean, if it was a lookup by name that failed.NoUniqueBeanDefinitionException.getBeanNamesFound()
Return the names of all beans found when only one matching bean was expected.Class<?>
NoSuchBeanDefinitionException.getBeanType()
Return the required type of the missing bean, if it was a lookup by type that failed.InjectionPoint.getField()
Return the wrapped Field, if any.ObjectProvider.getIfAvailable()
Return an instance (possibly shared or independent) of the object managed by this factory.ObjectProvider.getIfUnique()
Return an instance (possibly shared or independent) of the object managed by this factory.UnsatisfiedDependencyException.getInjectionPoint()
Return the injection point (field or method/constructor parameter), if known.InjectionPoint.getMethodParameter()
Return the wrapped MethodParameter, if any.FactoryBean.getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.Class<?>
FactoryBean.getObjectType()
Return the type of object that this FactoryBean creates, ornull
if not known in advance.HierarchicalBeanFactory.getParentBeanFactory()
Return the parent bean factory, ornull
if there is none.BeanCreationException.getRelatedCauses()
Return the related causes, if any.NoSuchBeanDefinitionException.getResolvableType()
Return the requiredResolvableType
of the missing bean, if it was a lookup by type that failed.BeanCreationException.getResourceDescription()
Return the description of the resource that the bean definition came from, if any.BeanDefinitionStoreException.getResourceDescription()
Return the description of the resource that the bean definition came from, if available.CannotLoadBeanClassException.getResourceDescription()
Return the description of the resource that the bean definition came from.Class<?>
Determine the type of the bean with the given name.Class<?>
Determine the type of the bean with the given name.Modifier and TypeMethodDescriptionboolean
boolean
String[]
ListableBeanFactory.getBeanNamesForType
(Class<?> type) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.String[]
ListableBeanFactory.getBeanNamesForType
(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.ListableBeanFactory.getBeansOfType
(Class<T> type) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.ListableBeanFactory.getBeansOfType
(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.static boolean
BeanFactoryUtils.isFactoryDereference
(String name) Return whether the given name is a factory dereference (beginning with the factory dereference prefix).static boolean
BeanFactoryUtils.isGeneratedBeanName
(String name) Return whether the given name is a bean name which has been generated by the default naming strategy (containing a "#..." part).ModifierConstructorDescriptionBeanCreationException
(String resourceDescription, String beanName, String msg) Create a new BeanCreationException.BeanCreationException
(String resourceDescription, String beanName, String msg) Create a new BeanCreationException.BeanCreationException
(String resourceDescription, String beanName, String msg, Throwable cause) Create a new BeanCreationException.BeanDefinitionStoreException
(String resourceDescription, String msg) Create a new BeanDefinitionStoreException.BeanDefinitionStoreException
(String resourceDescription, String beanName, String msg) Create a new BeanDefinitionStoreException.BeanDefinitionStoreException
(String resourceDescription, String beanName, String msg, Throwable cause) Create a new BeanDefinitionStoreException.BeanDefinitionStoreException
(String resourceDescription, String beanName, String msg, Throwable cause) Create a new BeanDefinitionStoreException.BeanDefinitionStoreException
(String resourceDescription, String msg, Throwable cause) Create a new BeanDefinitionStoreException.BeanDefinitionStoreException
(String resourceDescription, String msg, Throwable cause) Create a new BeanDefinitionStoreException.BeanDefinitionStoreException
(String msg, Throwable cause) Create a new BeanDefinitionStoreException.CannotLoadBeanClassException
(String resourceDescription, String beanName, String beanClassName, ClassNotFoundException cause) Create a new CannotLoadBeanClassException.CannotLoadBeanClassException
(String resourceDescription, String beanName, String beanClassName, ClassNotFoundException cause) Create a new CannotLoadBeanClassException.CannotLoadBeanClassException
(String resourceDescription, String beanName, String beanClassName, LinkageError cause) Create a new CannotLoadBeanClassException.CannotLoadBeanClassException
(String resourceDescription, String beanName, String beanClassName, LinkageError cause) Create a new CannotLoadBeanClassException.UnsatisfiedDependencyException
(String resourceDescription, String beanName, String propertyName, String msg) Create a new UnsatisfiedDependencyException.UnsatisfiedDependencyException
(String resourceDescription, String beanName, String propertyName, String msg) Create a new UnsatisfiedDependencyException.UnsatisfiedDependencyException
(String resourceDescription, String beanName, String propertyName, BeansException ex) Create a new UnsatisfiedDependencyException.UnsatisfiedDependencyException
(String resourceDescription, String beanName, String propertyName, BeansException ex) Create a new UnsatisfiedDependencyException.UnsatisfiedDependencyException
(String resourceDescription, String beanName, InjectionPoint injectionPoint, String msg) Create a new UnsatisfiedDependencyException.UnsatisfiedDependencyException
(String resourceDescription, String beanName, InjectionPoint injectionPoint, String msg) Create a new UnsatisfiedDependencyException.UnsatisfiedDependencyException
(String resourceDescription, String beanName, InjectionPoint injectionPoint, String msg) Create a new UnsatisfiedDependencyException.UnsatisfiedDependencyException
(String resourceDescription, String beanName, InjectionPoint injectionPoint, BeansException ex) Create a new UnsatisfiedDependencyException.UnsatisfiedDependencyException
(String resourceDescription, String beanName, InjectionPoint injectionPoint, BeansException ex) Create a new UnsatisfiedDependencyException.UnsatisfiedDependencyException
(String resourceDescription, String beanName, InjectionPoint injectionPoint, BeansException ex) Create a new UnsatisfiedDependencyException. -
Uses of Nullable in org.springframework.beans.factory.annotation
Modifier and TypeFieldDescriptionprotected final PropertyDescriptor
InjectionMetadata.InjectedElement.pd
protected Boolean
InjectionMetadata.InjectedElement.skip
Modifier and TypeMethodDescriptionConstructor<?>[]
AutowiredAnnotationBeanPostProcessor.determineCandidateConstructors
(Class<?> beanClass, String beanName) protected Object
QualifierAnnotationAutowireCandidateResolver.findValue
(Annotation[] annotationsToSearch) Determine a suggested value from any of the given candidate annotations.protected Annotation
QualifierAnnotationAutowireCandidateResolver.getFactoryMethodAnnotation
(RootBeanDefinition bd, Class<? extends Annotation> type) AnnotatedBeanDefinition.getFactoryMethodMetadata()
Obtain metadata for this bean definition's factory method, if any.final MethodMetadata
AnnotatedGenericBeanDefinition.getFactoryMethodMetadata()
protected Annotation
QualifierAnnotationAutowireCandidateResolver.getQualifiedElementAnnotation
(RootBeanDefinition bd, Class<? extends Annotation> type) protected Object
InjectionMetadata.InjectedElement.getResourceToInject
(Object target, String requestingBeanName) Either this orInjectionMetadata.InjectedElement.inject(java.lang.Object, java.lang.String, org.springframework.beans.PropertyValues)
needs to be overridden.QualifierAnnotationAutowireCandidateResolver.getSuggestedValue
(DependencyDescriptor descriptor) Determine whether the given dependency declares a value annotation.AutowiredAnnotationBeanPostProcessor.processAheadOfTime
(RegisteredBean registeredBean) InitDestroyAnnotationBeanPostProcessor.processAheadOfTime
(RegisteredBean registeredBean) static Object
ParameterResolutionDelegate.resolveDependency
(Parameter parameter, int parameterIndex, Class<?> containingClass, AutowireCapableBeanFactory beanFactory) Resolve the dependency for the suppliedParameter
from the suppliedAutowireCapableBeanFactory
.AnnotationBeanWiringInfoResolver.resolveWiringInfo
(Object beanInstance) Modifier and TypeMethodDescriptionvoid
InitDestroyAnnotationBeanPostProcessor.addDestroyAnnotationType
(Class<? extends Annotation> destroyAnnotationType) Add a destroy annotation to check for, indicating destruction methods to call when the context is shutting down.void
InitDestroyAnnotationBeanPostProcessor.addInitAnnotationType
(Class<? extends Annotation> initAnnotationType) Add an init annotation to check for, indicating initialization methods to call after configuration of a bean.protected boolean
InjectionMetadata.InjectedElement.checkPropertySkipping
(PropertyValues pvs) Check whether this injector's property needs to be skipped due to an explicit property value having been specified.void
InjectionMetadata.clear
(PropertyValues pvs) Clear property skipping for the contained elements.protected void
InjectionMetadata.InjectedElement.clearPropertySkipping
(PropertyValues pvs) Clear property skipping for this element.boolean
InjectionMetadata.getInjectedElements
(PropertyValues pvs) Return theelements
to inject based on the specifiedPropertyValues
.protected Object
InjectionMetadata.InjectedElement.getResourceToInject
(Object target, String requestingBeanName) Either this orInjectionMetadata.InjectedElement.inject(java.lang.Object, java.lang.String, org.springframework.beans.PropertyValues)
needs to be overridden.void
InjectionMetadata.inject
(Object target, String beanName, PropertyValues pvs) void
InjectionMetadata.inject
(Object target, String beanName, PropertyValues pvs) protected void
InjectionMetadata.InjectedElement.inject
(Object target, String requestingBeanName, PropertyValues pvs) Either this orInjectionMetadata.InjectedElement.getResourceToInject(java.lang.Object, java.lang.String)
needs to be overridden.protected void
InjectionMetadata.InjectedElement.inject
(Object target, String requestingBeanName, PropertyValues pvs) Either this orInjectionMetadata.InjectedElement.getResourceToInject(java.lang.Object, java.lang.String)
needs to be overridden.static boolean
BeanFactoryAnnotationUtils.isQualifierMatch
(Predicate<String> qualifier, String beanName, BeanFactory beanFactory) Check whether the named bean declares a qualifier of the given name.static boolean
InjectionMetadata.needsRefresh
(InjectionMetadata metadata, Class<?> clazz) Check whether the given injection metadata needs to be refreshed.void
CustomAutowireConfigurer.setBeanClassLoader
(ClassLoader beanClassLoader) protected boolean
InjectionMetadata.InjectedElement.shouldInject
(PropertyValues pvs) Whether the property values should be injected. -
Uses of Nullable in org.springframework.beans.factory.aot
Modifier and TypeMethodDescriptionAotServices.findByBeanName
(String beanName) Find the AOT service that was loaded for the given bean name.default <T> T
AutowiredArguments.get
(int index) Return the resolved argument at the specified index.default <T> T
Return the resolved argument at the specified index.BeanInstanceSupplier.getFactoryMethod()
default Object
AutowiredArguments.getObject
(int index) Return the resolved argument at the specified index.BeanFactoryInitializationAotProcessor.processAheadOfTime
(ConfigurableListableBeanFactory beanFactory) Process the givenConfigurableListableBeanFactory
instance ahead-of-time and return a contribution ornull
.BeanRegistrationAotProcessor.processAheadOfTime
(RegisteredBean registeredBean) Process the givenRegisteredBean
instance ahead-of-time and return a contribution ornull
.<T> T
AutowiredFieldValueResolver.resolve
(RegisteredBean registeredBean) Resolve the field value for the specified registered bean.<T> T
AutowiredFieldValueResolver.resolve
(RegisteredBean registeredBean, Class<T> requiredType) Resolve the field value for the specified registered bean.AutowiredMethodArgumentsResolver.resolve
(RegisteredBean registeredBean) Resolve the method arguments for the specified registered bean.AutowiredFieldValueResolver.resolveObject
(RegisteredBean registeredBean) Resolve the field value for the specified registered bean.Modifier and TypeMethodDescriptionstatic AotServices.Loader
AotServices.factories
(ClassLoader classLoader) Create a newAotServices.Loader
that will obtain AOT services from "META-INF/spring/aot.factories". -
Uses of Nullable in org.springframework.beans.factory.config
Modifier and TypeFieldDescriptionprotected String
PlaceholderConfigurerSupport.nullValue
protected String
PlaceholderConfigurerSupport.valueSeparator
Defaults to ":".Modifier and TypeMethodDescriptiondefault Constructor<?>[]
SmartInstantiationAwareBeanPostProcessor.determineCandidateConstructors
(Class<?> beanClass, String beanName) Determine the candidate constructors to use for the given bean.BeanExpressionResolver.evaluate
(String value, BeanExpressionContext beanExpressionContext) Evaluate the given value as an expression, if applicable; return the value as-is otherwise.String[]
BeanDefinitionHolder.getAliases()
Return the alias names for the bean, as specified directly for the bean definition.ConstructorArgumentValues.getArgumentValue
(int index, Class<?> requiredType) Look for an argument value that either corresponds to the given index in the constructor argument list or generically matches by type.ConstructorArgumentValues.getArgumentValue
(int index, Class<?> requiredType, String requiredName) Look for an argument value that either corresponds to the given index in the constructor argument list or generically matches by type.ConstructorArgumentValues.getArgumentValue
(int index, Class<?> requiredType, String requiredName, Set<ConstructorArgumentValues.ValueHolder> usedValueHolders) Look for an argument value that either corresponds to the given index in the constructor argument list or generically matches by type.ConfigurableBeanFactory.getBeanClassLoader()
Return this factory's class loader for loading bean classes (onlynull
if even the system ClassLoader isn't accessible).BeanDefinition.getBeanClassName()
Return the current bean class name of this bean definition.ConfigurableBeanFactory.getBeanExpressionResolver()
Return the resolution strategy for expressions in bean definition values.protected BeanFactory
AbstractFactoryBean.getBeanFactory()
Return the BeanFactory that this bean runs in.Class<?>
RuntimeBeanReference.getBeanType()
Return the requested bean type if resolution by type is demanded.Scope.getConversationId()
Return the conversation ID for the current underlying scope, if any.ConfigurableBeanFactory.getConversionService()
Return the associated ConversionService, if any.ConstructorArgumentValues.ValueHolder.getConvertedValue()
Return the converted value of the constructor argument, after processed type conversion.DependencyDescriptor.getDependencyName()
Determine the name of the wrapped parameter/field.String[]
BeanDefinition.getDependsOn()
Return the bean names that this bean depends on.BeanDefinition.getDescription()
Return a human-readable description of this bean definition.BeanDefinition.getDestroyMethodName()
Return the name of the destroy method.protected Class<?>[]
AbstractFactoryBean.getEarlySingletonInterfaces()
Return an array of interfaces that a singleton object exposed by this FactoryBean is supposed to implement, for use with an 'early singleton proxy' that will be exposed in case of a circular reference.BeanDefinition.getFactoryBeanName()
Return the factory bean name, if any.BeanDefinition.getFactoryMethodName()
Return a factory method, if any.ConstructorArgumentValues.getGenericArgumentValue
(Class<?> requiredType) Look for a generic argument value that matches the given type.ConstructorArgumentValues.getGenericArgumentValue
(Class<?> requiredType, String requiredName) Look for a generic argument value that matches the given type.ConstructorArgumentValues.getGenericArgumentValue
(Class<?> requiredType, String requiredName, Set<ConstructorArgumentValues.ValueHolder> usedValueHolders) Look for the next generic argument value that matches the given type, ignoring argument values that have already been used in the current resolution process.ConstructorArgumentValues.getIndexedArgumentValue
(int index, Class<?> requiredType) Get argument value for the given index in the constructor argument list.ConstructorArgumentValues.getIndexedArgumentValue
(int index, Class<?> requiredType, String requiredName) Get argument value for the given index in the constructor argument list.BeanDefinition.getInitMethodName()
Return the name of the initializer method.ConstructorArgumentValues.ValueHolder.getName()
Return the name of the constructor argument.FieldRetrievingFactoryBean.getObject()
MethodInvokingFactoryBean.getObject()
Returns the same value each time if the singleton property is set to "true", otherwise returns the value returned from invoking the specified method on the fly.final Properties
PropertiesFactoryBean.getObject()
PropertyPathFactoryBean.getObject()
ServiceLocatorFactoryBean.getObject()
YamlMapFactoryBean.getObject()
YamlPropertiesFactoryBean.getObject()
abstract Class<?>
AbstractFactoryBean.getObjectType()
This abstract method declaration mirrors the method in the FactoryBean interface, for a consistent offering of abstract template methods.BeanDefinition.getOriginatingBeanDefinition()
Return the originating BeanDefinition, ornull
if none.BeanDefinition.getParentName()
Return the name of the parent definition of this bean definition, if any.ConfigurableBeanFactory.getRegisteredScope
(String scopeName) Return the Scope implementation for the given scope name, if any.BeanDefinition.getResourceDescription()
Return a description of the resource that this bean definition came from (for the purpose of showing context in case of errors).BeanDefinition.getScope()
Return the name of the current target scope for this bean, ornull
if not known yet.final Scope
BeanExpressionContext.getScope()
SingletonBeanRegistry.getSingleton
(String beanName) Return the (raw) singleton object registered under the given name.BeanDefinitionHolder.getSource()
Expose the bean definition's source object.ConstructorArgumentValues.ValueHolder.getSource()
RuntimeBeanNameReference.getSource()
RuntimeBeanReference.getSource()
TypedStringValue.getSource()
TypedStringValue.getSpecifiedTypeName()
Return the type name as actually specified for this particular value, if any.Class<?>
FieldRetrievingFactoryBean.getTargetClass()
Return the target class on which the field is defined.FieldRetrievingFactoryBean.getTargetField()
Return the name of the field to be retrieved.FieldRetrievingFactoryBean.getTargetObject()
Return the target object on which the field is defined.TypedStringValue.getTargetTypeName()
Return the type to convert to.ConfigurableBeanFactory.getTempClassLoader()
Return the temporary ClassLoader to use for type matching purposes, if any.ConstructorArgumentValues.ValueHolder.getType()
Return the type of the constructor argument.ConstructorArgumentValues.ValueHolder.getValue()
Return the value for the constructor argument.TypedStringValue.getValue()
Return the String value.protected Object
MethodInvokingBean.invokeWithTargetException()
Perform the invocation and convert InvocationTargetException into the underlying target exception.default Object
BeanPostProcessor.postProcessAfterInitialization
(Object bean, String beanName) Apply thisBeanPostProcessor
to the given new bean instance after any bean initialization callbacks (like InitializingBean'safterPropertiesSet
or a custom init-method).default Object
BeanPostProcessor.postProcessBeforeInitialization
(Object bean, String beanName) Apply thisBeanPostProcessor
to the given new bean instance before any bean initialization callbacks (like InitializingBean'safterPropertiesSet
or a custom init-method).default Object
InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation
(Class<?> beanClass, String beanName) Apply this BeanPostProcessor before the target bean gets instantiated.default PropertyValues
InstantiationAwareBeanPostProcessor.postProcessProperties
(PropertyValues pvs, Object bean, String beanName) Post-process the given property values before the factory applies them to the given bean.default Class<?>
SmartInstantiationAwareBeanPostProcessor.predictBeanType
(Class<?> beanClass, String beanName) Predict the type of the bean to be eventually returned from this processor'sInstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(java.lang.Class<?>, java.lang.String)
callback.Remove the object with the givenname
from the underlying scope.Scope.resolveContextualObject
(String key) Resolve the contextual object for the given key, if any.AutowireCapableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName) Resolve the specified dependency against the beans defined in this factory.AutowireCapableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) Resolve the specified dependency against the beans defined in this factory.ConfigurableBeanFactory.resolveEmbeddedValue
(String value) Resolve the given embedded value, e.g.DependencyDescriptor.resolveNotUnique
(ResolvableType type, Map<String, Object> matchingBeans) Resolve the specified not-unique scenario: by default, throwing aNoUniqueBeanDefinitionException
.protected String
PreferencesPlaceholderConfigurer.resolvePlaceholder
(String path, String key, Preferences preferences) Deprecated.Resolve the given path and key against the given Preferences.protected String
PropertyPlaceholderConfigurer.resolvePlaceholder
(String placeholder, Properties props) Deprecated.Resolve the given placeholder using the given properties.protected String
PropertyPlaceholderConfigurer.resolvePlaceholder
(String placeholder, Properties props, int systemPropertiesMode) Deprecated.Resolve the given placeholder using the given properties, performing a system properties check according to the given mode.DependencyDescriptor.resolveShortcut
(BeanFactory beanFactory) Resolve a shortcut for this dependency against the given factory, for example taking some pre-resolved information into account.protected String
BeanDefinitionVisitor.resolveStringValue
(String strVal) Resolve the given String value, for example parsing placeholders.EmbeddedValueResolver.resolveStringValue
(String strVal) protected String
PropertyPlaceholderConfigurer.resolveSystemProperty
(String key) Deprecated.Resolve the given key as JVM system property, and optionally also as system environment variable if no matching system property has been found.Class<?>
TypedStringValue.resolveTargetType
(ClassLoader classLoader) Determine the type to convert to, resolving it from a specified class name if necessary.protected Object
BeanDefinitionVisitor.resolveValue
(Object value) Modifier and TypeMethodDescriptionvoid
ConstructorArgumentValues.addArgumentValues
(ConstructorArgumentValues other) Copy all given argument values into this object, using separate holder instances to keep the values independent of the original object.void
ConstructorArgumentValues.addGenericArgumentValue
(Object value) Add a generic argument value to be matched by type.void
ConstructorArgumentValues.addIndexedArgumentValue
(int index, Object value) Add an argument value for the given index in the constructor argument list.void
ConstructorArgumentValues.addIndexedArgumentValue
(int index, Object value, String type) Add an argument value for the given index in the constructor argument list.protected void
AbstractFactoryBean.destroyInstance
(T instance) Callback for destroying a singleton instance.boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
BeanExpressionResolver.evaluate
(String value, BeanExpressionContext beanExpressionContext) Evaluate the given value as an expression, if applicable; return the value as-is otherwise.ConstructorArgumentValues.getArgumentValue
(int index, Class<?> requiredType, String requiredName, Set<ConstructorArgumentValues.ValueHolder> usedValueHolders) Look for an argument value that either corresponds to the given index in the constructor argument list or generically matches by type.ConstructorArgumentValues.getArgumentValue
(int index, Class<?> requiredType, String requiredName, Set<ConstructorArgumentValues.ValueHolder> usedValueHolders) Look for an argument value that either corresponds to the given index in the constructor argument list or generically matches by type.ConstructorArgumentValues.getArgumentValue
(int index, Class<?> requiredType, String requiredName, Set<ConstructorArgumentValues.ValueHolder> usedValueHolders) Look for an argument value that either corresponds to the given index in the constructor argument list or generically matches by type.ConstructorArgumentValues.getGenericArgumentValue
(Class<?> requiredType, String requiredName, Set<ConstructorArgumentValues.ValueHolder> usedValueHolders) Look for the next generic argument value that matches the given type, ignoring argument values that have already been used in the current resolution process.ConstructorArgumentValues.getGenericArgumentValue
(Class<?> requiredType, String requiredName, Set<ConstructorArgumentValues.ValueHolder> usedValueHolders) Look for the next generic argument value that matches the given type, ignoring argument values that have already been used in the current resolution process.ConstructorArgumentValues.getGenericArgumentValue
(Class<?> requiredType, String requiredName, Set<ConstructorArgumentValues.ValueHolder> usedValueHolders) Look for the next generic argument value that matches the given type, ignoring argument values that have already been used in the current resolution process.ConstructorArgumentValues.getIndexedArgumentValue
(int index, Class<?> requiredType) Get argument value for the given index in the constructor argument list.ConstructorArgumentValues.getIndexedArgumentValue
(int index, Class<?> requiredType, String requiredName) Get argument value for the given index in the constructor argument list.ConstructorArgumentValues.getIndexedArgumentValue
(int index, Class<?> requiredType, String requiredName) Get argument value for the given index in the constructor argument list.void
DependencyDescriptor.initParameterNameDiscovery
(ParameterNameDiscoverer parameterNameDiscoverer) Initialize parameter name discovery for the underlying method parameter, if any.boolean
BeanDefinitionHolder.matchesName
(String candidateName) Determine whether the given candidate name matches the bean name or the aliases stored in this bean definition.void
ConfigurableListableBeanFactory.registerResolvableDependency
(Class<?> dependencyType, Object autowiredValue) Register a special dependency type with corresponding autowired value.AutowireCapableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName) Resolve the specified dependency against the beans defined in this factory.AutowireCapableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) Resolve the specified dependency against the beans defined in this factory.AutowireCapableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) Resolve the specified dependency against the beans defined in this factory.AutowireCapableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) Resolve the specified dependency against the beans defined in this factory.protected String
PreferencesPlaceholderConfigurer.resolvePlaceholder
(String path, String key, Preferences preferences) Deprecated.Resolve the given path and key against the given Preferences.Class<?>
TypedStringValue.resolveTargetType
(ClassLoader classLoader) Determine the type to convert to, resolving it from a specified class name if necessary.protected Object
BeanDefinitionVisitor.resolveValue
(Object value) void
ConfigurableBeanFactory.setBeanClassLoader
(ClassLoader beanClassLoader) Set the class loader to use for loading bean classes.void
CustomScopeConfigurer.setBeanClassLoader
(ClassLoader beanClassLoader) void
BeanDefinition.setBeanClassName
(String beanClassName) Specify the bean class name of this bean definition.void
ConfigurableBeanFactory.setBeanExpressionResolver
(BeanExpressionResolver resolver) Specify the resolution strategy for expressions in bean definition values.void
AbstractFactoryBean.setBeanFactory
(BeanFactory beanFactory) void
ConfigurableBeanFactory.setConversionService
(ConversionService conversionService) Specify aConversionService
to use for converting property values, as an alternative to JavaBeans PropertyEditors.void
ConstructorArgumentValues.ValueHolder.setConvertedValue
(Object value) Set the converted value of the constructor argument, after processed type conversion.void
BeanDefinition.setDependsOn
(String... dependsOn) Set the names of the beans that this bean depends on being initialized.void
BeanDefinition.setDescription
(String description) Set a human-readable description of this bean definition.void
BeanDefinition.setDestroyMethodName
(String destroyMethodName) Set the name of the destroy method.void
BeanDefinition.setFactoryBeanName
(String factoryBeanName) Specify the factory bean to use, if any.void
BeanDefinition.setFactoryMethodName
(String factoryMethodName) Specify a factory method, if any.void
BeanDefinition.setInitMethodName
(String initMethodName) Set the name of the initializer method.void
Set the name of the constructor argument.void
BeanDefinition.setParentName
(String parentName) Set the name of the parent definition of this bean definition, if any.void
Override the target scope of this bean, specifying a new scope name.void
Set the configuration sourceObject
for this metadata element.void
Set the configuration sourceObject
for this metadata element.void
Set the configuration sourceObject
for this metadata element.void
Set the configuration sourceObject
for this metadata element.void
TypedStringValue.setSpecifiedTypeName
(String specifiedTypeName) Set the type name as actually specified for this particular value, if any.void
FieldRetrievingFactoryBean.setTargetClass
(Class<?> targetClass) Set the target class on which the field is defined.void
FieldRetrievingFactoryBean.setTargetField
(String targetField) Set the name of the field to be retrieved.void
ListFactoryBean.setTargetListClass
(Class<? extends List> targetListClass) Set the class to use for the target List.void
MapFactoryBean.setTargetMapClass
(Class<? extends Map> targetMapClass) Set the class to use for the target Map.void
FieldRetrievingFactoryBean.setTargetObject
(Object targetObject) Set the target object on which the field is defined.void
SetFactoryBean.setTargetSetClass
(Class<? extends Set> targetSetClass) Set the class to use for the target Set.void
TypedStringValue.setTargetTypeName
(String targetTypeName) Specify the type to convert to.void
ConfigurableBeanFactory.setTempClassLoader
(ClassLoader tempClassLoader) Specify a temporary ClassLoader to use for type matching purposes.void
Set the type of the constructor argument.void
Set the value for the constructor argument.void
Set the String value.void
PlaceholderConfigurerSupport.setValueSeparator
(String valueSeparator) Specify the separating character between the placeholder variable and the associated default value, ornull
if no such special character should be processed as a value separator.ModifierConstructorDescriptionBeanDefinitionHolder
(BeanDefinition beanDefinition, String beanName, String[] aliases) Create a new BeanDefinitionHolder.BeanExpressionContext
(ConfigurableBeanFactory beanFactory, Scope scope) TypedStringValue
(String value) Create a newTypedStringValue
for the given String value.TypedStringValue
(String value, Class<?> targetType) Create a newTypedStringValue
for the given String value and target type.TypedStringValue
(String value, String targetTypeName) Create a newTypedStringValue
for the given String value and target type.ValueHolder
(Object value) Create a new ValueHolder for the given value.ValueHolder
(Object value, String type) Create a new ValueHolder for the given value and type.ValueHolder
(Object value, String type) Create a new ValueHolder for the given value and type.ValueHolder
(Object value, String type, String name) Create a new ValueHolder for the given value, type and name.ValueHolder
(Object value, String type, String name) Create a new ValueHolder for the given value, type and name.ValueHolder
(Object value, String type, String name) Create a new ValueHolder for the given value, type and name. -
Uses of Nullable in org.springframework.beans.factory.groovy
Modifier and TypeMethodDescriptiongroovy.lang.Binding
GroovyBeanDefinitionReader.getBinding()
Return a specified binding for Groovy variables, if any. -
Uses of Nullable in org.springframework.beans.factory.parsing
Modifier and TypeMethodDescriptionNullSourceExtractor.extractSource
(Object sourceCandidate, Resource definitionResource) This implementation simply returnsnull
for any input.ReaderContext.extractSource
(Object sourceCandidate) Call the source extractor for the given source object.SourceExtractor.extractSource
(Object sourceCandidate, Resource definingResource) Extract the source metadata from the candidate object supplied by the configuration parser.final Resource[]
ImportDefinition.getActualResources()
Problem.getParseState()
Get theParseState
at the time of the error (may benull
).Problem.getRootCause()
Get the underlying exception that caused the error (may benull
).final Object
AliasDefinition.getSource()
CompositeComponentDefinition.getSource()
final Object
ImportDefinition.getSource()
Location.getSource()
Get the actual location within the associatedresource
(may benull
).ParseState.peek()
Return theParseState.Entry
currently at the top of theArrayDeque
ornull
if theArrayDeque
is empty.Modifier and TypeMethodDescriptionboolean
This implementation expects the other object to be of type BeanComponentDefinition as well, in addition to the superclass's equality requirements.void
Raise a regular error.void
Raise a regular error.void
Raise a regular error.void
ReaderContext.error
(String message, Object source, ParseState parseState) Raise a regular error.void
ReaderContext.error
(String message, Object source, ParseState parseState) Raise a regular error.void
ReaderContext.error
(String message, Object source, ParseState parseState, Throwable cause) Raise a regular error.void
ReaderContext.error
(String message, Object source, ParseState parseState, Throwable cause) Raise a regular error.void
ReaderContext.error
(String message, Object source, ParseState parseState, Throwable cause) Raise a regular error.NullSourceExtractor.extractSource
(Object sourceCandidate, Resource definitionResource) This implementation simply returnsnull
for any input.PassThroughSourceExtractor.extractSource
(Object sourceCandidate, Resource definingResource) Simply returns the suppliedsourceCandidate
as-is.SourceExtractor.extractSource
(Object sourceCandidate, Resource definingResource) Extract the source metadata from the candidate object supplied by the configuration parser.void
Raise a fatal error.void
Raise a fatal error.void
Raise a fatal error.void
ReaderContext.fatal
(String message, Object source, ParseState parseState) Raise a fatal error.void
ReaderContext.fatal
(String message, Object source, ParseState parseState) Raise a fatal error.void
ReaderContext.fatal
(String message, Object source, ParseState parseState, Throwable cause) Raise a fatal error.void
ReaderContext.fatal
(String message, Object source, ParseState parseState, Throwable cause) Raise a fatal error.void
ReaderContext.fatal
(String message, Object source, ParseState parseState, Throwable cause) Raise a fatal error.void
ReaderContext.fireAliasRegistered
(String beanName, String alias, Object source) Fire an alias-registered event.void
ReaderContext.fireImportProcessed
(String importedResource, Object source) Fire an import-processed event.void
ReaderContext.fireImportProcessed
(String importedResource, Resource[] actualResources, Object source) Fire an import-processed event.void
Set thelogger
that is to be used to report warnings.void
Raise a non-critical warning.void
Raise a non-critical warning.void
Raise a non-critical warning.void
ReaderContext.warning
(String message, Object source, ParseState parseState) Raise a non-critical warning.void
ReaderContext.warning
(String message, Object source, ParseState parseState) Raise a non-critical warning.void
ReaderContext.warning
(String message, Object source, ParseState parseState, Throwable cause) Raise a non-critical warning.void
ReaderContext.warning
(String message, Object source, ParseState parseState, Throwable cause) Raise a non-critical warning.void
ReaderContext.warning
(String message, Object source, ParseState parseState, Throwable cause) Raise a non-critical warning.ModifierConstructorDescriptionAliasDefinition
(String beanName, String alias, Object source) Create a new AliasDefinition.BeanComponentDefinition
(BeanDefinition beanDefinition, String beanName, String[] aliases) Create a new BeanComponentDefinition for the given bean.CompositeComponentDefinition
(String name, Object source) Create a new CompositeComponentDefinition.ImportDefinition
(String importedResource, Object source) Create a new ImportDefinition.ImportDefinition
(String importedResource, Resource[] actualResources, Object source) Create a new ImportDefinition.ImportDefinition
(String importedResource, Resource[] actualResources, Object source) Create a new ImportDefinition.Create a new instance of theLocation
class.Problem
(String message, Location location, ParseState parseState, Throwable rootCause) Create a new instance of theProblem
class.Problem
(String message, Location location, ParseState parseState, Throwable rootCause) Create a new instance of theProblem
class. -
Uses of Nullable in org.springframework.beans.factory.serviceloader
Modifier and TypeMethodDescriptionClass<?>
ServiceFactoryBean.getObjectType()
Class<?>
AbstractServiceLoaderBasedFactoryBean.getServiceType()
Return the desired service type.Modifier and TypeMethodDescriptionvoid
AbstractServiceLoaderBasedFactoryBean.setBeanClassLoader
(ClassLoader beanClassLoader) void
AbstractServiceLoaderBasedFactoryBean.setServiceType
(Class<?> serviceType) Specify the desired service type (typically the service's public API). -
Uses of Nullable in org.springframework.beans.factory.support
Modifier and TypeMethodDescriptionprotected Object
AbstractAutowireCapableBeanFactory.applyBeanPostProcessorsBeforeInstantiation
(Class<?> beanClass, String beanName) Apply InstantiationAwareBeanPostProcessors to the specified bean definition (by class and name), invoking theirpostProcessBeforeInstantiation
methods.protected String
DefaultListableBeanFactory.determineAutowireCandidate
(Map<String, Object> candidates, DependencyDescriptor descriptor) Determine the autowire candidate in the given set of beans.protected Constructor<?>[]
AbstractAutowireCapableBeanFactory.determineConstructorsFromBeanPostProcessors
(Class<?> beanClass, String beanName) Determine candidate constructors to use for the given bean, checking all registeredSmartInstantiationAwareBeanPostProcessors
.protected String
DefaultListableBeanFactory.determineHighestPriorityCandidate
(Map<String, Object> candidates, Class<?> requiredType) Determine the candidate with the highest priority in the given set of beans.protected String
DefaultListableBeanFactory.determinePrimaryCandidate
(Map<String, Object> candidates, Class<?> requiredType) Determine the primary candidate in the given set of beans.protected Class<?>
AbstractAutowireCapableBeanFactory.determineTargetType
(String beanName, RootBeanDefinition mbd, Class<?>... typesToMatch) Determine the target type for the given bean definition.DefaultListableBeanFactory.doResolveDependency
(DependencyDescriptor descriptor, String beanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) protected Object
Evaluate the given value as an expression, if necessary.protected Object
BeanDefinitionValueResolver.evaluate
(TypedStringValue value) Evaluate the given value as an expression, if necessary.protected Object
AbstractBeanFactory.evaluateBeanDefinitionString
(String value, BeanDefinition beanDefinition) Evaluate the given String as contained in a bean definition, potentially resolving it as an expression.<A extends Annotation>
ADefaultListableBeanFactory.findAnnotationOnBean
(String beanName, Class<A> annotationType) <A extends Annotation>
ADefaultListableBeanFactory.findAnnotationOnBean
(String beanName, Class<A> annotationType, boolean allowFactoryBeanInit) <A extends Annotation>
AStaticListableBeanFactory.findAnnotationOnBean
(String beanName, Class<A> annotationType) <A extends Annotation>
AStaticListableBeanFactory.findAnnotationOnBean
(String beanName, Class<A> annotationType, boolean allowFactoryBeanInit) AbstractBeanDefinitionReader.getBeanClassLoader()
AbstractBeanFactory.getBeanClassLoader()
BeanDefinitionReader.getBeanClassLoader()
Return the class loader to use for bean classes.AbstractBeanDefinition.getBeanClassName()
Return the current bean class name of this bean definition.AbstractBeanFactory.getBeanExpressionResolver()
protected final BeanFactory
GenericTypeAwareAutowireCandidateResolver.getBeanFactory()
LookupOverride.getBeanName()
Return the name of the bean that should be returned by this method.protected Object
FactoryBeanRegistrySupport.getCachedObjectForFactoryBean
(String beanName) Obtain an object to expose from the given FactoryBean, if available in cached form.AbstractBeanFactory.getConversionService()
static Method
SimpleInstantiationStrategy.getCurrentlyInvokedFactoryMethod()
Return the factory method currently being invoked ornull
if none.protected TypeConverter
AbstractBeanFactory.getCustomTypeConverter()
Return the custom TypeConverter to use, if any.RootBeanDefinition.getDecoratedDefinition()
Return the target definition that is being decorated by this bean definition, if any.PropertiesBeanDefinitionReader.getDefaultParentBean()
Deprecated.Return the default parent bean for this bean factory.DefaultListableBeanFactory.getDependencyComparator()
Return the dependency comparator for this BeanFactory (may benull
).String[]
AbstractBeanDefinition.getDependsOn()
Return the bean names that this bean depends on.AbstractBeanDefinition.getDescription()
Return a human-readable description of this bean definition.AbstractBeanDefinition.getDestroyMethodName()
Return the name of the destroy method (the first one in case of multiple methods).BeanDefinitionDefaults.getDestroyMethodName()
Return the name of the default destroy method.String[]
AbstractBeanDefinition.getDestroyMethodNames()
Return the names of the destroy methods.ManagedList.getElementTypeName()
Return the default element type name (class name) to be used for this list.ManagedSet.getElementTypeName()
Return the default element type name (class name) to be used for this set.AbstractBeanDefinition.getFactoryBeanName()
Return the factory bean name, if any.default Method
InstanceSupplier.getFactoryMethod()
Return the factory method that this supplier uses to create the instance, ornull
if it is not known or this supplier uses another means.AbstractBeanDefinition.getFactoryMethodName()
Return a factory method, if any.AbstractBeanDefinition.getInitMethodName()
Return the name of the initializer method (the first one in case of multiple methods).BeanDefinitionDefaults.getInitMethodName()
Return the name of the default initializer method.String[]
AbstractBeanDefinition.getInitMethodNames()
Return the names of the initializer methods.Supplier<?>
AbstractBeanDefinition.getInstanceSupplier()
Return a callback for creating an instance of the bean, if any.ManagedMap.getKeyTypeName()
Return the default key type name (class name) to be used for this map.AbstractBeanDefinition.getLazyInit()
Return whether this bean should be lazily initialized, i.e.BeanDefinitionDefaults.getLazyInit()
Return whether beans should be lazily initialized by default, i.e.default Class<?>
AutowireCandidateResolver.getLazyResolutionProxyClass
(DependencyDescriptor descriptor, String beanName) Determine the proxy class for lazy resolution of the dependency target, if demanded by the injection point.Class<?>
SimpleAutowireCandidateResolver.getLazyResolutionProxyClass
(DependencyDescriptor descriptor, String beanName) default Object
AutowireCandidateResolver.getLazyResolutionProxyIfNecessary
(DependencyDescriptor descriptor, String beanName) Build a proxy for lazy resolution of the actual dependency target, if demanded by the injection point.SimpleAutowireCandidateResolver.getLazyResolutionProxyIfNecessary
(DependencyDescriptor descriptor, String beanName) AbstractBeanDefinition.getOriginatingBeanDefinition()
Return the originating BeanDefinition, ornull
if none.MethodOverrides.getOverride
(Method method) Return the override for the given method, if any.AbstractAutowireCapableBeanFactory.getParameterNameDiscoverer()
Return the ParameterNameDiscoverer to use for resolving method parameter names if needed.RegisteredBean.getParent()
Return the parent of this instance ornull
if not an inner-bean.AbstractBeanFactory.getParentBeanFactory()
ChildBeanDefinition.getParentName()
GenericBeanDefinition.getParentName()
Constructor<?>[]
RootBeanDefinition.getPreferredConstructors()
Determine preferred constructors to use for default construction, if any.protected Integer
DefaultListableBeanFactory.getPriority
(Object beanInstance) Return the priority assigned for the given bean instance by thejakarta.annotation.Priority
annotation.RootBeanDefinition.getQualifiedElement()
Return theAnnotatedElement
defining qualifiers, if any.AbstractBeanDefinition.getQualifier
(String typeName) Return the qualifier mapped to the provided type name.AbstractBeanFactory.getRegisteredScope
(String scopeName) protected RootBeanDefinition
GenericTypeAwareAutowireCandidateResolver.getResolvedDecoratedDefinition
(RootBeanDefinition rbd) RootBeanDefinition.getResolvedFactoryMethod()
Return the resolved factory method as a Java Method object, if available.AbstractBeanDefinition.getResource()
Return the resource that this bean definition came from.AbstractBeanDefinition.getResourceDescription()
Return a description of the resource that this bean definition came from (for the purpose of showing context in case of errors).AbstractBeanDefinitionReader.getResourceLoader()
BeanDefinitionReader.getResourceLoader()
Return theResourceLoader
to use for resource locations.protected ResolvableType
GenericTypeAwareAutowireCandidateResolver.getReturnTypeForFactoryMethod
(RootBeanDefinition rbd, DependencyDescriptor descriptor) AbstractBeanDefinition.getScope()
Return the name of the target scope for the bean.DefaultListableBeanFactory.getSerializationId()
Return an id for serialization purposes, if specified, allowing this BeanFactory to be deserialized from this id back into the BeanFactory object, if needed.DefaultSingletonBeanRegistry.getSingleton
(String beanName) protected Object
DefaultSingletonBeanRegistry.getSingleton
(String beanName, boolean allowEarlyReference) Return the (raw) singleton object registered under the given name.ManagedList.getSource()
ManagedMap.getSource()
ManagedProperties.getSource()
ManagedSet.getSource()
MethodOverride.getSource()
default Object
AutowireCandidateResolver.getSuggestedValue
(DependencyDescriptor descriptor) Determine whether a default value is suggested for the given dependency.SimpleAutowireCandidateResolver.getSuggestedValue
(DependencyDescriptor descriptor) Class<?>
RootBeanDefinition.getTargetType()
Return the target type of this bean definition, if known (either specified in advance or resolved on first instantiation).AbstractBeanFactory.getTempClassLoader()
Class<?>
Class<?>
protected Class<?>
FactoryBeanRegistrySupport.getTypeForFactoryBean
(FactoryBean<?> factoryBean) Determine the type for the given FactoryBean.protected Class<?>
AbstractAutowireCapableBeanFactory.getTypeForFactoryMethod
(String beanName, RootBeanDefinition mbd, Class<?>... typesToMatch) Determine the target type for the given bean definition which is based on a factory method.ManagedMap.getValueTypeName()
Return the default value type name (class name) to be used for this map.protected Object
AbstractAutowireCapableBeanFactory.obtainInstanceFromSupplier
(Supplier<?> supplier, String beanName, RootBeanDefinition mbd) Obtain a bean instance from the given supplier.protected Object
DefaultListableBeanFactory.obtainInstanceFromSupplier
(Supplier<?> supplier, String beanName, RootBeanDefinition mbd) protected Class<?>
AbstractAutowireCapableBeanFactory.predictBeanType
(String beanName, RootBeanDefinition mbd, Class<?>... typesToMatch) protected Class<?>
AbstractBeanFactory.predictBeanType
(String beanName, RootBeanDefinition mbd, Class<?>... typesToMatch) Predict the eventual bean type (of the processed bean instance) for the specified bean.RegisteredBean.resolveAutowiredArgument
(DependencyDescriptor descriptor, TypeConverter typeConverter, Set<String> autowiredBeanNames) Resolve an autowired argument.Class<?>
AbstractBeanDefinition.resolveBeanClass
(ClassLoader classLoader) Determine the class of the wrapped bean, resolving it from a specified class name if necessary.protected Class<?>
AbstractBeanFactory.resolveBeanClass
(RootBeanDefinition mbd, String beanName, Class<?>... typesToMatch) Resolve the bean class for the specified bean definition, resolving a bean class name into a Class reference (if necessary) and storing the resolved Class in the bean definition for further use.protected Object
AbstractAutowireCapableBeanFactory.resolveBeforeInstantiation
(String beanName, RootBeanDefinition mbd) Apply before-instantiation post-processors, resolving whether there is a before-instantiation shortcut for the specified bean.AbstractAutowireCapableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName) DefaultListableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) AbstractBeanFactory.resolveEmbeddedValue
(String value) protected Class<?>
BeanDefinitionValueResolver.resolveTargetType
(TypedStringValue value) Resolve the target type in the given TypedStringValue.BeanDefinitionValueResolver.resolveValueIfNecessary
(Object argName, Object value) Given a PropertyValue, return a value, resolving any references to other beans in the factory if necessary.Modifier and TypeMethodDescriptionBeanDefinitionBuilder.addConstructorArgValue
(Object value) Add an indexed constructor arg value.void
MethodOverrides.addOverrides
(MethodOverrides other) Copy all given method overrides into this object.BeanDefinitionBuilder.addPropertyValue
(String name, Object value) Add the supplied property value under the given property name.protected BeanWrapper
AbstractAutowireCapableBeanFactory.autowireConstructor
(String beanName, RootBeanDefinition mbd, Constructor<?>[] ctors, Object[] explicitArgs) "autowire constructor" (with constructor arguments by type) behavior.protected BeanWrapper
AbstractAutowireCapableBeanFactory.autowireConstructor
(String beanName, RootBeanDefinition mbd, Constructor<?>[] ctors, Object[] explicitArgs) "autowire constructor" (with constructor arguments by type) behavior.protected void
AbstractAutowireCapableBeanFactory.checkDependencies
(String beanName, AbstractBeanDefinition mbd, PropertyDescriptor[] pds, PropertyValues pvs) Perform a dependency check that all properties exposed have been set, if desired.protected void
AbstractBeanFactory.checkMergedBeanDefinition
(RootBeanDefinition mbd, String beanName, Object[] args) Check the given merged bean definition, potentially throwing validation exceptions.protected Object
AbstractAutowireCapableBeanFactory.createBean
(String beanName, RootBeanDefinition mbd, Object[] args) Central method of this class: creates a bean instance, populates the bean instance, applies post-processors, etc.protected abstract Object
AbstractBeanFactory.createBean
(String beanName, RootBeanDefinition mbd, Object[] args) Create a bean instance for the given merged bean definition (and arguments).static AbstractBeanDefinition
BeanDefinitionReaderUtils.createBeanDefinition
(String parentName, String className, ClassLoader classLoader) Create a new GenericBeanDefinition for the given parent name and class name, eagerly loading the bean class if a ClassLoader has been specified.static AbstractBeanDefinition
BeanDefinitionReaderUtils.createBeanDefinition
(String parentName, String className, ClassLoader classLoader) Create a new GenericBeanDefinition for the given parent name and class name, eagerly loading the bean class if a ClassLoader has been specified.static AbstractBeanDefinition
BeanDefinitionReaderUtils.createBeanDefinition
(String parentName, String className, ClassLoader classLoader) Create a new GenericBeanDefinition for the given parent name and class name, eagerly loading the bean class if a ClassLoader has been specified.protected BeanWrapper
AbstractAutowireCapableBeanFactory.createBeanInstance
(String beanName, RootBeanDefinition mbd, Object[] args) Create a new instance for the specified bean, using an appropriate instantiation strategy: factory method, constructor autowiring, or simple instantiation.protected void
DefaultSingletonBeanRegistry.destroyBean
(String beanName, DisposableBean bean) Destroy the given bean.protected Constructor<?>[]
AbstractAutowireCapableBeanFactory.determineConstructorsFromBeanPostProcessors
(Class<?> beanClass, String beanName) Determine candidate constructors to use for the given bean, checking all registeredSmartInstantiationAwareBeanPostProcessors
.protected Object
AbstractAutowireCapableBeanFactory.doCreateBean
(String beanName, RootBeanDefinition mbd, Object[] args) Actually create the specified bean.protected <T> T
AbstractBeanFactory.doGetBean
(String name, Class<T> requiredType, Object[] args, boolean typeCheckOnly) Return an instance, which may be shared or independent, of the specified bean.protected <T> T
AbstractBeanFactory.doGetBean
(String name, Class<T> requiredType, Object[] args, boolean typeCheckOnly) Return an instance, which may be shared or independent, of the specified bean.DefaultListableBeanFactory.doResolveDependency
(DependencyDescriptor descriptor, String beanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) DefaultListableBeanFactory.doResolveDependency
(DependencyDescriptor descriptor, String beanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) DefaultListableBeanFactory.doResolveDependency
(DependencyDescriptor descriptor, String beanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
protected Object
Evaluate the given value as an expression, if necessary.protected Object
AbstractBeanFactory.evaluateBeanDefinitionString
(String value, BeanDefinition beanDefinition) Evaluate the given String as contained in a bean definition, potentially resolving it as an expression.protected Object
AbstractBeanFactory.evaluateBeanDefinitionString
(String value, BeanDefinition beanDefinition) Evaluate the given String as contained in a bean definition, potentially resolving it as an expression.DefaultListableBeanFactory.findAutowireCandidates
(String beanName, Class<?> requiredType, DependencyDescriptor descriptor) Find bean instances that match the required type.Class<?>
CglibSubclassingInstantiationStrategy.getActualBeanClass
(RootBeanDefinition bd, String beanName, BeanFactory owner) default Class<?>
InstantiationStrategy.getActualBeanClass
(RootBeanDefinition bd, String beanName, BeanFactory owner) Determine the actual class for the given bean definition, as instantiated at runtime.<T> T
Return an instance, which may be shared or independent, of the specified bean.<T> T
Return an instance, which may be shared or independent, of the specified bean.<T> T
<T> T
String[]
DefaultListableBeanFactory.getBeanNamesForType
(Class<?> type) String[]
DefaultListableBeanFactory.getBeanNamesForType
(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) String[]
StaticListableBeanFactory.getBeanNamesForType
(Class<?> type) String[]
StaticListableBeanFactory.getBeanNamesForType
(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) String[]
StaticListableBeanFactory.getBeanNamesForType
(ResolvableType type) String[]
StaticListableBeanFactory.getBeanNamesForType
(ResolvableType type, boolean includeNonSingletons, boolean allowEagerInit) DefaultListableBeanFactory.getBeansOfType
(Class<T> type) DefaultListableBeanFactory.getBeansOfType
(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) StaticListableBeanFactory.getBeansOfType
(Class<T> type) StaticListableBeanFactory.getBeansOfType
(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) default Class<?>
AutowireCandidateResolver.getLazyResolutionProxyClass
(DependencyDescriptor descriptor, String beanName) Determine the proxy class for lazy resolution of the dependency target, if demanded by the injection point.Class<?>
SimpleAutowireCandidateResolver.getLazyResolutionProxyClass
(DependencyDescriptor descriptor, String beanName) default Object
AutowireCandidateResolver.getLazyResolutionProxyIfNecessary
(DependencyDescriptor descriptor, String beanName) Build a proxy for lazy resolution of the actual dependency target, if demanded by the injection point.SimpleAutowireCandidateResolver.getLazyResolutionProxyIfNecessary
(DependencyDescriptor descriptor, String beanName) protected RootBeanDefinition
AbstractBeanFactory.getMergedBeanDefinition
(String beanName, BeanDefinition bd, BeanDefinition containingBd) Return a RootBeanDefinition for the given bean, by merging with the parent if the given bean's definition is a child bean definition.protected Object
AbstractAutowireCapableBeanFactory.getObjectForBeanInstance
(Object beanInstance, String name, String beanName, RootBeanDefinition mbd) Overridden in order to implicitly register the currently created bean as dependent on further beans getting programmatically retrieved during aSupplier
callback.protected Object
AbstractBeanFactory.getObjectForBeanInstance
(Object beanInstance, String name, String beanName, RootBeanDefinition mbd) Get the object for the given bean instance, either the bean instance itself or its created object in case of a FactoryBean.protected Object
AbstractAutowireCapableBeanFactory.initializeBean
(String beanName, Object bean, RootBeanDefinition mbd) Initialize the given bean instance, applying factory callbacks as well as init methods and bean post processors.InstantiationStrategy.instantiate
(RootBeanDefinition bd, String beanName, BeanFactory owner) Return an instance of the bean with the given name in this factory.InstantiationStrategy.instantiate
(RootBeanDefinition bd, String beanName, BeanFactory owner, Object factoryBean, Method factoryMethod, Object... args) Return an instance of the bean with the given name in this factory, creating it via the given factory method.InstantiationStrategy.instantiate
(RootBeanDefinition bd, String beanName, BeanFactory owner, Object factoryBean, Method factoryMethod, Object... args) Return an instance of the bean with the given name in this factory, creating it via the given factory method.InstantiationStrategy.instantiate
(RootBeanDefinition bd, String beanName, BeanFactory owner, Constructor<?> ctor, Object... args) Return an instance of the bean with the given name in this factory, creating it via the given constructor.SimpleInstantiationStrategy.instantiate
(RootBeanDefinition bd, String beanName, BeanFactory owner) SimpleInstantiationStrategy.instantiate
(RootBeanDefinition bd, String beanName, BeanFactory owner, Object factoryBean, Method factoryMethod, Object... args) SimpleInstantiationStrategy.instantiate
(RootBeanDefinition bd, String beanName, BeanFactory owner, Object factoryBean, Method factoryMethod, Object... args) SimpleInstantiationStrategy.instantiate
(RootBeanDefinition bd, String beanName, BeanFactory owner, Constructor<?> ctor, Object... args) protected BeanWrapper
AbstractAutowireCapableBeanFactory.instantiateUsingFactoryMethod
(String beanName, RootBeanDefinition mbd, Object[] explicitArgs) Instantiate the bean using a named factory method.protected Object
CglibSubclassingInstantiationStrategy.instantiateWithMethodInjection
(RootBeanDefinition bd, String beanName, BeanFactory owner) protected Object
CglibSubclassingInstantiationStrategy.instantiateWithMethodInjection
(RootBeanDefinition bd, String beanName, BeanFactory owner, Constructor<?> ctor, Object... args) protected Object
CglibSubclassingInstantiationStrategy.instantiateWithMethodInjection
(RootBeanDefinition bd, String beanName, BeanFactory owner, Constructor<?> ctor, Object... args) protected Object
SimpleInstantiationStrategy.instantiateWithMethodInjection
(RootBeanDefinition bd, String beanName, BeanFactory owner) Subclasses can override this method, which is implemented to throw UnsupportedOperationException, if they can instantiate an object with the Method Injection specified in the given RootBeanDefinition.protected Object
SimpleInstantiationStrategy.instantiateWithMethodInjection
(RootBeanDefinition bd, String beanName, BeanFactory owner, Constructor<?> ctor, Object... args) Subclasses can override this method, which is implemented to throw UnsupportedOperationException, if they can instantiate an object with the Method Injection specified in the given RootBeanDefinition.protected Object
SimpleInstantiationStrategy.instantiateWithMethodInjection
(RootBeanDefinition bd, String beanName, BeanFactory owner, Constructor<?> ctor, Object... args) Subclasses can override this method, which is implemented to throw UnsupportedOperationException, if they can instantiate an object with the Method Injection specified in the given RootBeanDefinition.protected void
AbstractAutowireCapableBeanFactory.invokeInitMethods
(String beanName, Object bean, RootBeanDefinition mbd) Give a bean a chance to initialize itself after all its properties are set, and a chance to know about its owning bean factory (this object).boolean
DefaultSingletonBeanRegistry.isSingletonCurrentlyInCreation
(String beanName) Return whether the specified singleton bean is currently in creation (within the entire factory).boolean
StaticListableBeanFactory.isTypeMatch
(String name, Class<?> typeToMatch) int
AbstractBeanDefinitionReader.loadBeanDefinitions
(String location, Set<Resource> actualResources) Load bean definitions from the specified resource location.int
PropertiesBeanDefinitionReader.loadBeanDefinitions
(Resource resource, String prefix) Deprecated.Load bean definitions from the specified properties file.int
PropertiesBeanDefinitionReader.loadBeanDefinitions
(EncodedResource encodedResource, String prefix) Deprecated.Load bean definitions from the specified properties file.protected boolean
DefaultListableBeanFactory.matchesBeanName
(String beanName, String candidateName) Determine whether the given candidate name matches the bean name or the aliases stored in this bean definition.static RegisteredBean
RegisteredBean.ofInnerBean
(RegisteredBean parent, String innerBeanName, BeanDefinition innerBeanDefinition) Create a newRegisteredBean
instance for an inner-bean.protected void
AbstractAutowireCapableBeanFactory.populateBean
(String beanName, RootBeanDefinition mbd, BeanWrapper bw) Populate the bean instance in the given BeanWrapper with the property values from the bean definition.int
PropertiesBeanDefinitionReader.registerBeanDefinitions
(Map<?, ?> map, String prefix) Deprecated.Register bean definitions contained in a Map.int
PropertiesBeanDefinitionReader.registerBeanDefinitions
(Map<?, ?> map, String prefix, String resourceDescription) Deprecated.Register bean definitions contained in a Map.int
PropertiesBeanDefinitionReader.registerBeanDefinitions
(ResourceBundle rb, String prefix) Deprecated.Register bean definitions contained in a ResourceBundle.void
DefaultListableBeanFactory.registerResolvableDependency
(Class<?> dependencyType, Object autowiredValue) Class<?>
AbstractBeanDefinition.resolveBeanClass
(ClassLoader classLoader) Determine the class of the wrapped bean, resolving it from a specified class name if necessary.AbstractAutowireCapableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName) DefaultListableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) DefaultListableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) DefaultListableBeanFactory.resolveDependency
(DependencyDescriptor descriptor, String requestingBeanName, Set<String> autowiredBeanNames, TypeConverter typeConverter) AbstractBeanFactory.resolveEmbeddedValue
(String value) <T> T
BeanDefinitionValueResolver.resolveInnerBean
(String innerBeanName, BeanDefinition innerBd, BiFunction<String, RootBeanDefinition, T> resolver) Resolve an inner bean definition and invoke the specifiedresolver
on its merged bean definition.BeanDefinitionValueResolver.resolveValueIfNecessary
(Object argName, Object value) Given a PropertyValue, return a value, resolving any references to other beans in the factory if necessary.static BeanDefinitionBuilder
BeanDefinitionBuilder.rootBeanDefinition
(Class<?> beanClass, String factoryMethodName) Create a newBeanDefinitionBuilder
used to construct aRootBeanDefinition
.static BeanDefinitionBuilder
BeanDefinitionBuilder.rootBeanDefinition
(String beanClassName, String factoryMethodName) Create a newBeanDefinitionBuilder
used to construct aRootBeanDefinition
.void
AbstractBeanDefinition.setBeanClass
(Class<?> beanClass) Specify the class for this bean.void
AbstractBeanDefinitionReader.setBeanClassLoader
(ClassLoader beanClassLoader) Set the ClassLoader to use for bean classes.void
AbstractBeanFactory.setBeanClassLoader
(ClassLoader beanClassLoader) void
AbstractBeanDefinition.setBeanClassName
(String beanClassName) Specify the bean class name of this bean definition.void
AbstractBeanFactory.setBeanExpressionResolver
(BeanExpressionResolver resolver) void
AbstractBeanDefinitionReader.setBeanNameGenerator
(BeanNameGenerator beanNameGenerator) Set the BeanNameGenerator to use for anonymous beans (without explicit bean name specified).void
AbstractBeanFactory.setConversionService
(ConversionService conversionService) static void
SimpleInstantiationStrategy.setCurrentlyInvokedFactoryMethod
(Method method) Set the factory method currently being invoked ornull
to reset.void
RootBeanDefinition.setDecoratedDefinition
(BeanDefinitionHolder decoratedDefinition) Register a target definition that is being decorated by this bean definition.void
PropertiesBeanDefinitionReader.setDefaultParentBean
(String defaultParentBean) Deprecated.Set the default parent bean for this bean factory.void
DefaultListableBeanFactory.setDependencyComparator
(Comparator<Object> dependencyComparator) Set aComparator
for dependency Lists and arrays.void
AbstractBeanDefinition.setDependsOn
(String... dependsOn) Set the names of the beans that this bean depends on being initialized.void
AbstractBeanDefinition.setDescription
(String description) Set a human-readable description of this bean definition.void
AbstractBeanDefinition.setDestroyMethodName
(String destroyMethodName) Set the name of the destroy method.BeanDefinitionBuilder.setDestroyMethodName
(String methodName) Set the destroy method for this definition.void
BeanDefinitionDefaults.setDestroyMethodName
(String destroyMethodName) Set the name of the default destroy method.void
AbstractBeanDefinition.setDestroyMethodNames
(String... destroyMethodNames) Specify the names of multiple destroy methods.void
ManagedSet.setElementTypeName
(String elementTypeName) Set the default element type name (class name) to be used for this set.void
AbstractBeanDefinition.setFactoryBeanName
(String factoryBeanName) Specify the factory bean to use, if any.void
AbstractBeanDefinition.setFactoryMethodName
(String factoryMethodName) Specify a factory method, if any.void
AbstractBeanDefinition.setInitMethodName
(String initMethodName) Set the name of the initializer method.BeanDefinitionBuilder.setInitMethodName
(String methodName) Set the init method for this definition.void
BeanDefinitionDefaults.setInitMethodName
(String initMethodName) Set the name of the default initializer method.void
AbstractBeanDefinition.setInitMethodNames
(String... initMethodNames) Specify the names of multiple initializer methods.void
AbstractBeanDefinition.setInstanceSupplier
(Supplier<?> instanceSupplier) Specify a callback for creating an instance of the bean, as an alternative to a declaratively specified factory method.void
RootBeanDefinition.setInstanceSupplier
(Supplier<?> supplier) void
ManagedMap.setKeyTypeName
(String keyTypeName) Set the default key type name (class name) to be used for this map.void
AbstractAutowireCapableBeanFactory.setParameterNameDiscoverer
(ParameterNameDiscoverer parameterNameDiscoverer) Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (e.g.void
AbstractBeanFactory.setParentBeanFactory
(BeanFactory parentBeanFactory) void
ChildBeanDefinition.setParentName
(String parentName) void
GenericBeanDefinition.setParentName
(String parentName) void
RootBeanDefinition.setParentName
(String parentName) void
PropertiesBeanDefinitionReader.setPropertiesPersister
(PropertiesPersister propertiesPersister) Deprecated.Set the PropertiesPersister to use for parsing properties files.void
RootBeanDefinition.setQualifiedElement
(AnnotatedElement qualifiedElement) Specify theAnnotatedElement
defining qualifiers, to be used instead of the target class or factory method.void
RootBeanDefinition.setResolvedFactoryMethod
(Method method) Set a resolved Java Method for the factory method on this bean definition.void
AbstractBeanDefinition.setResource
(Resource resource) Set the resource that this bean definition came from (for the purpose of showing context in case of errors).void
AbstractBeanDefinition.setResourceDescription
(String resourceDescription) Set a description of the resource that this bean definition came from (for the purpose of showing context in case of errors).void
AbstractBeanDefinitionReader.setResourceLoader
(ResourceLoader resourceLoader) Set the ResourceLoader to use for resource locations.void
Set the name of the target scope for the bean.Set the scope of this definition.void
DefaultListableBeanFactory.setSerializationId
(String serializationId) Specify an id for serialization purposes, allowing this BeanFactory to be deserialized from this id back into the BeanFactory object, if needed.void
Set the configuration sourceObject
for this metadata element.void
Set the configuration sourceObject
for this metadata element.void
Set the configuration sourceObject
for this metadata element.void
Set the configuration sourceObject
for this metadata element.void
Set the configuration sourceObject
for this metadata element.void
RootBeanDefinition.setTargetType
(Class<?> targetType) Specify the target type of this bean definition, if known in advance.void
RootBeanDefinition.setTargetType
(ResolvableType targetType) Specify a generics-containing target type of this bean definition, if known in advance.void
AbstractBeanFactory.setTempClassLoader
(ClassLoader tempClassLoader) void
ManagedMap.setValueTypeName
(String valueTypeName) Set the default value type name (class name) to be used for this map.static <T> InstanceSupplier<T>
InstanceSupplier.using
(Method factoryMethod, ThrowingSupplier<T> supplier) Factory method to create anInstanceSupplier
from aThrowingSupplier
.ModifierConstructorDescriptionAbstractAutowireCapableBeanFactory
(BeanFactory parentBeanFactory) Create a new AbstractAutowireCapableBeanFactory with the given parent.protected
Create a new AbstractBeanDefinition with the given constructor argument values and property values.protected
Create a new AbstractBeanDefinition with the given constructor argument values and property values.AbstractBeanFactory
(BeanFactory parentBeanFactory) Create a new AbstractBeanFactory with the given parent.DefaultListableBeanFactory
(BeanFactory parentBeanFactory) Create a new DefaultListableBeanFactory with the given parent.LookupOverride
(Method method, String beanName) Construct a new LookupOverride.LookupOverride
(String methodName, String beanName) Construct a new LookupOverride.RootBeanDefinition
(Class<?> beanClass) Create a new RootBeanDefinition for a singleton.RootBeanDefinition
(Class<?> beanClass, int autowireMode, boolean dependencyCheck) Create a new RootBeanDefinition for a singleton, using the given autowire mode.RootBeanDefinition
(Class<?> beanClass, ConstructorArgumentValues cargs, MutablePropertyValues pvs) Create a new RootBeanDefinition for a singleton, providing constructor arguments and property values.RootBeanDefinition
(Class<?> beanClass, ConstructorArgumentValues cargs, MutablePropertyValues pvs) Create a new RootBeanDefinition for a singleton, providing constructor arguments and property values.RootBeanDefinition
(Class<?> beanClass, ConstructorArgumentValues cargs, MutablePropertyValues pvs) Create a new RootBeanDefinition for a singleton, providing constructor arguments and property values.RootBeanDefinition
(Class<T> beanClass, String scope, Supplier<T> instanceSupplier) Create a new RootBeanDefinition for a scoped bean, constructing each instance through calling the given supplier (possibly a lambda or method reference).RootBeanDefinition
(Class<T> beanClass, String scope, Supplier<T> instanceSupplier) Create a new RootBeanDefinition for a scoped bean, constructing each instance through calling the given supplier (possibly a lambda or method reference).RootBeanDefinition
(Class<T> beanClass, Supplier<T> instanceSupplier) Create a new RootBeanDefinition for a singleton bean, constructing each instance through calling the given supplier (possibly a lambda or method reference).RootBeanDefinition
(Class<T> beanClass, Supplier<T> instanceSupplier) Create a new RootBeanDefinition for a singleton bean, constructing each instance through calling the given supplier (possibly a lambda or method reference).RootBeanDefinition
(ResolvableType beanType) Deprecated. -
Uses of Nullable in org.springframework.beans.factory.wiring
Modifier and TypeMethodDescriptionprotected BeanWiringInfoResolver
BeanConfigurerSupport.createDefaultBeanWiringInfoResolver()
Create the default BeanWiringInfoResolver to be used if none was specified explicitly.BeanWiringInfo.getBeanName()
Return the specific bean name that this BeanWiringInfo points to, if any.BeanWiringInfoResolver.resolveWiringInfo
(Object beanInstance) Resolve the BeanWiringInfo for the given bean instance. -
Uses of Nullable in org.springframework.beans.factory.xml
Modifier and TypeMethodDescriptionNamespaceHandler.decorate
(Node source, BeanDefinitionHolder definition, ParserContext parserContext) Parse the specifiedNode
and decorate the suppliedBeanDefinitionHolder
, returning the decorated definition.NamespaceHandlerSupport.decorate
(Node node, BeanDefinitionHolder definition, ParserContext parserContext) Decorates the suppliedNode
by delegating to theBeanDefinitionDecorator
that is registered to handle thatNode
.protected Object
BeanDefinitionParserDelegate.extractSource
(Element ele) Invoke theSourceExtractor
to pull the source metadata from the suppliedElement
.protected Object
DefaultBeanDefinitionDocumentReader.extractSource
(Element ele) Invoke theSourceExtractor
to pull the source metadata from the suppliedElement
.ParserContext.extractSource
(Object sourceCandidate) DocumentDefaultsDefinition.getAutowire()
Return the default autowire setting for the document that's currently parsed.String[]
BeanDefinitionParserDelegate.getAutowireCandidatePatterns()
Return any patterns provided in the 'default-autowire-candidates' attribute of the top-level<beans/>
element.DocumentDefaultsDefinition.getAutowireCandidates()
Return the default autowire-candidate pattern for the document that's currently parsed.protected Class<?>
AbstractSingleBeanDefinitionParser.getBeanClass
(Element element) Determine the bean class corresponding to the suppliedElement
.final ClassLoader
XmlReaderContext.getBeanClassLoader()
Return the bean class loader to use, if any.protected String
AbstractSingleBeanDefinitionParser.getBeanClassName
(Element element) Determine the bean class name corresponding to the suppliedElement
.ParserContext.getContainingBeanDefinition()
ParserContext.getContainingComponent()
DocumentDefaultsDefinition.getDestroyMethod()
Return the default destroy-method setting for the document that's currently parsed.DocumentDefaultsDefinition.getInitMethod()
Return the default init-method setting for the document that's currently parsed.DocumentDefaultsDefinition.getLazyInit()
Return the default lazy-init flag for the document that's currently parsed.DocumentDefaultsDefinition.getMerge()
Return the default merge setting for the document that's currently parsed.BeanDefinitionParserDelegate.getNamespaceURI
(Node node) Get the namespace URI for the supplied node.protected String
AbstractSingleBeanDefinitionParser.getParentName
(Element element) Determine the name for the parent of the currently parsed bean, in case of the current bean being defined as a child bean.final ResourceLoader
XmlReaderContext.getResourceLoader()
Return the resource loader to use, if any.DocumentDefaultsDefinition.getSource()
final BeanDefinition
AbstractBeanDefinitionParser.parse
(Element element, ParserContext parserContext) BeanDefinitionParser.parse
(Element element, ParserContext parserContext) Parse the specifiedElement
and register the resultingBeanDefinition(s)
with theBeanDefinitionRegistry
embedded in the suppliedParserContext
.NamespaceHandler.parse
(Element element, ParserContext parserContext) Parse the specifiedElement
and register any resultingBeanDefinitions
with theBeanDefinitionRegistry
that is embedded in the suppliedParserContext
.NamespaceHandlerSupport.parse
(Element element, ParserContext parserContext) Parses the suppliedElement
by delegating to theBeanDefinitionParser
that is registered for thatElement
.SimpleConstructorNamespaceHandler.parse
(Element element, ParserContext parserContext) SimplePropertyNamespaceHandler.parse
(Element element, ParserContext parserContext) BeanDefinitionParserDelegate.parseBeanDefinitionElement
(Element ele) Parses the supplied<bean>
element.BeanDefinitionParserDelegate.parseBeanDefinitionElement
(Element ele, String beanName, BeanDefinition containingBean) Parse the bean definition itself, without regard to name or aliases.BeanDefinitionParserDelegate.parseBeanDefinitionElement
(Element ele, BeanDefinition containingBean) Parses the supplied<bean>
element.BeanDefinitionParserDelegate.parseCustomElement
(Element ele) Parse a custom element (outside the default namespace).BeanDefinitionParserDelegate.parseCustomElement
(Element ele, BeanDefinition containingBd) Parse a custom element (outside the default namespace).BeanDefinitionParserDelegate.parseIdRefElement
(Element ele) Return a typed String value Object for the given 'idref' element.protected abstract AbstractBeanDefinition
AbstractBeanDefinitionParser.parseInternal
(Element element, ParserContext parserContext) Central template method to actually parse the suppliedElement
into one or moreBeanDefinitions
.protected Object
BeanDefinitionParserDelegate.parseKeyElement
(Element keyEle, BeanDefinition bd, String defaultKeyTypeName) Parse a key sub-element of a map element.BeanDefinitionParserDelegate.parsePropertySubElement
(Element ele, BeanDefinition bd) Parse a value, ref or collection sub-element of a property or constructor-arg element.BeanDefinitionParserDelegate.parsePropertySubElement
(Element ele, BeanDefinition bd, String defaultValueType) Parse a value, ref or collection sub-element of a property or constructor-arg element.BeanDefinitionParserDelegate.parsePropertyValue
(Element ele, BeanDefinition bd, String propertyName) Get the value of a property element.Locate theNamespaceHandler
for the supplied namespace URI from the configured mappings.Resolve the namespace URI and return the locatedNamespaceHandler
implementation.BeansDtdResolver.resolveEntity
(String publicId, String systemId) DelegatingEntityResolver.resolveEntity
(String publicId, String systemId) PluggableSchemaResolver.resolveEntity
(String publicId, String systemId) ResourceEntityResolver.resolveEntity
(String publicId, String systemId) protected InputSource
ResourceEntityResolver.resolveSchemaEntity
(String publicId, String systemId) A fallback method forResourceEntityResolver.resolveEntity(String, String)
that is used when a "schema" entity (DTD or XSD) cannot be resolved as a local resource.Modifier and TypeMethodDescriptionprotected TypedStringValue
BeanDefinitionParserDelegate.buildTypedStringValue
(String value, String targetTypeName) Build a typed String value Object for the given raw value.protected AbstractBeanDefinition
BeanDefinitionParserDelegate.createBeanDefinition
(String className, String parentName) Create a bean definition for the given class name and parent name.protected AbstractBeanDefinition
BeanDefinitionParserDelegate.createBeanDefinition
(String className, String parentName) Create a bean definition for the given class name and parent name.protected BeanDefinitionParserDelegate
DefaultBeanDefinitionDocumentReader.createDelegate
(XmlReaderContext readerContext, Element root, BeanDefinitionParserDelegate parentDelegate) protected DocumentBuilder
DefaultDocumentLoader.createDocumentBuilder
(DocumentBuilderFactory factory, EntityResolver entityResolver, ErrorHandler errorHandler) Create a JAXP DocumentBuilder that this bean definition reader will use for parsing XML documents.protected DocumentBuilder
DefaultDocumentLoader.createDocumentBuilder
(DocumentBuilderFactory factory, EntityResolver entityResolver, ErrorHandler errorHandler) Create a JAXP DocumentBuilder that this bean definition reader will use for parsing XML documents.BeanDefinitionParserDelegate.decorateBeanDefinitionIfRequired
(Element ele, BeanDefinitionHolder originalDef, BeanDefinition containingBd) Decorate the given bean definition through a namespace handler, if applicable.BeanDefinitionParserDelegate.decorateIfRequired
(Node node, BeanDefinitionHolder originalDef, BeanDefinition containingBd) Decorate the given bean definition through a namespace handler, if applicable.void
BeanDefinitionParserDelegate.initDefaults
(Element root, BeanDefinitionParserDelegate parent) Initialize the default lazy-init, autowire, dependency check settings, init-method, destroy-method and merge settings.boolean
BeanDefinitionParserDelegate.isDefaultNamespace
(String namespaceUri) Determine whether the given URI indicates the default namespace.int
XmlBeanDefinitionReader.loadBeanDefinitions
(InputSource inputSource, String resourceDescription) Load bean definitions from the specified XML file.BeanDefinitionParserDelegate.parseArrayElement
(Element arrayEle, BeanDefinition bd) Parse an array element.BeanDefinitionParserDelegate.parseBeanDefinitionAttributes
(Element ele, String beanName, BeanDefinition containingBean, AbstractBeanDefinition bd) Apply the attributes of the given bean element to the given bean * definition.BeanDefinitionParserDelegate.parseBeanDefinitionElement
(Element ele, String beanName, BeanDefinition containingBean) Parse the bean definition itself, without regard to name or aliases.BeanDefinitionParserDelegate.parseBeanDefinitionElement
(Element ele, BeanDefinition containingBean) Parses the supplied<bean>
element.protected void
BeanDefinitionParserDelegate.parseCollectionElements
(NodeList elementNodes, Collection<Object> target, BeanDefinition bd, String defaultElementType) BeanDefinitionParserDelegate.parseCustomElement
(Element ele, BeanDefinition containingBd) Parse a custom element (outside the default namespace).protected Object
BeanDefinitionParserDelegate.parseKeyElement
(Element keyEle, BeanDefinition bd, String defaultKeyTypeName) Parse a key sub-element of a map element.BeanDefinitionParserDelegate.parseListElement
(Element collectionEle, BeanDefinition bd) Parse a list element.BeanDefinitionParserDelegate.parseMapElement
(Element mapEle, BeanDefinition bd) Parse a map element.BeanDefinitionParserDelegate.parsePropertySubElement
(Element ele, BeanDefinition bd) Parse a value, ref or collection sub-element of a property or constructor-arg element.BeanDefinitionParserDelegate.parsePropertySubElement
(Element ele, BeanDefinition bd, String defaultValueType) Parse a value, ref or collection sub-element of a property or constructor-arg element.BeanDefinitionParserDelegate.parsePropertySubElement
(Element ele, BeanDefinition bd, String defaultValueType) Parse a value, ref or collection sub-element of a property or constructor-arg element.BeanDefinitionParserDelegate.parsePropertyValue
(Element ele, BeanDefinition bd, String propertyName) Get the value of a property element.BeanDefinitionParserDelegate.parseSetElement
(Element collectionEle, BeanDefinition bd) Parse a set element.BeanDefinitionParserDelegate.parseValueElement
(Element ele, String defaultTypeName) Return a typed String value Object for the given value element.protected void
BeanDefinitionParserDelegate.populateDefaults
(DocumentDefaultsDefinition defaults, DocumentDefaultsDefinition parentDefaults, Element root) Populate the given DocumentDefaultsDefinition instance with the default lazy-init, autowire, dependency check settings, init-method, destroy-method and merge settings.BeansDtdResolver.resolveEntity
(String publicId, String systemId) BeansDtdResolver.resolveEntity
(String publicId, String systemId) DelegatingEntityResolver.resolveEntity
(String publicId, String systemId) DelegatingEntityResolver.resolveEntity
(String publicId, String systemId) PluggableSchemaResolver.resolveEntity
(String publicId, String systemId) PluggableSchemaResolver.resolveEntity
(String publicId, String systemId) ResourceEntityResolver.resolveEntity
(String publicId, String systemId) ResourceEntityResolver.resolveEntity
(String publicId, String systemId) protected InputSource
ResourceEntityResolver.resolveSchemaEntity
(String publicId, String systemId) A fallback method forResourceEntityResolver.resolveEntity(String, String)
that is used when a "schema" entity (DTD or XSD) cannot be resolved as a local resource.void
DocumentDefaultsDefinition.setAutowire
(String autowire) Set the default autowire setting for the document that's currently parsed.void
DocumentDefaultsDefinition.setAutowireCandidates
(String autowireCandidates) Set the default autowire-candidate pattern for the document that's currently parsed.void
DocumentDefaultsDefinition.setDestroyMethod
(String destroyMethod) Set the default destroy-method setting for the document that's currently parsed.void
XmlBeanDefinitionReader.setDocumentLoader
(DocumentLoader documentLoader) Specify theDocumentLoader
to use.void
XmlBeanDefinitionReader.setEntityResolver
(EntityResolver entityResolver) Set a SAX entity resolver to be used for parsing.void
XmlBeanDefinitionReader.setEventListener
(ReaderEventListener eventListener) Specify whichReaderEventListener
to use.void
DocumentDefaultsDefinition.setInitMethod
(String initMethod) Set the default init-method setting for the document that's currently parsed.void
DocumentDefaultsDefinition.setLazyInit
(String lazyInit) Set the default lazy-init flag for the document that's currently parsed.void
Set the default merge setting for the document that's currently parsed.void
XmlBeanDefinitionReader.setNamespaceHandlerResolver
(NamespaceHandlerResolver namespaceHandlerResolver) Specify theNamespaceHandlerResolver
to use.void
XmlBeanDefinitionReader.setProblemReporter
(ProblemReporter problemReporter) Specify whichProblemReporter
to use.void
Set the configuration sourceObject
for this metadata element.void
XmlBeanDefinitionReader.setSourceExtractor
(SourceExtractor sourceExtractor) Specify theSourceExtractor
to use.ModifierConstructorDescriptionDefaultNamespaceHandlerResolver
(ClassLoader classLoader) Create a newDefaultNamespaceHandlerResolver
using the default mapping file location.DefaultNamespaceHandlerResolver
(ClassLoader classLoader, String handlerMappingsLocation) Create a newDefaultNamespaceHandlerResolver
using the supplied mapping file location.DelegatingEntityResolver
(ClassLoader classLoader) Create a new DelegatingEntityResolver that delegates to a defaultBeansDtdResolver
and a defaultPluggableSchemaResolver
.ParserContext
(XmlReaderContext readerContext, BeanDefinitionParserDelegate delegate, BeanDefinition containingBeanDefinition) PluggableSchemaResolver
(ClassLoader classLoader) Loads the schema URL → schema file location mappings using the default mapping file pattern "META-INF/spring.schemas".PluggableSchemaResolver
(ClassLoader classLoader, String schemaMappingsLocation) Loads the schema URL → schema file location mappings using the given mapping file pattern. -
Uses of Nullable in org.springframework.beans.propertyeditors
Modifier and TypeMethodDescriptionCustomCollectionEditor.getAsText()
This implementation returnsnull
to indicate that there is no appropriate text representation.CustomMapEditor.getAsText()
This implementation returnsnull
to indicate that there is no appropriate text representation.InputStreamEditor.getAsText()
This implementation returnsnull
to indicate that there is no appropriate text representation.ReaderEditor.getAsText()
This implementation returnsnull
to indicate that there is no appropriate text representation.Modifier and TypeMethodDescriptionvoid
void
void
void
void
Parse the Date from the given text, using the specified DateFormat.void
void
ConvertString
intoProperties
, considering it as properties content.void
void
Convert the given value to a Collection of the target type.void
Convert the given value to a Map of the target type.void
Coerce a Number value into the required target class, if necessary.ModifierConstructorDescriptionClassArrayEditor
(ClassLoader classLoader) Create a defaultClassArrayEditor
, using the givenClassLoader
.ClassEditor
(ClassLoader classLoader) Create a default ClassEditor, using the given ClassLoader.CustomBooleanEditor
(String trueString, String falseString, boolean allowEmpty) Create a new CustomBooleanEditor instance, with configurable String values for true and false.CustomBooleanEditor
(String trueString, String falseString, boolean allowEmpty) Create a new CustomBooleanEditor instance, with configurable String values for true and false.CustomNumberEditor
(Class<? extends Number> numberClass, NumberFormat numberFormat, boolean allowEmpty) Create a new CustomNumberEditor instance, using the given NumberFormat for parsing and rendering.StringArrayPropertyEditor
(String separator, String charsToDelete, boolean emptyArrayAsNull) Create a newStringArrayPropertyEditor
with the given separator.StringArrayPropertyEditor
(String separator, String charsToDelete, boolean emptyArrayAsNull, boolean trimValues) Create a newStringArrayPropertyEditor
with the given separator.URIEditor
(ClassLoader classLoader) Create a new URIEditor, using the given ClassLoader to resolve "classpath:" locations into physical resource URLs.URIEditor
(ClassLoader classLoader, boolean encode) Create a new URIEditor, using the given ClassLoader to resolve "classpath:" locations into physical resource URLs. -
Uses of Nullable in org.springframework.beans.support
Modifier and TypeMethodDescriptionprotected Method
ArgumentConvertingMethodInvoker.doFindMatchingMethod
(Object[] arguments) Actually find a method with matching parameter type, i.e.protected Method
ArgumentConvertingMethodInvoker.findMatchingMethod()
This implementation looks for a method with matching parameter types.PagedListHolder.getRefreshDate()
Return the last time the list has been fetched from the source provider.PagedListHolder.getSort()
Return the sort definition for this holder.ArgumentConvertingMethodInvoker.getTypeConverter()
Return the TypeConverter used for argument type conversion.Modifier and TypeMethodDescriptionboolean
void
PagedListHolder.setSort
(SortDefinition sort) Set the sort definition for this holder.void
ArgumentConvertingMethodInvoker.setTypeConverter
(TypeConverter typeConverter) Set a TypeConverter to use for argument type conversion. -
Uses of Nullable in org.springframework.cache
Modifier and TypeMethodDescriptionReturn the value to which this cache maps the specified key.<T> T
Return the value to which this cache maps the specified key, generically specifying a type that return value will be cast to.<T> T
Return the value to which this cache maps the specified key, obtaining that value fromvalueLoader
if necessary.Cache.ValueWrapper.get()
Return the actual value in the cache.Get the cache associated with the given name.Cache.ValueRetrievalException.getKey()
default Cache.ValueWrapper
Cache.putIfAbsent
(Object key, Object value) Atomically associate the specified value with the specified key in this cache if it is not set already.default CompletableFuture<?>
Return the value to which this cache maps the specified key, wrapped in aCompletableFuture
.Modifier and TypeMethodDescription<T> T
Return the value to which this cache maps the specified key, generically specifying a type that return value will be cast to.void
Associate the specified value with the specified key in this cache.default Cache.ValueWrapper
Cache.putIfAbsent
(Object key, Object value) Atomically associate the specified value with the specified key in this cache if it is not set already.ModifierConstructorDescriptionValueRetrievalException
(Object key, Callable<?> loader, Throwable ex) -
Uses of Nullable in org.springframework.cache.annotation
Modifier and TypeFieldDescriptionprotected Supplier<CacheManager>
AbstractCachingConfiguration.cacheManager
protected Supplier<CacheResolver>
AbstractCachingConfiguration.cacheResolver
protected AnnotationAttributes
AbstractCachingConfiguration.enableCaching
protected Supplier<CacheErrorHandler>
AbstractCachingConfiguration.errorHandler
protected Supplier<KeyGenerator>
AbstractCachingConfiguration.keyGenerator
Modifier and TypeMethodDescription<T> Supplier<T>
AbstractCachingConfiguration.CachingConfigurerSupplier.adapt
(Function<CachingConfigurer, T> provider) Adapt theCachingConfigurer
supplier to another supplier provided by the specified mapping function.default CacheManager
CachingConfigurer.cacheManager()
Return the cache manager bean to use for annotation-driven cache management.CachingConfigurerSupport.cacheManager()
Deprecated.default CacheResolver
CachingConfigurer.cacheResolver()
Return theCacheResolver
bean to use to resolve regular caches for annotation-driven cache management.CachingConfigurerSupport.cacheResolver()
Deprecated.protected Collection<CacheOperation>
AnnotationCacheOperationSource.determineCacheOperations
(AnnotationCacheOperationSource.CacheOperationProvider provider) Determine the cache operation(s) for the givenAnnotationCacheOperationSource.CacheOperationProvider
.default CacheErrorHandler
CachingConfigurer.errorHandler()
Return theCacheErrorHandler
to use to handle cache-related errors.CachingConfigurerSupport.errorHandler()
Deprecated.protected Collection<CacheOperation>
AnnotationCacheOperationSource.findCacheOperations
(Class<?> clazz) protected Collection<CacheOperation>
AnnotationCacheOperationSource.findCacheOperations
(Method method) AnnotationCacheOperationSource.CacheOperationProvider.getCacheOperations
(CacheAnnotationParser parser) Return theCacheOperation
instance(s) provided by the specified parser.default KeyGenerator
CachingConfigurer.keyGenerator()
Return the key generator bean to use for annotation-driven cache management.CachingConfigurerSupport.keyGenerator()
Deprecated.CacheAnnotationParser.parseCacheAnnotations
(Class<?> type) Parse the cache definition for the given class, based on an annotation type understood by this parser.CacheAnnotationParser.parseCacheAnnotations
(Method method) Parse the cache definition for the given method, based on an annotation type understood by this parser.SpringCacheAnnotationParser.parseCacheAnnotations
(Class<?> type) SpringCacheAnnotationParser.parseCacheAnnotations
(Method method) -
Uses of Nullable in org.springframework.cache.caffeine
Modifier and TypeMethodDescription<T> T
protected Object
CaffeineCache.putIfAbsent
(Object key, Object value) Modifier and TypeMethodDescriptionvoid
CaffeineCache.putIfAbsent
(Object key, Object value) void
CaffeineCacheManager.setCacheNames
(Collection<String> cacheNames) Specify the set of cache names for this CacheManager's 'static' mode. -
Uses of Nullable in org.springframework.cache.concurrent
Modifier and TypeMethodDescription<T> T
ConcurrentMapCacheFactoryBean.getObject()
protected Object
ConcurrentMapCache.putIfAbsent
(Object key, Object value) Modifier and TypeMethodDescriptionprotected Object
ConcurrentMapCache.fromStoreValue
(Object storeValue) void
ConcurrentMapCache.putIfAbsent
(Object key, Object value) void
ConcurrentMapCacheManager.setCacheNames
(Collection<String> cacheNames) Specify the set of cache names for this CacheManager's 'static' mode.protected Object
ConcurrentMapCache.toStoreValue
(Object userValue) ModifierConstructorDescriptionprotected
ConcurrentMapCache
(String name, ConcurrentMap<Object, Object> store, boolean allowNullValues, SerializationDelegate serialization) Create a new ConcurrentMapCache with the specified name and the given internalConcurrentMap
to use. -
Uses of Nullable in org.springframework.cache.interceptor
Modifier and TypeMethodDescriptionprotected Cache.ValueWrapper
ExecuteCache.get(Object)
on the specifiedCache
and invoke the error handler if an exception occurs.protected Object
CacheAspectSupport.execute
(CacheOperationInvoker invoker, Object target, Method method, Object[] args) protected abstract Collection<CacheOperation>
AbstractFallbackCacheOperationSource.findCacheOperations
(Class<?> clazz) Subclasses need to implement this to return the caching attribute for the given class, if any.protected abstract Collection<CacheOperation>
AbstractFallbackCacheOperationSource.findCacheOperations
(Method method) Subclasses need to implement this to return the caching attribute for the given method, if any.protected Object
CacheAspectSupport.CacheOperationContext.generateKey
(Object result) Compute the key for the given caching operation.protected abstract Collection<String>
AbstractCacheResolver.getCacheNames
(CacheOperationInvocationContext<?> context) Provide the name of the cache(s) to resolve against the current cache manager.AbstractFallbackCacheOperationSource.getCacheOperations
(Method method, Class<?> targetClass) Determine the caching attribute for this method invocation.CacheOperationSource.getCacheOperations
(Method method, Class<?> targetClass) Return the collection of cache operations for this method, ornull
if the method contains no cacheable annotations.CompositeCacheOperationSource.getCacheOperations
(Method method, Class<?> targetClass) NameMatchCacheOperationSource.getCacheOperations
(Method method, Class<?> targetClass) CacheAspectSupport.getCacheOperationSource()
Return the CacheOperationSource for this cache aspect.CacheAspectSupport.getCacheResolver()
Return the defaultCacheResolver
that this cache aspect delegates to.CacheableOperation.getUnless()
CachePutOperation.getUnless()
CacheInterceptor.invoke
(MethodInvocation invocation) CacheOperationInvoker.invoke()
Invoke the cache operation defined by this instance.protected Object
CacheAspectSupport.invokeOperation
(CacheOperationInvoker invoker) Execute the underlying operation (typically in case of cache miss) and return the result of the invocation.Modifier and TypeMethodDescriptionprotected boolean
CacheAspectSupport.CacheOperationContext.canPutToCache
(Object value) void
CacheAspectSupport.configure
(Supplier<CacheErrorHandler> errorHandler, Supplier<KeyGenerator> keyGenerator, Supplier<CacheResolver> cacheResolver, Supplier<CacheManager> cacheManager) Configure this aspect with the given error handler, key generator and cache resolver/manager suppliers, applying the corresponding default if a supplier is not resolvable.void
CacheAspectSupport.configure
(Supplier<CacheErrorHandler> errorHandler, Supplier<KeyGenerator> keyGenerator, Supplier<CacheResolver> cacheResolver, Supplier<CacheManager> cacheManager) Configure this aspect with the given error handler, key generator and cache resolver/manager suppliers, applying the corresponding default if a supplier is not resolvable.void
CacheAspectSupport.configure
(Supplier<CacheErrorHandler> errorHandler, Supplier<KeyGenerator> keyGenerator, Supplier<CacheResolver> cacheResolver, Supplier<CacheManager> cacheManager) Configure this aspect with the given error handler, key generator and cache resolver/manager suppliers, applying the corresponding default if a supplier is not resolvable.void
CacheAspectSupport.configure
(Supplier<CacheErrorHandler> errorHandler, Supplier<KeyGenerator> keyGenerator, Supplier<CacheResolver> cacheResolver, Supplier<CacheManager> cacheManager) Configure this aspect with the given error handler, key generator and cache resolver/manager suppliers, applying the corresponding default if a supplier is not resolvable.protected void
ExecuteCache.put(Object, Object)
on the specifiedCache
and invoke the error handler if an exception occurs.boolean
This implementation compares thetoString()
results.boolean
boolean
protected Object
CacheAspectSupport.CacheOperationContext.generateKey
(Object result) Compute the key for the given caching operation.protected Object
AbstractFallbackCacheOperationSource.getCacheKey
(Method method, Class<?> targetClass) Determine a cache key for the given method and target class.AbstractFallbackCacheOperationSource.getCacheOperations
(Method method, Class<?> targetClass) Determine the caching attribute for this method invocation.CacheOperationSource.getCacheOperations
(Method method, Class<?> targetClass) Return the collection of cache operations for this method, ornull
if the method contains no cacheable annotations.CompositeCacheOperationSource.getCacheOperations
(Method method, Class<?> targetClass) NameMatchCacheOperationSource.getCacheOperations
(Method method, Class<?> targetClass) void
CacheErrorHandler.handleCachePutError
(RuntimeException exception, Cache cache, Object key, Object value) Handle the given runtime exception thrown by the cache provider when updating an item with the specifiedkey
andvalue
, possibly rethrowing it as a fatal exception.void
LoggingCacheErrorHandler.handleCachePutError
(RuntimeException exception, Cache cache, Object key, Object value) void
SimpleCacheErrorHandler.handleCachePutError
(RuntimeException exception, Cache cache, Object key, Object value) protected boolean
CacheAspectSupport.CacheOperationContext.isConditionPassing
(Object result) void
CacheAspectSupport.setCacheOperationSource
(CacheOperationSource cacheOperationSource) Set the CacheOperationSource for this cache aspect.void
CacheAspectSupport.setCacheResolver
(CacheResolver cacheResolver) Set the defaultCacheResolver
that this cache aspect should delegate to if no specific cache resolver has been set for the operation. -
Uses of Nullable in org.springframework.cache.jcache
Modifier and TypeMethodDescription<T> T
javax.cache.CacheManager
JCacheCacheManager.getCacheManager()
Return the backing JCachejavax.cache.CacheManager
.javax.cache.CacheManager
JCacheManagerFactoryBean.getObject()
protected Object
JCacheCache.putIfAbsent
(Object key, Object value) Modifier and TypeMethodDescriptionvoid
JCacheCache.putIfAbsent
(Object key, Object value) void
JCacheCacheManager.setCacheManager
(javax.cache.CacheManager cacheManager) Set the backing JCachejavax.cache.CacheManager
.void
JCacheManagerFactoryBean.setCacheManagerProperties
(Properties cacheManagerProperties) Specify properties for the to-be-createdCacheManager
.void
JCacheManagerFactoryBean.setCacheManagerUri
(URI cacheManagerUri) Specify the URI for the desiredCacheManager
. -
Uses of Nullable in org.springframework.cache.jcache.config
Modifier and TypeFieldDescriptionprotected Supplier<CacheResolver>
AbstractJCacheConfiguration.exceptionCacheResolver
Modifier and TypeMethodDescriptiondefault CacheResolver
JCacheConfigurer.exceptionCacheResolver()
Return theCacheResolver
bean to use to resolve exception caches for annotation-driven cache management.JCacheConfigurerSupport.exceptionCacheResolver()
Deprecated. -
Uses of Nullable in org.springframework.cache.jcache.interceptor
Modifier and TypeMethodDescriptionprotected javax.cache.annotation.CacheResolverFactory
AnnotationJCacheOperationSource.determineCacheResolverFactory
(javax.cache.annotation.CacheDefaults defaults, Class<? extends javax.cache.annotation.CacheResolverFactory> candidate) protected Object
JCacheAspectSupport.execute
(CacheOperationInvoker invoker, Object target, Method method, Object[] args) protected abstract JCacheOperation<?>
AbstractFallbackJCacheOperationSource.findCacheOperation
(Method method, Class<?> targetType) Subclasses need to implement this to return the caching operation for the given method, if any.protected javax.cache.annotation.CacheDefaults
AnnotationJCacheOperationSource.getCacheDefaults
(Method method, Class<?> targetType) DefaultJCacheOperationSource.getCacheManager()
Return the specified cache manager to use, if any.JCacheOperationSource.getCacheOperation
(Method method, Class<?> targetClass) Return the cache operations for this method, ornull
if the method contains no JSR-107 related metadata.protected abstract JCacheOperationSource
JCacheOperationSourcePointcut.getCacheOperationSource()
Deprecated, for removal: This API element is subject to removal in a future version.Obtain the underlyingJCacheOperationSource
(may benull
).DefaultJCacheOperationSource.getCacheResolver()
Return the specified cache resolver to use, if any.DefaultJCacheOperationSource.getExceptionCacheResolver()
Return the specified exception cache resolver to use, if any.JCacheInterceptor.invoke
(MethodInvocation invocation) protected Object
JCacheAspectSupport.invokeOperation
(CacheOperationInvoker invoker) Execute the underlying operation (typically in case of cache miss) and return the result of the invocation.Modifier and TypeMethodDescriptionprotected org.springframework.cache.jcache.interceptor.CachePutOperation
AnnotationJCacheOperationSource.createCachePutOperation
(Method method, javax.cache.annotation.CacheDefaults defaults, javax.cache.annotation.CachePut ann) protected org.springframework.cache.jcache.interceptor.CacheRemoveAllOperation
AnnotationJCacheOperationSource.createCacheRemoveAllOperation
(Method method, javax.cache.annotation.CacheDefaults defaults, javax.cache.annotation.CacheRemoveAll ann) protected org.springframework.cache.jcache.interceptor.CacheRemoveOperation
AnnotationJCacheOperationSource.createCacheRemoveOperation
(Method method, javax.cache.annotation.CacheDefaults defaults, javax.cache.annotation.CacheRemove ann) protected org.springframework.cache.jcache.interceptor.CacheResultOperation
AnnotationJCacheOperationSource.createCacheResultOperation
(Method method, javax.cache.annotation.CacheDefaults defaults, javax.cache.annotation.CacheResult ann) protected String
AnnotationJCacheOperationSource.determineCacheName
(Method method, javax.cache.annotation.CacheDefaults defaults, String candidate) protected javax.cache.annotation.CacheResolverFactory
AnnotationJCacheOperationSource.determineCacheResolverFactory
(javax.cache.annotation.CacheDefaults defaults, Class<? extends javax.cache.annotation.CacheResolverFactory> candidate) protected KeyGenerator
AnnotationJCacheOperationSource.determineKeyGenerator
(javax.cache.annotation.CacheDefaults defaults, Class<? extends javax.cache.annotation.CacheKeyGenerator> candidate) boolean
Deprecated, for removal: This API element is subject to removal in a future version.protected abstract JCacheOperation<?>
AbstractFallbackJCacheOperationSource.findCacheOperation
(Method method, Class<?> targetType) Subclasses need to implement this to return the caching operation for the given method, if any.protected JCacheOperation<?>
AnnotationJCacheOperationSource.findCacheOperation
(Method method, Class<?> targetType) protected javax.cache.annotation.CacheDefaults
AnnotationJCacheOperationSource.getCacheDefaults
(Method method, Class<?> targetType) AbstractFallbackJCacheOperationSource.getCacheOperation
(Method method, Class<?> targetClass) JCacheOperationSource.getCacheOperation
(Method method, Class<?> targetClass) Return the cache operations for this method, ornull
if the method contains no JSR-107 related metadata.protected CacheResolver
AnnotationJCacheOperationSource.getCacheResolver
(javax.cache.annotation.CacheResolverFactory factory, javax.cache.annotation.CacheMethodDetails<?> details) protected CacheResolver
AnnotationJCacheOperationSource.getExceptionCacheResolver
(javax.cache.annotation.CacheResolverFactory factory, javax.cache.annotation.CacheMethodDetails<javax.cache.annotation.CacheResult> details) void
DefaultJCacheOperationSource.setCacheManager
(CacheManager cacheManager) Set the defaultCacheManager
to use to lookup cache by name.void
DefaultJCacheOperationSource.setCacheResolver
(CacheResolver cacheResolver) Set theCacheResolver
to resolve regular caches.void
DefaultJCacheOperationSource.setExceptionCacheResolver
(CacheResolver exceptionCacheResolver) Set theCacheResolver
to resolve exception caches.ModifierConstructorDescriptionDefaultJCacheOperationSource
(Supplier<CacheManager> cacheManager, Supplier<CacheResolver> cacheResolver, Supplier<CacheResolver> exceptionCacheResolver, Supplier<KeyGenerator> keyGenerator) Construct a newDefaultJCacheOperationSource
with the given cache manager, cache resolver and key generator suppliers, applying the corresponding default if a supplier is not resolvable.DefaultJCacheOperationSource
(Supplier<CacheManager> cacheManager, Supplier<CacheResolver> cacheResolver, Supplier<CacheResolver> exceptionCacheResolver, Supplier<KeyGenerator> keyGenerator) Construct a newDefaultJCacheOperationSource
with the given cache manager, cache resolver and key generator suppliers, applying the corresponding default if a supplier is not resolvable.DefaultJCacheOperationSource
(Supplier<CacheManager> cacheManager, Supplier<CacheResolver> cacheResolver, Supplier<CacheResolver> exceptionCacheResolver, Supplier<KeyGenerator> keyGenerator) Construct a newDefaultJCacheOperationSource
with the given cache manager, cache resolver and key generator suppliers, applying the corresponding default if a supplier is not resolvable.DefaultJCacheOperationSource
(Supplier<CacheManager> cacheManager, Supplier<CacheResolver> cacheResolver, Supplier<CacheResolver> exceptionCacheResolver, Supplier<KeyGenerator> keyGenerator) Construct a newDefaultJCacheOperationSource
with the given cache manager, cache resolver and key generator suppliers, applying the corresponding default if a supplier is not resolvable.JCacheInterceptor
(Supplier<CacheErrorHandler> errorHandler) Construct a newJCacheInterceptor
with the given error handler. -
Uses of Nullable in org.springframework.cache.support
Modifier and TypeMethodDescriptionprotected Object
AbstractValueAdaptingCache.fromStoreValue
(Object storeValue) Convert the given value from the internal store to a user value returned from the get method (adaptingnull
).<T> T
<T> T
<T> T
SimpleValueWrapper.get()
Simply returns the value as given at construction time.This implementation always returns aCache
implementation that will not store items.protected Cache
AbstractCacheManager.getMissingCache
(String name) Return a missing cache with the specifiedname
, ornull
if such a cache does not exist or could not be created on demand.protected abstract Object
Perform an actual lookup in the underlying store.protected final Cache
AbstractCacheManager.lookupCache
(String name) Check for a registered cache of the given name.NoOpCache.putIfAbsent
(Object key, Object value) protected Cache.ValueWrapper
AbstractValueAdaptingCache.toValueWrapper
(Object storeValue) Wrap the given store value with aSimpleValueWrapper
, also going throughAbstractValueAdaptingCache.fromStoreValue(java.lang.Object)
conversion.Modifier and TypeMethodDescriptionboolean
protected Object
AbstractValueAdaptingCache.fromStoreValue
(Object storeValue) Convert the given value from the internal store to a user value returned from the get method (adaptingnull
).<T> T
<T> T
void
NoOpCache.putIfAbsent
(Object key, Object value) protected Object
AbstractValueAdaptingCache.toStoreValue
(Object userValue) Convert the given user value, as passed into the put method, to a value in the internal store (adaptingnull
).protected Cache.ValueWrapper
AbstractValueAdaptingCache.toValueWrapper
(Object storeValue) Wrap the given store value with aSimpleValueWrapper
, also going throughAbstractValueAdaptingCache.fromStoreValue(java.lang.Object)
conversion.ModifierConstructorDescriptionSimpleValueWrapper
(Object value) Create a new SimpleValueWrapper instance for exposing the given value. -
Uses of Nullable in org.springframework.cache.transaction
Modifier and TypeMethodDescription<T> T
TransactionAwareCacheDecorator.putIfAbsent
(Object key, Object value) Modifier and TypeMethodDescription<T> T
void
TransactionAwareCacheDecorator.putIfAbsent
(Object key, Object value) -
Uses of Nullable in org.springframework.context
Modifier and TypeMethodDescriptiondefault Object[]
MessageSourceResolvable.getArguments()
Return the array of arguments to be used to resolve this message.String[]
MessageSourceResolvable.getCodes()
Return the codes to be used to resolve this message, in the order that they should get tried.default String
MessageSourceResolvable.getDefaultMessage()
Return the default message to be used to resolve this message.ApplicationContext.getId()
Return the unique id of this application context.MessageSource.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) Try to resolve the message.ApplicationContext.getParent()
Return the parent context, ornull
if there is no parent and this is the root of the context hierarchy.HierarchicalMessageSource.getParentMessageSource()
Return the parent of this MessageSource, ornull
if none.Modifier and TypeMethodDescriptionMessageSource.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) Try to resolve the message.MessageSource.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) Try to resolve the message.MessageSource.getMessage
(String code, Object[] args, Locale locale) Try to resolve the message.void
ConfigurableApplicationContext.setParent
(ApplicationContext parent) Set the parent of this application context.void
HierarchicalMessageSource.setParentMessageSource
(MessageSource parent) Set the parent that will be used to try to resolve messages that this object can't resolve.ModifierConstructorDescriptionPayloadApplicationEvent
(Object source, T payload, ResolvableType payloadType) Create a new PayloadApplicationEvent based on the provided payload type. -
Uses of Nullable in org.springframework.context.annotation
Modifier and TypeFieldDescriptionprotected String
CommonAnnotationBeanPostProcessor.LookupElement.mappedName
Modifier and TypeMethodDescriptionprotected String
AnnotationBeanNameGenerator.determineBeanNameFromAnnotation
(AnnotatedBeanDefinition annotatedDef) Derive a bean name from one of the annotations on the class.ConditionContext.getBeanFactory()
Return theConfigurableListableBeanFactory
that will hold the bean definition should the condition match, ornull
if the bean factory is not available (or not downcastable toConfigurableListableBeanFactory
).ConditionContext.getClassLoader()
Return theClassLoader
that should be used to load additional classes (onlynull
if even the system ClassLoader isn't accessible).ImportSelector.getExclusionFilter()
Return a predicate for excluding classes from the import candidates, to be transitively applied to all classes found through this selector's imports.ScannedGenericBeanDefinition.getFactoryMethodMetadata()
default Class<? extends DeferredImportSelector.Group>
DeferredImportSelector.getImportGroup()
Return a specific import group.Class<?>
ContextAnnotationAutowireCandidateResolver.getLazyResolutionProxyClass
(DependencyDescriptor descriptor, String beanName) ContextAnnotationAutowireCandidateResolver.getLazyResolutionProxyIfNecessary
(DependencyDescriptor descriptor, String beanName) static Integer
ConfigurationClassUtils.getOrder
(AnnotationMetadata metadata) Determine the order for the given configuration class metadata.protected BeanDefinitionRegistry
ClassPathScanningCandidateComponentProvider.getRegistry()
Return theBeanDefinitionRegistry
used by this scanner, if any.AnnotationConfigBeanDefinitionParser.parse
(Element element, ParserContext parserContext) ComponentScanBeanDefinitionParser.parse
(Element element, ParserContext parserContext) ConfigurationClassPostProcessor.processAheadOfTime
(ConfigurableListableBeanFactory beanFactory) ConfigurationClassPostProcessor.processAheadOfTime
(RegisteredBean registeredBean) protected String
Jsr330ScopeMetadataResolver.resolveScopeName
(String annotationType) Resolve the given annotation type into a named Spring scope.protected abstract String[]
AdviceModeImportSelector.selectImports
(AdviceMode adviceMode) Determine which classes should be imported based on the givenAdviceMode
.Modifier and TypeMethodDescriptionprotected Object
CommonAnnotationBeanPostProcessor.autowireResource
(BeanFactory factory, CommonAnnotationBeanPostProcessor.LookupElement element, String requestingBeanName) Obtain a resource object for the given name and type through autowiring based on the given factory.protected Object
ContextAnnotationAutowireCandidateResolver.buildLazyResolutionProxy
(DependencyDescriptor descriptor, String beanName) protected Object
CommonAnnotationBeanPostProcessor.buildLazyResourceProxy
(CommonAnnotationBeanPostProcessor.LookupElement element, String requestingBeanName) Obtain a lazily resolving resource proxy for the given name and type, delegating toCommonAnnotationBeanPostProcessor.getResource(org.springframework.context.annotation.CommonAnnotationBeanPostProcessor.LookupElement, java.lang.String)
on demand once a method call comes in.protected TypeFilter
ComponentScanBeanDefinitionParser.createTypeFilter
(Element element, ClassLoader classLoader, ParserContext parserContext) boolean
Class<?>
ContextAnnotationAutowireCandidateResolver.getLazyResolutionProxyClass
(DependencyDescriptor descriptor, String beanName) ContextAnnotationAutowireCandidateResolver.getLazyResolutionProxyIfNecessary
(DependencyDescriptor descriptor, String beanName) protected Object
CommonAnnotationBeanPostProcessor.getResource
(CommonAnnotationBeanPostProcessor.LookupElement element, String requestingBeanName) Obtain the resource object for the given name and type.protected boolean
AnnotationBeanNameGenerator.isStereotypeWithNameValue
(String annotationType, Set<String> metaAnnotationTypes, Map<String, Object> attributes) Check whether the given annotation is a stereotype that is allowed to suggest a component name through its annotationvalue()
.static Set<BeanDefinitionHolder>
AnnotationConfigUtils.registerAnnotationConfigProcessors
(BeanDefinitionRegistry registry, Object source) Register all relevant annotation post processors in the given registry.void
AnnotatedBeanDefinitionReader.registerBean
(Class<?> beanClass, String name) Register a bean from the given bean class, deriving its metadata from class-declared annotations.void
AnnotatedBeanDefinitionReader.registerBean
(Class<?> beanClass, String name, Class<? extends Annotation>... qualifiers) Register a bean from the given bean class, deriving its metadata from class-declared annotations.<T> void
AnnotatedBeanDefinitionReader.registerBean
(Class<T> beanClass, String name, Supplier<T> supplier) Register a bean from the given bean class, deriving its metadata from class-declared annotations, using the given supplier for obtaining a new instance (possibly declared as a lambda expression or method reference).<T> void
AnnotatedBeanDefinitionReader.registerBean
(Class<T> beanClass, String name, Supplier<T> supplier) Register a bean from the given bean class, deriving its metadata from class-declared annotations, using the given supplier for obtaining a new instance (possibly declared as a lambda expression or method reference).<T> void
AnnotatedBeanDefinitionReader.registerBean
(Class<T> beanClass, String name, Supplier<T> supplier, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, deriving its metadata from class-declared annotations.<T> void
AnnotatedBeanDefinitionReader.registerBean
(Class<T> beanClass, String name, Supplier<T> supplier, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, deriving its metadata from class-declared annotations.<T> void
AnnotatedBeanDefinitionReader.registerBean
(Class<T> beanClass, Supplier<T> supplier) Register a bean from the given bean class, deriving its metadata from class-declared annotations, using the given supplier for obtaining a new instance (possibly declared as a lambda expression or method reference).<T> void
AnnotationConfigApplicationContext.registerBean
(String beanName, Class<T> beanClass, Supplier<T> supplier, BeanDefinitionCustomizer... customizers) <T> void
AnnotationConfigApplicationContext.registerBean
(String beanName, Class<T> beanClass, Supplier<T> supplier, BeanDefinitionCustomizer... customizers) void
ClassPathBeanDefinitionScanner.setAutowireCandidatePatterns
(String... autowireCandidatePatterns) Set the name-matching patterns for determining autowire candidates.void
ClassPathBeanDefinitionScanner.setBeanDefinitionDefaults
(BeanDefinitionDefaults beanDefinitionDefaults) Set the defaults to use for detected beans.void
AnnotatedBeanDefinitionReader.setBeanNameGenerator
(BeanNameGenerator beanNameGenerator) Set theBeanNameGenerator
to use for detected bean classes.void
ClassPathBeanDefinitionScanner.setBeanNameGenerator
(BeanNameGenerator beanNameGenerator) Set the BeanNameGenerator to use for detected bean classes.void
ConfigurationClassPostProcessor.setProblemReporter
(ProblemReporter problemReporter) Set theProblemReporter
to use.void
ClassPathScanningCandidateComponentProvider.setResourceLoader
(ResourceLoader resourceLoader) Set theResourceLoader
to use for resource locations.void
AnnotatedBeanDefinitionReader.setScopeMetadataResolver
(ScopeMetadataResolver scopeMetadataResolver) Set theScopeMetadataResolver
to use for registered component classes.void
ClassPathBeanDefinitionScanner.setScopeMetadataResolver
(ScopeMetadataResolver scopeMetadataResolver) Set the ScopeMetadataResolver to use for detected bean classes.void
ConfigurationClassPostProcessor.setSourceExtractor
(SourceExtractor sourceExtractor) Set theSourceExtractor
to use for generated bean definitions that correspond toBean
factory methods.ModifierConstructorDescriptionClassPathBeanDefinitionScanner
(BeanDefinitionRegistry registry, boolean useDefaultFilters, Environment environment, ResourceLoader resourceLoader) Create a newClassPathBeanDefinitionScanner
for the given bean factory and using the givenEnvironment
when evaluating bean definition profile metadata.LookupElement
(Member member, PropertyDescriptor pd) -
Uses of Nullable in org.springframework.context.aot
Modifier and TypeMethodDescriptionstatic <C extends ConfigurableApplicationContext>
ApplicationContextInitializer<C>AotApplicationContextInitializer.instantiateInitializer
(String initializerClassName, ClassLoader classLoader) -
Uses of Nullable in org.springframework.context.event
Modifier and TypeMethodDescriptionprotected Object
Invoke the event listener method with the given argument values.protected String
ApplicationListenerMethodAdapter.getCondition()
Return the condition to use.protected ErrorHandler
SimpleApplicationEventMulticaster.getErrorHandler()
Return the current error handler for this multicaster.protected Executor
SimpleApplicationEventMulticaster.getTaskExecutor()
Return the current task executor for this multicaster.EventPublicationInterceptor.invoke
(MethodInvocation invocation) protected Object[]
ApplicationListenerMethodAdapter.resolveArguments
(ApplicationEvent event) Resolve the method arguments to use for the specifiedApplicationEvent
.Modifier and TypeMethodDescriptionvoid
ApplicationEventMulticaster.multicastEvent
(ApplicationEvent event, ResolvableType eventType) Multicast the given application event to appropriate listeners.void
SimpleApplicationEventMulticaster.multicastEvent
(ApplicationEvent event, ResolvableType eventType) void
SimpleApplicationEventMulticaster.setErrorHandler
(ErrorHandler errorHandler) Set theErrorHandler
to invoke in case an exception is thrown from a listener.void
SimpleApplicationEventMulticaster.setTaskExecutor
(Executor taskExecutor) Set a custom executor (typically aTaskExecutor
) to invoke each listener with.protected boolean
AbstractApplicationEventMulticaster.supportsEvent
(ApplicationListener<?> listener, ResolvableType eventType, Class<?> sourceType) Determine whether the given listener supports the given event.boolean
ApplicationListenerMethodAdapter.supportsSourceType
(Class<?> sourceType) boolean
GenericApplicationListenerAdapter.supportsSourceType
(Class<?> sourceType) default boolean
SmartApplicationListener.supportsSourceType
(Class<?> sourceType) Determine whether this listener actually supports the given source type.boolean
SourceFilteringListener.supportsSourceType
(Class<?> sourceType) -
Uses of Nullable in org.springframework.context.expression
Modifier and TypeMethodDescriptionStandardBeanExpressionResolver.evaluate
(String value, BeanExpressionContext beanExpressionContext) MethodBasedEvaluationContext.lookupVariable
(String name) Modifier and TypeMethodDescriptionboolean
BeanExpressionContextAccessor.canRead
(EvaluationContext context, Object target, String name) boolean
BeanFactoryAccessor.canRead
(EvaluationContext context, Object target, String name) boolean
EnvironmentAccessor.canRead
(EvaluationContext context, Object target, String name) Can read anyEnvironment
, thus always returns true.boolean
MapAccessor.canRead
(EvaluationContext context, Object target, String name) boolean
BeanExpressionContextAccessor.canWrite
(EvaluationContext context, Object target, String name) boolean
BeanFactoryAccessor.canWrite
(EvaluationContext context, Object target, String name) boolean
EnvironmentAccessor.canWrite
(EvaluationContext context, Object target, String name) Read-only: returnsfalse
.boolean
MapAccessor.canWrite
(EvaluationContext context, Object target, String name) boolean
boolean
StandardBeanExpressionResolver.evaluate
(String value, BeanExpressionContext beanExpressionContext) BeanExpressionContextAccessor.read
(EvaluationContext context, Object target, String name) BeanFactoryAccessor.read
(EvaluationContext context, Object target, String name) EnvironmentAccessor.read
(EvaluationContext context, Object target, String name) Access the given target object by resolving the given property name against the given target environment.MapAccessor.read
(EvaluationContext context, Object target, String name) void
BeanExpressionContextAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) void
BeanExpressionContextAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) void
BeanFactoryAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) void
BeanFactoryAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) void
EnvironmentAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) Read-only: no-op.void
EnvironmentAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) Read-only: no-op.void
MapAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) void
MapAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) ModifierConstructorDescriptionAnnotatedElementKey
(AnnotatedElement element, Class<?> targetClass) Create a new instance with the specifiedAnnotatedElement
and optional targetClass
.StandardBeanExpressionResolver
(ClassLoader beanClassLoader) Create a newStandardBeanExpressionResolver
with the given bean class loader, using it as the basis for expression compilation. -
Uses of Nullable in org.springframework.context.i18n
Modifier and TypeMethodDescriptionLocaleContext.getLocale()
Return the current Locale, which can be fixed or determined dynamically, depending on the implementation strategy.SimpleLocaleContext.getLocale()
static LocaleContext
LocaleContextHolder.getLocaleContext()
Return the LocaleContext associated with the current thread, if any.SimpleTimeZoneAwareLocaleContext.getTimeZone()
TimeZoneAwareLocaleContext.getTimeZone()
Return the current TimeZone, which can be fixed or determined dynamically, depending on the implementation strategy.Modifier and TypeMethodDescriptionstatic Locale
LocaleContextHolder.getLocale
(LocaleContext localeContext) Return the Locale associated with the given user context, if any, or the system default Locale otherwise.static TimeZone
LocaleContextHolder.getTimeZone
(LocaleContext localeContext) Return the TimeZone associated with the given user context, if any, or the system default TimeZone otherwise.static void
LocaleContextHolder.setDefaultLocale
(Locale locale) Set a shared default locale at the framework level, as an alternative to the JVM-wide default locale.static void
LocaleContextHolder.setDefaultTimeZone
(TimeZone timeZone) Set a shared default time zone at the framework level, as an alternative to the JVM-wide default time zone.static void
Associate the given Locale with the current thread, preserving any TimeZone that may have been set already.static void
Associate the given Locale with the current thread, preserving any TimeZone that may have been set already.static void
LocaleContextHolder.setLocaleContext
(LocaleContext localeContext) Associate the given LocaleContext with the current thread, not exposing it as inheritable for child threads.static void
LocaleContextHolder.setLocaleContext
(LocaleContext localeContext, boolean inheritable) Associate the given LocaleContext with the current thread.static void
LocaleContextHolder.setTimeZone
(TimeZone timeZone) Associate the given TimeZone with the current thread, preserving any Locale that may have been set already.static void
LocaleContextHolder.setTimeZone
(TimeZone timeZone, boolean inheritable) Associate the given TimeZone with the current thread, preserving any Locale that may have been set already.ModifierConstructorDescriptionSimpleLocaleContext
(Locale locale) Create a newSimpleLocaleContext
that exposes the specifiedLocale
.SimpleTimeZoneAwareLocaleContext
(Locale locale, TimeZone timeZone) Create a new SimpleTimeZoneAwareLocaleContext that exposes the specified Locale and TimeZone.SimpleTimeZoneAwareLocaleContext
(Locale locale, TimeZone timeZone) Create a new SimpleTimeZoneAwareLocaleContext that exposes the specified Locale and TimeZone. -
Uses of Nullable in org.springframework.context.index
Modifier and TypeMethodDescriptionstatic CandidateComponentsIndex
CandidateComponentsIndexLoader.loadIndex
(ClassLoader classLoader) Deprecated, for removal: This API element is subject to removal in a future version.Load and instantiate theCandidateComponentsIndex
from "META-INF/spring.components", using the given class loader.Modifier and TypeMethodDescriptionstatic CandidateComponentsIndex
CandidateComponentsIndexLoader.loadIndex
(ClassLoader classLoader) Deprecated, for removal: This API element is subject to removal in a future version.Load and instantiate theCandidateComponentsIndex
from "META-INF/spring.components", using the given class loader. -
Uses of Nullable in org.springframework.context.support
Modifier and TypeMethodDescription<A extends Annotation>
AAbstractApplicationContext.findAnnotationOnBean
(String beanName, Class<A> annotationType) <A extends Annotation>
AAbstractApplicationContext.findAnnotationOnBean
(String beanName, Class<A> annotationType, boolean allowFactoryBeanInit) final ApplicationContext
ApplicationObjectSupport.getApplicationContext()
Return the ApplicationContext that this object is associated with.Object[]
DefaultMessageSourceResolvable.getArguments()
protected ClassLoader
ResourceBundleMessageSource.getBundleClassLoader()
Return the ClassLoader to load resource bundles with.GenericApplicationContext.getClassLoader()
DefaultMessageSourceResolvable.getCode()
Return the default code of this resolvable, that is, the last one in the codes array.String[]
DefaultMessageSourceResolvable.getCodes()
protected Properties
AbstractMessageSource.getCommonMessages()
Return a Properties object defining locale-independent common messages, if any.protected String[]
AbstractRefreshableConfigApplicationContext.getConfigLocations()
Return an array of resource locations, referring to the XML bean definition files that this context should be built with.protected Resource[]
AbstractXmlApplicationContext.getConfigResources()
Return an array of Resource objects, referring to the XML bean definition files that this context should be built with.protected Resource[]
ClassPathXmlApplicationContext.getConfigResources()
protected String[]
AbstractRefreshableConfigApplicationContext.getDefaultConfigLocations()
Return the default config locations to use, for the case where no explicit config locations have been specified.protected String
AbstractResourceBasedMessageSource.getDefaultEncoding()
Return the default charset to use for parsing properties files, if any.protected Locale
AbstractResourceBasedMessageSource.getDefaultLocale()
Determine a default Locale to fall back to: either a locally specified default Locale or the system Locale, ornull
for no fallback locale at all.protected String
AbstractMessageSource.getDefaultMessage
(String code) Return a fallback default message for the given code, if any.protected String
AbstractMessageSource.getDefaultMessage
(MessageSourceResolvable resolvable, Locale locale) Get a default message for the givenMessageSourceResolvable
.DefaultMessageSourceResolvable.getDefaultMessage()
protected BeanFactory
AbstractApplicationContext.getInternalParentBeanFactory()
Return the internal bean factory of the parent context if it implements ConfigurableApplicationContext; else, return the parent context itself.protected MessageSource
AbstractApplicationContext.getInternalParentMessageSource()
Return the internal message source of the parent context if it is an AbstractApplicationContext too; else, return the parent context itself.DelegatingMessageSource.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) ReloadableResourceBundleMessageSource.PropertiesHolder.getMessageFormat
(String code, Locale locale) protected MessageFormat
ResourceBundleMessageSource.getMessageFormat
(ResourceBundle bundle, String code, Locale locale) Return a MessageFormat for the given bundle and code, fetching already generated MessageFormats from the cache.protected String
AbstractMessageSource.getMessageFromParent
(String code, Object[] args, Locale locale) Try to retrieve the given message from the parentMessageSource
, if any.protected String
AbstractMessageSource.getMessageInternal
(String code, Object[] args, Locale locale) Resolve the given code and arguments as message in the given Locale, returningnull
if not found.protected final MessageSourceAccessor
ApplicationObjectSupport.getMessageSourceAccessor()
Return a MessageSourceAccessor for the application context used by this object, for easy message access.ConversionServiceFactoryBean.getObject()
AbstractApplicationContext.getParent()
Return the parent context, ornull
if there is no parent (that is, this context is the root of the context hierarchy).AbstractApplicationContext.getParentBeanFactory()
AbstractMessageSource.getParentMessageSource()
DelegatingMessageSource.getParentMessageSource()
ReloadableResourceBundleMessageSource.PropertiesHolder.getProperties()
GenericGroovyApplicationContext.getProperty
(String property) ReloadableResourceBundleMessageSource.PropertiesHolder.getProperty
(String code) protected ResourceBundle
ResourceBundleMessageSource.getResourceBundle
(String basename, Locale locale) Return a ResourceBundle for the given basename and Locale, fetching already generated ResourceBundle from the cache.protected String
ResourceBundleMessageSource.getStringOrNull
(ResourceBundle bundle, String key) Efficiently retrieve the String value for the specified key, or returnnull
if not found.Class<?>
Class<?>
protected Object
MessageSourceResourceBundle.handleGetObject
(String key) This implementation resolves the code in the MessageSource.protected abstract MessageFormat
AbstractMessageSource.resolveCode
(String code, Locale locale) Subclasses must implement this method to resolve a message.protected MessageFormat
ReloadableResourceBundleMessageSource.resolveCode
(String code, Locale locale) Resolves the given message code as key in the retrieved bundle files, using a cached MessageFormat instance per message code.protected MessageFormat
ResourceBundleMessageSource.resolveCode
(String code, Locale locale) Resolves the given message code as key in the registered resource bundles, using a cached MessageFormat instance per message code.protected MessageFormat
StaticMessageSource.resolveCode
(String code, Locale locale) protected String
AbstractMessageSource.resolveCodeWithoutArguments
(String code, Locale locale) Subclasses can override this method to resolve a message without arguments in an optimized fashion, i.e.protected String
StaticMessageSource.resolveCodeWithoutArguments
(String code, Locale locale) SimpleThreadScope.resolveContextualObject
(String key) protected String
EmbeddedValueResolutionSupport.resolveEmbeddedValue
(String value) Resolve the given embedded value through this instance'sStringValueResolver
.Modifier and TypeMethodDescriptionboolean
protected String
MessageSourceSupport.formatMessage
(String msg, Object[] args, Locale locale) Format the given message String, using cached MessageFormats.String[]
AbstractApplicationContext.getBeanNamesForType
(Class<?> type) String[]
AbstractApplicationContext.getBeanNamesForType
(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) AbstractApplicationContext.getBeansOfType
(Class<T> type) AbstractApplicationContext.getBeansOfType
(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) AbstractApplicationContext.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) AbstractApplicationContext.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) AbstractApplicationContext.getMessage
(String code, Object[] args, Locale locale) final String
AbstractMessageSource.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) final String
AbstractMessageSource.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) final String
AbstractMessageSource.getMessage
(String code, Object[] args, Locale locale) DelegatingMessageSource.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) DelegatingMessageSource.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) DelegatingMessageSource.getMessage
(String code, Object[] args, Locale locale) MessageSourceAccessor.getMessage
(String code, Object[] args) Retrieve the message for the given code and the default Locale.MessageSourceAccessor.getMessage
(String code, Object[] args, String defaultMessage) Retrieve the message for the given code and the default Locale.MessageSourceAccessor.getMessage
(String code, Object[] args, String defaultMessage, Locale locale) Retrieve the message for the given code and the given Locale.MessageSourceAccessor.getMessage
(String code, Object[] args, Locale locale) Retrieve the message for the given code and the given Locale.protected String
AbstractMessageSource.getMessageFromParent
(String code, Object[] args, Locale locale) Try to retrieve the given message from the parentMessageSource
, if any.protected String
AbstractMessageSource.getMessageInternal
(String code, Object[] args, Locale locale) Resolve the given code and arguments as message in the given Locale, returningnull
if not found.protected String
AbstractMessageSource.getMessageInternal
(String code, Object[] args, Locale locale) Resolve the given code and arguments as message in the given Locale, returningnull
if not found.protected String
AbstractMessageSource.getMessageInternal
(String code, Object[] args, Locale locale) Resolve the given code and arguments as message in the given Locale, returningnull
if not found.protected void
AbstractApplicationContext.publishEvent
(Object event, ResolvableType typeHint) Publish the given event to all listeners.ReloadableResourceBundleMessageSource.refreshProperties
(String filename, ReloadableResourceBundleMessageSource.PropertiesHolder propHolder) Refresh the PropertiesHolder for the given bundle filename.<T> void
GenericApplicationContext.registerBean
(String beanName, Class<T> beanClass, Object... constructorArgs) Register a bean from the given bean class, optionally providing explicit constructor arguments for consideration in the autowiring process.<T> void
GenericApplicationContext.registerBean
(String beanName, Class<T> beanClass, Supplier<T> supplier, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, using the given supplier for obtaining a new instance (typically declared as a lambda expression or method reference), optionally customizing its bean definition metadata (again typically declared as a lambda expression).<T> void
GenericApplicationContext.registerBean
(String beanName, Class<T> beanClass, Supplier<T> supplier, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, using the given supplier for obtaining a new instance (typically declared as a lambda expression or method reference), optionally customizing its bean definition metadata (again typically declared as a lambda expression).final <T> void
GenericApplicationContext.registerBean
(String beanName, Class<T> beanClass, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, optionally customizing its bean definition metadata (typically declared as a lambda expression).protected String
MessageSourceSupport.renderDefaultMessage
(String defaultMessage, Object[] args, Locale locale) Render the given default message String.protected Object[]
AbstractMessageSource.resolveArguments
(Object[] args, Locale locale) Searches through the given array of objects, finds any MessageSourceResolvable objects and resolves them.protected Object[]
MessageSourceSupport.resolveArguments
(Object[] args, Locale locale) Template method for resolving argument objects.final void
ApplicationObjectSupport.setApplicationContext
(ApplicationContext context) void
GenericApplicationContext.setClassLoader
(ClassLoader classLoader) void
AbstractMessageSource.setCommonMessages
(Properties commonMessages) Specify locale-independent common messages, with the message code as key and the full message String (may contain argument placeholders) as value.void
AbstractRefreshableConfigApplicationContext.setConfigLocations
(String... locations) Set the config locations for this application context.void
AbstractResourceBasedMessageSource.setDefaultEncoding
(String defaultEncoding) Set the default charset to use for parsing properties files.void
AbstractResourceBasedMessageSource.setDefaultLocale
(Locale defaultLocale) Specify a default Locale to fall back to, as an alternative to falling back to the system Locale.void
AbstractApplicationContext.setParent
(ApplicationContext parent) Set the parent of this application context.void
GenericApplicationContext.setParent
(ApplicationContext parent) Set the parent of this application context, also setting the parent of the internal BeanFactory accordingly.void
AbstractMessageSource.setParentMessageSource
(MessageSource parent) void
DelegatingMessageSource.setParentMessageSource
(MessageSource parent) void
ReloadableResourceBundleMessageSource.setPropertiesPersister
(PropertiesPersister propertiesPersister) Set the PropertiesPersister to use for parsing properties files.void
ReloadableResourceBundleMessageSource.setResourceLoader
(ResourceLoader resourceLoader) Set the ResourceLoader to use for loading bundle properties files.ModifierConstructorDescriptionCreate a new AbstractApplicationContext with the given parent context.Create a new AbstractRefreshableApplicationContext with the given parent context.Create a new AbstractRefreshableConfigApplicationContext with the given parent context.Create a new AbstractXmlApplicationContext with the given parent context.ClassPathXmlApplicationContext
(String[] configLocations, boolean refresh, ApplicationContext parent) Create a new ClassPathXmlApplicationContext with the given parent, loading the definitions from the given XML files.ClassPathXmlApplicationContext
(String[] paths, Class<?> clazz, ApplicationContext parent) Create a new ClassPathXmlApplicationContext with the given parent, loading the definitions from the given XML files and automatically refreshing the context.ClassPathXmlApplicationContext
(String[] configLocations, ApplicationContext parent) Create a new ClassPathXmlApplicationContext with the given parent, loading the definitions from the given XML files and automatically refreshing the context.DefaultMessageSourceResolvable
(String[] codes, Object[] arguments, String defaultMessage) Create a new DefaultMessageSourceResolvable.DefaultMessageSourceResolvable
(String[] codes, Object[] arguments, String defaultMessage) Create a new DefaultMessageSourceResolvable.DefaultMessageSourceResolvable
(String[] codes, Object[] arguments, String defaultMessage) Create a new DefaultMessageSourceResolvable.FileSystemXmlApplicationContext
(String[] configLocations, boolean refresh, ApplicationContext parent) Create a new FileSystemXmlApplicationContext with the given parent, loading the definitions from the given XML files.Create a new GenericApplicationContext with the given parent.Create a new StaticApplicationContext with the given parent. -
Uses of Nullable in org.springframework.context.weaving
Modifier and TypeMethodDescriptionprotected LoadTimeWeaver
DefaultContextLoadTimeWeaver.createServerSpecificLoadTimeWeaver
(ClassLoader classLoader) Modifier and TypeMethodDescriptionstatic void
AspectJWeavingEnabler.enableAspectJWeaving
(LoadTimeWeaver weaverToUse, ClassLoader beanClassLoader) Enable AspectJ weaving with the givenLoadTimeWeaver
.static void
AspectJWeavingEnabler.enableAspectJWeaving
(LoadTimeWeaver weaverToUse, ClassLoader beanClassLoader) Enable AspectJ weaving with the givenLoadTimeWeaver
.ModifierConstructorDescriptionLoadTimeWeaverAwareProcessor
(LoadTimeWeaver loadTimeWeaver) Create a newLoadTimeWeaverAwareProcessor
for the givenLoadTimeWeaver
. -
Uses of Nullable in org.springframework.core
Modifier and TypeMethodDescriptionstatic String
NestedExceptionUtils.buildMessage
(String message, Throwable cause) Deprecated.as of 6.0, in favor of custom exception messages with selective inclusion of cause messagesprotected Integer
Find an order value indicated by the given object.ReactiveAdapterRegistry.getAdapter
(Class<?> reactiveType) Get the adapter for the given reactive type.ReactiveAdapterRegistry.getAdapter
(Class<?> reactiveType, Object source) Get the adapter for the given reactive type.AttributeAccessor.getAttribute
(String name) Get the value of the attribute identified byname
.AttributeAccessorSupport.getAttribute
(String name) Constructor<?>
MethodParameter.getConstructor()
Return the wrapped Constructor, if any.protected ClassLoader
ConfigurableObjectInputStream.getFallbackClassLoader()
Return the fallback ClassLoader to use when no ClassLoader was specified and ObjectInputStream's own default class loader failed.MethodParameter.getMethod()
Return the wrapped Method, if any.<A extends Annotation>
AMethodParameter.getMethodAnnotation
(Class<A> annotationType) Return the method/constructor annotation of the given type, if available.OrderComparator.OrderSourceProvider.getOrderSource
(Object obj) Return an order source for the specified object, i.e.<A extends Annotation>
AMethodParameter.getParameterAnnotation
(Class<A> annotationType) Return the parameter annotation of the given type, if available.MethodParameter.getParameterName()
Return the name of the method/constructor parameter.String[]
KotlinReflectionParameterNameDiscoverer.getParameterNames
(Constructor<?> ctor) String[]
KotlinReflectionParameterNameDiscoverer.getParameterNames
(Method method) String[]
ParameterNameDiscoverer.getParameterNames
(Constructor<?> ctor) Return parameter names for a constructor, ornull
if they cannot be determined.String[]
ParameterNameDiscoverer.getParameterNames
(Method method) Return parameter names for a method, ornull
if they cannot be determined.String[]
PrioritizedParameterNameDiscoverer.getParameterNames
(Constructor<?> ctor) String[]
PrioritizedParameterNameDiscoverer.getParameterNames
(Method method) String[]
StandardReflectionParameterNameDiscoverer.getParameterNames
(Constructor<?> ctor) String[]
StandardReflectionParameterNameDiscoverer.getParameterNames
(Method method) OrderComparator.getPriority
(Object obj) Determine a priority value for the given object, if any.static String
SpringProperties.getProperty
(String key) Retrieve the property value for the given key, checking local Spring properties first and falling back to JVM-level system properties.Class<?>
ResolvableType.getRawClass()
Return the underlying JavaClass
being managed, if available; otherwisenull
.ResolvableTypeProvider.getResolvableType()
Return theResolvableType
describing this instance (ornull
if some sort of default should be applied instead).NestedCheckedException.getRootCause()
Retrieve the innermost cause of this exception, if any.static Throwable
NestedExceptionUtils.getRootCause
(Throwable original) Retrieve the innermost cause of the given exception, if any.NestedRuntimeException.getRootCause()
Retrieve the innermost cause of this exception, if any.MethodParameter.getTypeIndexForCurrentLevel()
Return the type index for the current nesting level.MethodParameter.getTypeIndexForLevel
(int nestingLevel) Return the type index for the specified nesting level.static String
SpringVersion.getVersion()
Return the full version string of the present Spring codebase, ornull
if it cannot be determined.Perform a lookup on the given method and return associated metadata, if any.protected byte[]
OverridingClassLoader.loadBytesForClass
(String name) Load the defining bytes for the given class, to be turned into a Class object through aClassLoader.defineClass(byte[], int, int)
call.protected Class<?>
OverridingClassLoader.loadClassForOverriding
(String name) Load the specified class for overriding purposes in this ClassLoader.protected InputStream
OverridingClassLoader.openStreamForClass
(String name) Open an InputStream for the specified class.AttributeAccessor.removeAttribute
(String name) Remove the attribute identified byname
and return its value.AttributeAccessorSupport.removeAttribute
(String name) Class<?>
ResolvableType.resolve()
Resolve this type to aClass
, returningnull
if the type cannot be resolved.Class<?>
ResolvableType.resolveGeneric
(int... indexes) static Class<?>
GenericTypeResolver.resolveReturnTypeArgument
(Method method, Class<?> genericIfc) Resolve the single type argument of the given generic interface against the given target method which is assumed to return the given interface or an implementation of it.static Class<?>
GenericTypeResolver.resolveTypeArgument
(Class<?> clazz, Class<?> genericIfc) Resolve the single type argument of the given generic interface against the given target class which is assumed to implement the generic interface and possibly declare a concrete type for its type variable.static Class<?>[]
GenericTypeResolver.resolveTypeArguments
(Class<?> clazz, Class<?> genericIfc) Resolve the type arguments of the given generic interface against the given target class which is assumed to implement the generic interface and possibly declare concrete types for its type variables.Modifier and TypeMethodDescriptionstatic String
NestedExceptionUtils.buildMessage
(String message, Throwable cause) Deprecated.as of 6.0, in favor of custom exception messages with selective inclusion of cause messagesstatic String
NestedExceptionUtils.buildMessage
(String message, Throwable cause) Deprecated.as of 6.0, in favor of custom exception messages with selective inclusion of cause messagesint
int
boolean
Check whether this exception contains an exception of the given type: either it is of the given class itself or it contains a nested cause of the given type.boolean
Check whether this exception contains an exception of the given type: either it is of the given class itself or it contains a nested cause of the given type.static <E> Collection<E>
CollectionFactory.createApproximateCollection
(Object collection, int capacity) Create the most approximate collection for the given collection.static <K,
V> Map<K, V> CollectionFactory.createApproximateMap
(Object map, int capacity) Create the most approximate map for the given map.static <E> Collection<E>
CollectionFactory.createCollection
(Class<?> collectionType, Class<?> elementType, int capacity) Create the most appropriate collection for the given collection type.static <K,
V> Map<K, V> Create the most appropriate map for the given map type.boolean
boolean
boolean
boolean
boolean
boolean
Check for full equality of all type resolution artifacts: type as well asTypeProvider
andVariableResolver
.static ResolvableType
Return aResolvableType
for the specifiedClass
, using the full generic type information for assignability checks.static ResolvableType
Return aResolvableType
for the specifiedField
with a given implementation and the given nesting level.static ResolvableType
ResolvableType.forField
(Field field, ResolvableType implementationType) Return aResolvableType
for the specifiedField
with a given implementation.static ResolvableType
ResolvableType.forInstance
(Object instance) Return aResolvableType
for the specified instance.static ResolvableType
ResolvableType.forMethodParameter
(MethodParameter methodParameter, Type targetType) Return aResolvableType
for the specifiedMethodParameter
, overriding the target type to resolve with a specific given type.static ResolvableType
ResolvableType.forMethodParameter
(MethodParameter methodParameter, ResolvableType implementationType) Return aResolvableType
for the specifiedMethodParameter
with a given implementation type.static ResolvableType
ResolvableType.forRawClass
(Class<?> clazz) Return aResolvableType
for the specifiedClass
, doing assignability checks against the raw class only (analogous toClass.isAssignableFrom(java.lang.Class<?>)
, which this serves as a wrapper for).static ResolvableType
Return aResolvableType
for the specifiedType
.static ResolvableType
ResolvableType.forType
(Type type, ResolvableType owner) Return aResolvableType
for the specifiedType
backed by the given owner type.static ResolvableType
ResolvableType.forType
(Type type, ResolvableType owner) Return aResolvableType
for the specifiedType
backed by the given owner type.ReactiveAdapterRegistry.getAdapter
(Class<?> reactiveType, Object source) Get the adapter for the given reactive type.ReactiveAdapterRegistry.getAdapter
(Class<?> reactiveType, Object source) Get the adapter for the given reactive type.ResolvableType.getGeneric
(int... indexes) Return aResolvableType
representing the generic parameter for the given indexes.Deprecated.Return all names of the given group of constants.Constants.getNamesForSuffix
(String nameSuffix) Deprecated.Return all names of the given group of constants.Return aResolvableType
for the specified nesting level.protected int
Determine the order value for the given object.static Throwable
NestedExceptionUtils.getRootCause
(Throwable original) Retrieve the innermost cause of the given exception, if any.Deprecated.Return all values of the given group of constants.Constants.getValuesForSuffix
(String nameSuffix) Deprecated.Return all values of the given group of constants.static String
Conventions.getVariableNameForReturnType
(Method method, Class<?> resolvedType, Object value) Determine the conventional variable name for the return type of the given method, taking the generic collection type, if any, into account, falling back on the given return value if the method declaration is not specific enough, e.g.static String
Conventions.getVariableNameForReturnType
(Method method, Object value) Determine the conventional variable name for the return type of the given method, taking the generic collection type, if any, into account, falling back on the given actual return value if the method declaration is not specific enough, e.g.void
MethodParameter.initParameterNameDiscovery
(ParameterNameDiscoverer parameterNameDiscoverer) Initialize parameter name discovery for this method parameter.static boolean
CollectionFactory.isApproximableCollectionType
(Class<?> collectionType) Determine whether the given collection type is an approximable type, i.e.static boolean
CollectionFactory.isApproximableMapType
(Class<?> mapType) Determine whether the given map type is an approximable type, i.e.boolean
ResolvableType.isInstance
(Object obj) Determine whether the given object is an instance of thisResolvableType
.Return a variant of thisMethodParameter
which points to the same parameter but one nesting level deeper.default Class<?>
SmartClassLoader.publicDefineClass
(String name, byte[] b, ProtectionDomain protectionDomain) Define a custom class (typically a CGLIB proxy class) in this class loader.static Type
GenericTypeResolver.resolveType
(Type genericType, Class<?> contextClass) Resolve the given generic type against the given context class, substituting type variables as far as possible.void
AttributeAccessor.setAttribute
(String name, Object value) Set the attribute defined byname
to the suppliedvalue
.void
AttributeAccessorSupport.setAttribute
(String name, Object value) static void
SpringProperties.setProperty
(String key, String value) Programmatically set a local property, overriding an entry in thespring.properties
file (if any).Deprecated.Look up the given value within the given group of constants.Constants.toCodeForSuffix
(Object value, String nameSuffix) Deprecated.Look up the given value within the given group of constants.<T> Publisher<T>
ReactiveAdapter.toPublisher
(Object source) Adapt the given instance to a Reactive StreamsPublisher
.MethodParameter.withContainingClass
(Class<?> containingClass) Return a variant of thisMethodParameter
which refers to the given containing class.ModifierConstructorDescriptionConfigurableObjectInputStream
(InputStream in, ClassLoader classLoader) Create a new ConfigurableObjectInputStream for the given InputStream and ClassLoader.ConfigurableObjectInputStream
(InputStream in, ClassLoader classLoader, boolean acceptProxyClasses) Create a new ConfigurableObjectInputStream for the given InputStream and ClassLoader.DecoratingClassLoader
(ClassLoader parent) Create a new DecoratingClassLoader using the given parent ClassLoader for delegation.MethodClassKey
(Method method, Class<?> targetClass) Create a key object for the given method and target class.NestedCheckedException
(String msg, Throwable cause) Construct aNestedCheckedException
with the specified detail message and nested exception.NestedCheckedException
(String msg, Throwable cause) Construct aNestedCheckedException
with the specified detail message and nested exception.NestedRuntimeException
(String msg, Throwable cause) Construct aNestedRuntimeException
with the specified detail message and nested exception.NestedRuntimeException
(String msg, Throwable cause) Construct aNestedRuntimeException
with the specified detail message and nested exception.OverridingClassLoader
(ClassLoader parent) Create a new OverridingClassLoader for the given ClassLoader.OverridingClassLoader
(ClassLoader parent, ClassLoader overrideDelegate) Create a new OverridingClassLoader for the given ClassLoader.OverridingClassLoader
(ClassLoader parent, ClassLoader overrideDelegate) Create a new OverridingClassLoader for the given ClassLoader. -
Uses of Nullable in org.springframework.core.annotation
Modifier and TypeMethodDescriptionClass<? extends Annotation>
AnnotationAttributes.annotationType()
Get the type of annotation represented by thisAnnotationAttributes
.static <A extends Annotation>
AAnnotationUtils.findAnnotation
(Class<?> clazz, Class<A> annotationType) Find a singleAnnotation
ofannotationType
on the suppliedClass
, traversing its interfaces, annotations, and superclasses if the annotation is not directly present on the given class itself.static <A extends Annotation>
AAnnotationUtils.findAnnotation
(AnnotatedElement annotatedElement, Class<A> annotationType) static <A extends Annotation>
AAnnotationUtils.findAnnotation
(Method method, Class<A> annotationType) Find a singleAnnotation
ofannotationType
on the suppliedMethod
, traversing its super methods (i.e.static Class<?>
AnnotationUtils.findAnnotationDeclaringClass
(Class<? extends Annotation> annotationType, Class<?> clazz) Deprecated.as of 5.2 since it is superseded by theMergedAnnotations
APIstatic Class<?>
AnnotationUtils.findAnnotationDeclaringClassForTypes
(List<Class<? extends Annotation>> annotationTypes, Class<?> clazz) Deprecated.as of 5.2 since it is superseded by theMergedAnnotations
APIstatic <A extends Annotation>
AAnnotatedElementUtils.findMergedAnnotation
(AnnotatedElement element, Class<A> annotationType) Find the first annotation of the specifiedannotationType
within the annotation hierarchy above the suppliedelement
, merge that annotation's attributes with matching attributes from annotations in lower levels of the annotation hierarchy, and synthesize the result back into an annotation of the specifiedannotationType
.static AnnotationAttributes
AnnotatedElementUtils.findMergedAnnotationAttributes
(AnnotatedElement element, Class<? extends Annotation> annotationType, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Find the first annotation of the specifiedannotationType
within the annotation hierarchy above the suppliedelement
and merge that annotation's attributes with matching attributes from annotations in lower levels of the annotation hierarchy.static AnnotationAttributes
AnnotatedElementUtils.findMergedAnnotationAttributes
(AnnotatedElement element, String annotationName, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Find the first annotation of the specifiedannotationName
within the annotation hierarchy above the suppliedelement
and merge that annotation's attributes with matching attributes from annotations in lower levels of the annotation hierarchy.protected Integer
protected static Object
AnnotatedMethod.findProvidedArgument
(MethodParameter parameter, Object... providedArgs) static AnnotationAttributes
Return anAnnotationAttributes
instance based on the given map.static MultiValueMap<String,
Object> AnnotatedElementUtils.getAllAnnotationAttributes
(AnnotatedElement element, String annotationName) Get the annotation attributes of all annotations of the specifiedannotationName
in the annotation hierarchy above the suppliedAnnotatedElement
and store the results in aMultiValueMap
.static MultiValueMap<String,
Object> AnnotatedElementUtils.getAllAnnotationAttributes
(AnnotatedElement element, String annotationName, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Get the annotation attributes of all annotations of the specifiedannotationName
in the annotation hierarchy above the suppliedAnnotatedElement
and store the results in aMultiValueMap
.static <A extends Annotation>
AAnnotationUtils.getAnnotation
(Annotation annotation, Class<A> annotationType) Get a singleAnnotation
ofannotationType
from the supplied annotation: either the given annotation itself or a direct meta-annotation thereof.static <A extends Annotation>
AAnnotationUtils.getAnnotation
(AnnotatedElement annotatedElement, Class<A> annotationType) Get a singleAnnotation
ofannotationType
from the suppliedAnnotatedElement
, where the annotation is either present or meta-present on theAnnotatedElement
.static <A extends Annotation>
AAnnotationUtils.getAnnotation
(Method method, Class<A> annotationType) Get a singleAnnotation
ofannotationType
from the suppliedMethod
, where the annotation is either present or meta-present on the method.static Annotation[]
AnnotationUtils.getAnnotations
(AnnotatedElement annotatedElement) Deprecated.as of 5.2 since it is superseded by theMergedAnnotations
APIstatic Annotation[]
AnnotationUtils.getAnnotations
(Method method) Deprecated.as of 5.2 since it is superseded by theMergedAnnotations
APIstatic Object
AnnotationUtils.getDefaultValue
(Annotation annotation) Retrieve the default value of thevalue
attribute of a single-element Annotation, given an annotation instance.static Object
AnnotationUtils.getDefaultValue
(Annotation annotation, String attributeName) Retrieve the default value of a named attribute, given an annotation instance.static Object
AnnotationUtils.getDefaultValue
(Class<? extends Annotation> annotationType) Retrieve the default value of thevalue
attribute of a single-element Annotation, given theannotation type
.static Object
AnnotationUtils.getDefaultValue
(Class<? extends Annotation> annotationType, String attributeName) Retrieve the default value of a named attribute, given theannotation type
.static <A extends Annotation>
AAnnotatedElementUtils.getMergedAnnotation
(AnnotatedElement element, Class<A> annotationType) Get the first annotation of the specifiedannotationType
within the annotation hierarchy above the suppliedelement
, merge that annotation's attributes with matching attributes from annotations in lower levels of the annotation hierarchy, and synthesize the result back into an annotation of the specifiedannotationType
.static AnnotationAttributes
AnnotatedElementUtils.getMergedAnnotationAttributes
(AnnotatedElement element, Class<? extends Annotation> annotationType) Get the first annotation of the specifiedannotationType
within the annotation hierarchy above the suppliedelement
and merge that annotation's attributes with matching attributes from annotations in lower levels of the annotation hierarchy.static AnnotationAttributes
AnnotatedElementUtils.getMergedAnnotationAttributes
(AnnotatedElement element, String annotationName) Get the first annotation of the specifiedannotationName
within the annotation hierarchy above the suppliedelement
and merge that annotation's attributes with matching attributes from annotations in lower levels of the annotation hierarchy.static AnnotationAttributes
AnnotatedElementUtils.getMergedAnnotationAttributes
(AnnotatedElement element, String annotationName, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Get the first annotation of the specifiedannotationName
within the annotation hierarchy above the suppliedelement
and merge that annotation's attributes with matching attributes from annotations in lower levels of the annotation hierarchy.MergedAnnotation.getMetaSource()
Get the source of the meta-annotation, ornull
if the annotation is not meta-present.<A extends Annotation>
AAnnotatedMethod.getMethodAnnotation
(Class<A> annotationType) Return a single annotation on the underlying method, traversing its super methods if no annotation can be found on the given method itself.static Integer
Return the order on the specifiedtype
.static Integer
Return the order on the specifiedtype
, or the specified default value if none can be found.static Integer
OrderUtils.getOrder
(AnnotatedElement element) Return the order declared on the specifiedelement
.AnnotationAwareOrderComparator.getPriority
(Object obj) static Integer
OrderUtils.getPriority
(Class<?> type) Return the value of thejakarta.annotation.Priority
annotation declared on the specified type, ornull
if none.MergedAnnotation.getSource()
Get the source that ultimately declared the root annotation, ornull
if the source is not known.static Object
AnnotationUtils.getValue
(Annotation annotation) Retrieve the value of thevalue
attribute of a single-element Annotation, given an annotation instance.static Object
AnnotationUtils.getValue
(Annotation annotation, String attributeName) Retrieve the value of a named attribute, given an annotation instance.Modifier and TypeMethodDescriptionboolean
boolean
static <A extends Annotation>
AAnnotationUtils.findAnnotation
(Class<?> clazz, Class<A> annotationType) Find a singleAnnotation
ofannotationType
on the suppliedClass
, traversing its interfaces, annotations, and superclasses if the annotation is not directly present on the given class itself.static <A extends Annotation>
AAnnotationUtils.findAnnotation
(AnnotatedElement annotatedElement, Class<A> annotationType) static <A extends Annotation>
AAnnotationUtils.findAnnotation
(Method method, Class<A> annotationType) Find a singleAnnotation
ofannotationType
on the suppliedMethod
, traversing its super methods (i.e.static Class<?>
AnnotationUtils.findAnnotationDeclaringClass
(Class<? extends Annotation> annotationType, Class<?> clazz) Deprecated.as of 5.2 since it is superseded by theMergedAnnotations
APIstatic Class<?>
AnnotationUtils.findAnnotationDeclaringClassForTypes
(List<Class<? extends Annotation>> annotationTypes, Class<?> clazz) Deprecated.as of 5.2 since it is superseded by theMergedAnnotations
APIstatic <A extends Annotation>
Set<A>AnnotatedElementUtils.findMergedRepeatableAnnotations
(AnnotatedElement element, Class<A> annotationType, Class<? extends Annotation> containerType) Find all repeatable annotations of the specifiedannotationType
within the annotation hierarchy above the suppliedelement
; and for each annotation found, merge that annotation's attributes with matching attributes from annotations in lower levels of the annotation hierarchy and synthesize the results back into an annotation of the specifiedannotationType
.protected static Object
AnnotatedMethod.findProvidedArgument
(MethodParameter parameter, Object... providedArgs) static <A extends Annotation>
MergedAnnotation<A>Create a newMergedAnnotation
instance from the specified annotation.static AnnotationAttributes
Return anAnnotationAttributes
instance based on the given map.<A extends Annotation>
MergedAnnotation<A>MergedAnnotations.get
(Class<A> annotationType, Predicate<? super MergedAnnotation<A>> predicate) Get the nearest matching annotation or meta-annotation of the specified type, orMergedAnnotation.missing()
if none is present.<A extends Annotation>
MergedAnnotation<A>MergedAnnotations.get
(Class<A> annotationType, Predicate<? super MergedAnnotation<A>> predicate, MergedAnnotationSelector<A> selector) Get a matching annotation or meta-annotation of the specified type, orMergedAnnotation.missing()
if none is present.<A extends Annotation>
MergedAnnotation<A>MergedAnnotations.get
(Class<A> annotationType, Predicate<? super MergedAnnotation<A>> predicate, MergedAnnotationSelector<A> selector) Get a matching annotation or meta-annotation of the specified type, orMergedAnnotation.missing()
if none is present.<A extends Annotation>
MergedAnnotation<A>MergedAnnotations.get
(String annotationType, Predicate<? super MergedAnnotation<A>> predicate) Get the nearest matching annotation or meta-annotation of the specified type, orMergedAnnotation.missing()
if none is present.<A extends Annotation>
MergedAnnotation<A>MergedAnnotations.get
(String annotationType, Predicate<? super MergedAnnotation<A>> predicate, MergedAnnotationSelector<A> selector) Get a matching annotation or meta-annotation of the specified type, orMergedAnnotation.missing()
if none is present.<A extends Annotation>
MergedAnnotation<A>MergedAnnotations.get
(String annotationType, Predicate<? super MergedAnnotation<A>> predicate, MergedAnnotationSelector<A> selector) Get a matching annotation or meta-annotation of the specified type, orMergedAnnotation.missing()
if none is present.static AnnotationAttributes
AnnotationUtils.getAnnotationAttributes
(AnnotatedElement annotatedElement, Annotation annotation) Retrieve the given annotation's attributes as anAnnotationAttributes
map.static AnnotationAttributes
AnnotationUtils.getAnnotationAttributes
(AnnotatedElement annotatedElement, Annotation annotation, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Retrieve the given annotation's attributes as anAnnotationAttributes
map.static <A extends Annotation>
Set<A>AnnotationUtils.getDeclaredRepeatableAnnotations
(AnnotatedElement annotatedElement, Class<A> annotationType, Class<? extends Annotation> containerAnnotationType) Deprecated.as of 5.2 since it is superseded by theMergedAnnotations
APIstatic Object
AnnotationUtils.getDefaultValue
(Annotation annotation, String attributeName) Retrieve the default value of a named attribute, given an annotation instance.static Object
AnnotationUtils.getDefaultValue
(Annotation annotation, String attributeName) Retrieve the default value of a named attribute, given an annotation instance.static Object
AnnotationUtils.getDefaultValue
(Class<? extends Annotation> annotationType, String attributeName) Retrieve the default value of a named attribute, given theannotation type
.static Object
AnnotationUtils.getDefaultValue
(Class<? extends Annotation> annotationType, String attributeName) Retrieve the default value of a named attribute, given theannotation type
.static <A extends Annotation>
Set<A>AnnotatedElementUtils.getMergedRepeatableAnnotations
(AnnotatedElement element, Class<A> annotationType, Class<? extends Annotation> containerType) Get all repeatable annotations of the specifiedannotationType
within the annotation hierarchy above the suppliedelement
; and for each annotation found, merge that annotation's attributes with matching attributes from annotations in lower levels of the annotation hierarchy and synthesize the results back into an annotation of the specifiedannotationType
.static Integer
Return the order on the specifiedtype
, or the specified default value if none can be found.static <A extends Annotation>
Set<A>AnnotationUtils.getRepeatableAnnotations
(AnnotatedElement annotatedElement, Class<A> annotationType, Class<? extends Annotation> containerAnnotationType) Deprecated.as of 5.2 since it is superseded by theMergedAnnotations
APIAnnotatedMethod.getReturnValueType
(Object returnValue) Return aMethodParameter
for the actual return value type.static Object
AnnotationUtils.getValue
(Annotation annotation, String attributeName) Retrieve the value of a named attribute, given an annotation instance.static Object
AnnotationUtils.getValue
(Annotation annotation, String attributeName) Retrieve the value of a named attribute, given an annotation instance.static boolean
AnnotationUtils.isAnnotationMetaPresent
(Class<? extends Annotation> annotationType, Class<? extends Annotation> metaAnnotationType) Deprecated.as of 5.2 since it is superseded by theMergedAnnotations
APIstatic boolean
AnnotationUtils.isCandidateClass
(Class<?> clazz, Class<? extends Annotation> annotationType) Determine whether the given class is a candidate for carrying the specified annotation (at type, method or field level).static boolean
AnnotationUtils.isInJavaLangAnnotationPackage
(Annotation annotation) Determine if the suppliedAnnotation
is defined in the core JDKjava.lang.annotation
package.static boolean
AnnotationUtils.isInJavaLangAnnotationPackage
(String annotationType) Determine if theAnnotation
with the supplied name is defined in the core JDKjava.lang.annotation
package.static boolean
AnnotationUtils.isSynthesizedAnnotation
(Annotation annotation) Determine if the suppliedAnnotation
has been synthesized by Spring (i.e.static <A extends Annotation>
MergedAnnotation<A>Create a newMergedAnnotation
instance of the specified annotation type with attribute values supplied by a map.static <A extends Annotation>
MergedAnnotation<A>MergedAnnotation.of
(ClassLoader classLoader, Object source, Class<A> annotationType, Map<String, ?> attributes) Create a newMergedAnnotation
instance of the specified annotation type with attribute values supplied by a map.static <A extends Annotation>
MergedAnnotation<A>MergedAnnotation.of
(ClassLoader classLoader, Object source, Class<A> annotationType, Map<String, ?> attributes) Create a newMergedAnnotation
instance of the specified annotation type with attribute values supplied by a map.static <A extends Annotation>
MergedAnnotation<A>MergedAnnotation.of
(ClassLoader classLoader, Object source, Class<A> annotationType, Map<String, ?> attributes) Create a newMergedAnnotation
instance of the specified annotation type with attribute values supplied by a map.static <A extends Annotation>
MergedAnnotation<A>MergedAnnotation.of
(AnnotatedElement source, Class<A> annotationType, Map<String, ?> attributes) Create a newMergedAnnotation
instance of the specified annotation type with attribute values supplied by a map.static <A extends Annotation>
MergedAnnotation<A>MergedAnnotation.of
(AnnotatedElement source, Class<A> annotationType, Map<String, ?> attributes) Create a newMergedAnnotation
instance of the specified annotation type with attribute values supplied by a map.static RepeatableContainers
RepeatableContainers.of
(Class<? extends Annotation> repeatable, Class<? extends Annotation> container) Create aRepeatableContainers
instance that uses predefined repeatable and container types.static void
AnnotationUtils.postProcessAnnotationAttributes
(Object annotatedElement, AnnotationAttributes attributes, boolean classValuesAsString) Post-process the suppliedAnnotationAttributes
, preserving nested annotations asAnnotation
instances.static void
AnnotationUtils.postProcessAnnotationAttributes
(Object annotatedElement, AnnotationAttributes attributes, boolean classValuesAsString) Post-process the suppliedAnnotationAttributes
, preserving nested annotations asAnnotation
instances.static <A extends Annotation>
AAnnotationUtils.synthesizeAnnotation
(A annotation, AnnotatedElement annotatedElement) Synthesize an annotation from the suppliedannotation
by wrapping it in a dynamic proxy that transparently enforces attribute alias semantics for annotation attributes that are annotated with@AliasFor
.static <A extends Annotation>
AAnnotationUtils.synthesizeAnnotation
(Map<String, Object> attributes, Class<A> annotationType, AnnotatedElement annotatedElement) Synthesize an annotation from the supplied map of annotation attributes by wrapping the map in a dynamic proxy that implements an annotation of the specifiedannotationType
and transparently enforces attribute alias semantics for annotation attributes that are annotated with@AliasFor
.ModifierConstructorDescriptionAnnotationAttributes
(String annotationType, ClassLoader classLoader) Create a new, emptyAnnotationAttributes
instance for the specifiedannotationType
. -
Uses of Nullable in org.springframework.core.codec
Modifier and TypeMethodDescriptiondefault T
Decoder.decode
(DataBuffer buffer, ResolvableType targetType, MimeType mimeType, Map<String, Object> hints) Decode a data buffer to an Object of type T.protected T
AbstractDataBufferDecoder.decodeDataBuffer
(DataBuffer buffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Deprecated.as of 5.2, please implementDecoder.decode(DataBuffer, ResolvableType, MimeType, Map)
insteadModifier and TypeMethodDescriptionboolean
AbstractDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
ByteArrayDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
ByteBufferDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
DataBufferDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
Decoder.canDecode
(ResolvableType elementType, MimeType mimeType) Whether the decoder supports the given target element type and the MIME type of the source stream.boolean
Netty5BufferDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
NettyByteBufDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
ResourceDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
StringDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
AbstractEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) boolean
ByteArrayEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) boolean
ByteBufferEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) boolean
CharSequenceEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) boolean
DataBufferEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) boolean
Encoder.canEncode
(ResolvableType elementType, MimeType mimeType) Whether the encoder supports the given source element type and the MIME type for the output stream.boolean
Netty5BufferEncoder.canEncode
(ResolvableType type, MimeType mimeType) boolean
NettyByteBufEncoder.canEncode
(ResolvableType type, MimeType mimeType) boolean
ResourceEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) boolean
ResourceRegionEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) reactor.core.publisher.Flux<T>
AbstractDataBufferDecoder.decode
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<T>
AbstractDataBufferDecoder.decode
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) byte[]
ByteArrayDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) byte[]
ByteArrayDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) ByteBufferDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) ByteBufferDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
DataBufferDecoder.decode
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
DataBufferDecoder.decode
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) DataBufferDecoder.decode
(DataBuffer buffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) DataBufferDecoder.decode
(DataBuffer buffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<T>
Decoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Decode aDataBuffer
input stream into a Flux ofT
.reactor.core.publisher.Flux<T>
Decoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Decode aDataBuffer
input stream into a Flux ofT
.default T
Decoder.decode
(DataBuffer buffer, ResolvableType targetType, MimeType mimeType, Map<String, Object> hints) Decode a data buffer to an Object of type T.default T
Decoder.decode
(DataBuffer buffer, ResolvableType targetType, MimeType mimeType, Map<String, Object> hints) Decode a data buffer to an Object of type T.io.netty5.buffer.Buffer
Netty5BufferDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) io.netty5.buffer.Buffer
Netty5BufferDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) io.netty.buffer.ByteBuf
NettyByteBufDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) io.netty.buffer.ByteBuf
NettyByteBufDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<Resource>
ResourceDecoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<Resource>
ResourceDecoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) ResourceDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) ResourceDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<String>
StringDecoder.decode
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<String>
StringDecoder.decode
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) StringDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) StringDecoder.decode
(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) protected T
AbstractDataBufferDecoder.decodeDataBuffer
(DataBuffer buffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Deprecated.as of 5.2, please implementDecoder.decode(DataBuffer, ResolvableType, MimeType, Map)
insteadprotected T
AbstractDataBufferDecoder.decodeDataBuffer
(DataBuffer buffer, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Deprecated.as of 5.2, please implementDecoder.decode(DataBuffer, ResolvableType, MimeType, Map)
insteadreactor.core.publisher.Mono<T>
AbstractDataBufferDecoder.decodeToMono
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<T>
AbstractDataBufferDecoder.decodeToMono
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<T>
AbstractDecoder.decodeToMono
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<T>
AbstractDecoder.decodeToMono
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<T>
Decoder.decodeToMono
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Decode aDataBuffer
input stream into a Mono ofT
.reactor.core.publisher.Mono<T>
Decoder.decodeToMono
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Decode aDataBuffer
input stream into a Mono ofT
.final reactor.core.publisher.Flux<DataBuffer>
AbstractSingleValueEncoder.encode
(Publisher<? extends T> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) final reactor.core.publisher.Flux<DataBuffer>
AbstractSingleValueEncoder.encode
(Publisher<? extends T> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) protected abstract reactor.core.publisher.Flux<DataBuffer>
AbstractSingleValueEncoder.encode
(T t, DataBufferFactory dataBufferFactory, ResolvableType type, MimeType mimeType, Map<String, Object> hints) EncodeT
to an outputDataBuffer
stream.protected abstract reactor.core.publisher.Flux<DataBuffer>
AbstractSingleValueEncoder.encode
(T t, DataBufferFactory dataBufferFactory, ResolvableType type, MimeType mimeType, Map<String, Object> hints) EncodeT
to an outputDataBuffer
stream.reactor.core.publisher.Flux<DataBuffer>
ByteArrayEncoder.encode
(Publisher<? extends byte[]> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
ByteArrayEncoder.encode
(Publisher<? extends byte[]> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
ByteBufferEncoder.encode
(Publisher<? extends ByteBuffer> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
ByteBufferEncoder.encode
(Publisher<? extends ByteBuffer> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
CharSequenceEncoder.encode
(Publisher<? extends CharSequence> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
CharSequenceEncoder.encode
(Publisher<? extends CharSequence> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
DataBufferEncoder.encode
(Publisher<? extends DataBuffer> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
DataBufferEncoder.encode
(Publisher<? extends DataBuffer> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
Encoder.encode
(Publisher<? extends T> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Encode a stream of Objects of typeT
into aDataBuffer
output stream.reactor.core.publisher.Flux<DataBuffer>
Encoder.encode
(Publisher<? extends T> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Encode a stream of Objects of typeT
into aDataBuffer
output stream.reactor.core.publisher.Flux<DataBuffer>
Netty5BufferEncoder.encode
(Publisher<? extends io.netty5.buffer.Buffer> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
Netty5BufferEncoder.encode
(Publisher<? extends io.netty5.buffer.Buffer> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
NettyByteBufEncoder.encode
(Publisher<? extends io.netty.buffer.ByteBuf> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
NettyByteBufEncoder.encode
(Publisher<? extends io.netty.buffer.ByteBuf> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) protected reactor.core.publisher.Flux<DataBuffer>
ResourceEncoder.encode
(Resource resource, DataBufferFactory bufferFactory, ResolvableType type, MimeType mimeType, Map<String, Object> hints) protected reactor.core.publisher.Flux<DataBuffer>
ResourceEncoder.encode
(Resource resource, DataBufferFactory bufferFactory, ResolvableType type, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
ResourceRegionEncoder.encode
(Publisher<? extends ResourceRegion> input, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
ResourceRegionEncoder.encode
(Publisher<? extends ResourceRegion> input, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) ByteArrayEncoder.encodeValue
(byte[] bytes, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) ByteArrayEncoder.encodeValue
(byte[] bytes, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) ByteBufferEncoder.encodeValue
(ByteBuffer byteBuffer, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) ByteBufferEncoder.encodeValue
(ByteBuffer byteBuffer, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) CharSequenceEncoder.encodeValue
(CharSequence charSequence, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) CharSequenceEncoder.encodeValue
(CharSequence charSequence, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) DataBufferEncoder.encodeValue
(DataBuffer buffer, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) DataBufferEncoder.encodeValue
(DataBuffer buffer, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) default DataBuffer
Encoder.encodeValue
(T value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) Encode an Object of type T to a data buffer.default DataBuffer
Encoder.encodeValue
(T value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) Encode an Object of type T to a data buffer.Netty5BufferEncoder.encodeValue
(io.netty5.buffer.Buffer buffer, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) Netty5BufferEncoder.encodeValue
(io.netty5.buffer.Buffer buffer, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) NettyByteBufEncoder.encodeValue
(io.netty.buffer.ByteBuf byteBuf, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) NettyByteBufEncoder.encodeValue
(io.netty.buffer.ByteBuf byteBuf, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) static String
Hints.getLogPrefix
(Map<String, Object> hints) Obtain the hintHints.LOG_PREFIX_HINT
, if present, or an empty String.static <T> T
Hints.getRequiredHint
(Map<String, Object> hints, String hintName) Obtain the value for a required hint.static boolean
Hints.isLoggingSuppressed
(Map<String, Object> hints) Whether to suppress logging based on the hintHints.SUPPRESS_LOGGING_HINT
.Merge a single hint into a map of hints, possibly creating and copying all hints into a new map, or otherwise if the map of hints is empty, creating a new single entry map.Merge two maps of hints, creating and copying into a new map if both have values, or returning the non-empty map, or an empty map if both are empty.Merge two maps of hints, creating and copying into a new map if both have values, or returning the non-empty map, or an empty map if both are empty.static void
Hints.touchDataBuffer
(DataBuffer buffer, Map<String, Object> hints, Log logger) If the hints contain aHints.LOG_PREFIX_HINT
and the given logger has DEBUG level enabled, apply the log prefix as a hint to the given buffer viaDataBufferUtils.touch(DataBuffer, Object)
.ModifierConstructorDescriptionCodecException
(String msg, Throwable cause) Create a new CodecException.DecodingException
(String msg, Throwable cause) Create a new DecodingException.EncodingException
(String msg, Throwable cause) Create a new EncodingException. -
Uses of Nullable in org.springframework.core.convert
Modifier and TypeMethodDescriptionstatic TypeDescriptor
TypeDescriptor.array
(TypeDescriptor elementTypeDescriptor) Create a new type descriptor as an array of the specified type.<T> T
Convert the givensource
to the specifiedtargetType
.default Object
ConversionService.convert
(Object source, TypeDescriptor targetType) Convert the givensource
to the specifiedtargetType
.ConversionService.convert
(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) Convert the givensource
to the specifiedtargetType
.TypeDescriptor.elementTypeDescriptor
(Object element) If this type is aCollection
or an array, creates an element TypeDescriptor from the provided collection or array element.static TypeDescriptor
Create a new type descriptor for an object.<T extends Annotation>
TTypeDescriptor.getAnnotation
(Class<T> annotationType) Obtain the annotation of the specifiedannotationType
that is on this type descriptor.TypeDescriptor.getElementTypeDescriptor()
If this type is an array, returns the array's component type.TypeDescriptor.getMapKeyTypeDescriptor()
If this type is aMap
and its key type is parameterized, returns the map's key type.TypeDescriptor.getMapKeyTypeDescriptor
(Object mapKey) If this type is aMap
, creates a mapKeyTypeDescriptor
from the provided map key.TypeDescriptor.getMapValueTypeDescriptor()
If this type is aMap
and its value type is parameterized, returns the map's value type.TypeDescriptor.getMapValueTypeDescriptor
(Object mapValue) If this type is aMap
, creates a mapValueTypeDescriptor
from the provided map value.Property.getReadMethod()
The property getter method: e.g.ConversionFailedException.getSourceType()
Return the source type we tried to convert the value from.ConverterNotFoundException.getSourceType()
Return the source type that was requested to convert from.ConversionFailedException.getValue()
Return the offending value.Property.getWriteMethod()
The property setter method: e.g.static TypeDescriptor
Create a type descriptor for a nested type declared within the field.static TypeDescriptor
Create a type descriptor for a nested type declared within the property.static TypeDescriptor
TypeDescriptor.nested
(MethodParameter methodParameter, int nestingLevel) Create a type descriptor for a nested type declared within the method parameter.Cast thisTypeDescriptor
to a superclass or implemented interface preserving annotations and nested type context.Modifier and TypeMethodDescriptionstatic TypeDescriptor
TypeDescriptor.array
(TypeDescriptor elementTypeDescriptor) Create a new type descriptor as an array of the specified type.boolean
ConversionService.canConvert
(Class<?> sourceType, Class<?> targetType) Returntrue
if objects ofsourceType
can be converted to thetargetType
.boolean
ConversionService.canConvert
(TypeDescriptor sourceType, TypeDescriptor targetType) Returntrue
if objects ofsourceType
can be converted to thetargetType
.static TypeDescriptor
TypeDescriptor.collection
(Class<?> collectionType, TypeDescriptor elementTypeDescriptor) Create a new type descriptor from aCollection
type.<T> T
Convert the givensource
to the specifiedtargetType
.default Object
ConversionService.convert
(Object source, TypeDescriptor targetType) Convert the givensource
to the specifiedtargetType
.ConversionService.convert
(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) Convert the givensource
to the specifiedtargetType
.ConversionService.convert
(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) Convert the givensource
to the specifiedtargetType
.boolean
boolean
static TypeDescriptor
Create a new type descriptor for an object.static TypeDescriptor
TypeDescriptor.map
(Class<?> mapType, TypeDescriptor keyTypeDescriptor, TypeDescriptor valueTypeDescriptor) Create a new type descriptor from aMap
type.static TypeDescriptor
TypeDescriptor.map
(Class<?> mapType, TypeDescriptor keyTypeDescriptor, TypeDescriptor valueTypeDescriptor) Create a new type descriptor from aMap
type.Narrows thisTypeDescriptor
by setting its type to the class of the provided value.Cast thisTypeDescriptor
to a superclass or implemented interface preserving annotations and nested type context.static TypeDescriptor
Create a new type descriptor from the given type.ModifierConstructorDescriptionConversionFailedException
(TypeDescriptor sourceType, TypeDescriptor targetType, Object value, Throwable cause) Create a new conversion exception.ConversionFailedException
(TypeDescriptor sourceType, TypeDescriptor targetType, Object value, Throwable cause) Create a new conversion exception.ConverterNotFoundException
(TypeDescriptor sourceType, TypeDescriptor targetType) Create a new conversion executor not found exception.TypeDescriptor
(ResolvableType resolvableType, Class<?> type, Annotation[] annotations) Create a new type descriptor from aResolvableType
.TypeDescriptor
(ResolvableType resolvableType, Class<?> type, Annotation[] annotations) Create a new type descriptor from aResolvableType
. -
Uses of Nullable in org.springframework.core.convert.converter
Modifier and TypeMethodDescriptionConvert the source object of typeS
to target typeT
.GenericConverter.convert
(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) Convert the source object to the targetType described by theTypeDescriptor
.GenericConverter.getConvertibleTypes()
Return the source and target types that this converter can convert between.Modifier and TypeMethodDescriptionGenericConverter.convert
(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) Convert the source object to the targetType described by theTypeDescriptor
.boolean
-
Uses of Nullable in org.springframework.core.convert.support
Modifier and TypeMethodDescription<T> T
GenericConversionService.convert
(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) protected Object
GenericConversionService.convertNullSource
(TypeDescriptor sourceType, TypeDescriptor targetType) Template method to convert anull
source.ConvertingPropertyEditorAdapter.getAsText()
protected GenericConverter
GenericConversionService.getConverter
(TypeDescriptor sourceType, TypeDescriptor targetType) Hook method to look up the converter for a given sourceType/targetType pair.protected GenericConverter
GenericConversionService.getDefaultConverter
(TypeDescriptor sourceType, TypeDescriptor targetType) Return the default converter if no converter is found for the given sourceType/targetType pair.Modifier and TypeMethodDescriptionboolean
GenericConversionService.canBypassConvert
(TypeDescriptor sourceType, TypeDescriptor targetType) Return whether conversion between the source type and the target type can be bypassed.boolean
GenericConversionService.canConvert
(Class<?> sourceType, Class<?> targetType) boolean
GenericConversionService.canConvert
(TypeDescriptor sourceType, TypeDescriptor targetType) <T> T
GenericConversionService.convert
(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) GenericConversionService.convert
(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) protected Object
GenericConversionService.convertNullSource
(TypeDescriptor sourceType, TypeDescriptor targetType) Template method to convert anull
source.static void
ConversionServiceFactory.registerConverters
(Set<?> converters, ConverterRegistry registry) Register the given Converter objects with the given target ConverterRegistry.void
-
Uses of Nullable in org.springframework.core.env
Modifier and TypeMethodDescriptionprotected <T> T
AbstractPropertyResolver.convertValueIfNecessary
(Object value, Class<T> targetType) Convert the given value to the specified target type, if necessary.protected String
AbstractEnvironment.doGetActiveProfilesProperty()
Return the property value for the active profiles.protected String
AbstractEnvironment.doGetDefaultProfilesProperty()
Return the property value for the default profiles.Return the property source with the given name,null
if not found.CommandLinePropertySource.getOptionValues
(String name) Return the collection of values associated with the command line option having the given name.JOptCommandLinePropertySource.getOptionValues
(String name) SimpleCommandLinePropertySource.getOptionValues
(String name) AbstractEnvironment.getProperty
(String key) <T> T
AbstractEnvironment.getProperty
(String key, Class<T> targetType) AbstractPropertyResolver.getProperty
(String key) final String
CommandLinePropertySource.getProperty
(String name) This implementation first checks to see if the name specified is the special "non-option arguments" property, and if so delegates to the abstractCommandLinePropertySource.getNonOptionArgs()
method.CompositePropertySource.getProperty
(String name) MapPropertySource.getProperty
(String name) PropertyResolver.getProperty
(String key) Return the property value associated with the given key, ornull
if the key cannot be resolved.<T> T
PropertyResolver.getProperty
(String key, Class<T> targetType) Return the property value associated with the given key, ornull
if the key cannot be resolved.abstract Object
PropertySource.getProperty
(String name) Return the value associated with the given name, ornull
if not found.PropertySource.StubPropertySource.getProperty
(String name) Always returnsnull
.PropertySourcesPropertyResolver.getProperty
(String key) <T> T
PropertySourcesPropertyResolver.getProperty
(String key, Class<T> targetValueType) protected <T> T
PropertySourcesPropertyResolver.getProperty
(String key, Class<T> targetValueType, boolean resolveNestedPlaceholders) SystemEnvironmentPropertySource.getProperty
(String name) This implementation returnstrue
if a property with the given name or any underscore/uppercase variant thereof exists in this property source.protected abstract String
AbstractPropertyResolver.getPropertyAsRawString
(String key) Retrieve the specified property as a raw String, i.e.protected String
PropertySourcesPropertyResolver.getPropertyAsRawString
(String key) Remove and return the property source with the given name,null
if not found.Modifier and TypeMethodDescriptionprotected <T> T
AbstractPropertyResolver.convertValueIfNecessary
(Object value, Class<T> targetType) Convert the given value to the specified target type, if necessary.boolean
ThisPropertySource
object is equal to the given object if: they are the same instance thename
properties for both objects are equalvoid
AbstractEnvironment.setValueSeparator
(String valueSeparator) void
AbstractPropertyResolver.setValueSeparator
(String valueSeparator) Specify the separating character between the placeholders replaced by this resolver and their associated default value, ornull
if no such special character should be processed as a value separator.void
ConfigurablePropertyResolver.setValueSeparator
(String valueSeparator) Specify the separating character between the placeholders replaced by this resolver and their associated default value, ornull
if no such special character should be processed as a value separator.ModifierConstructorDescriptionPropertySourcesPropertyResolver
(PropertySources propertySources) Create a new resolver against the given property sources. -
Uses of Nullable in org.springframework.core.io
Modifier and TypeMethodDescriptionprotected static String
protected static Object
VfsUtils.doGetVisitorAttributes()
ResourceEditor.getAsText()
final ClassLoader
ClassPathResource.getClassLoader()
Return theClassLoader
that this resource will be obtained from.DefaultResourceLoader.getClassLoader()
Return the ClassLoader to load class path resources with.ResourceLoader.getClassLoader()
Expose theClassLoader
used by thisResourceLoader
.AbstractResource.getFilename()
This implementation always returnsnull
, assuming that this resource type does not have a filename.ClassPathResource.getFilename()
This implementation returns the name of the file that this class path resource refers to.ModuleResource.getFilename()
Resource.getFilename()
Determine the filename for this resource — typically the last part of the path — for example,"myfile.txt"
.UrlResource.getFilename()
This implementation returns the URL-decoded name of the file that this URL refers to.ProtocolResolver.resolve
(String location, ResourceLoader resourceLoader) Resolve the given location against the given resource loader if this implementation's protocol matches.protected URL
ClassPathResource.resolveURL()
Resolves aURL
for the underlying class path resource.Modifier and TypeMethodDescriptionboolean
This implementation compares description strings.boolean
This implementation compares the underlying byte array.boolean
This implementation compares the underlying class path locations and associated class loaders.boolean
This implementation compares the underlying description String.boolean
This implementation compares the underlying file paths.boolean
This implementation compares the underlying InputStream.boolean
boolean
This implementation compares the underlyingPath
references.boolean
This implementation compares the underlying URL references.boolean
protected static Object
VfsUtils.invokeVfsMethod
(Method method, Object target, Object... args) void
DefaultResourceLoader.setClassLoader
(ClassLoader classLoader) Specify the ClassLoader to load class path resources with, ornull
for using the thread context class loader at the time of actual resource access.ModifierConstructorDescriptionByteArrayResource
(byte[] byteArray, String description) Create a newByteArrayResource
with a description.ClassPathContextResource
(String path, ClassLoader classLoader) ClassPathResource
(String path, Class<?> clazz) Create a newClassPathResource
forClass
usage.ClassPathResource
(String path, ClassLoader classLoader) Create a newClassPathResource
forClassLoader
usage.DefaultResourceLoader
(ClassLoader classLoader) Create a new DefaultResourceLoader.DescriptiveResource
(String description) Create a new DescriptiveResource.InputStreamResource
(InputStream inputStream, String description) Create a new InputStreamResource.ResourceEditor
(ResourceLoader resourceLoader, PropertyResolver propertyResolver) Create a new instance of theResourceEditor
class using the givenResourceLoader
andPropertyResolver
.ResourceEditor
(ResourceLoader resourceLoader, PropertyResolver propertyResolver, boolean ignoreUnresolvablePlaceholders) Create a new instance of theResourceEditor
class using the givenResourceLoader
.UrlResource
(String protocol, String location, String fragment) Create a newUrlResource
based on a URI specification. -
Uses of Nullable in org.springframework.core.io.buffer
-
Uses of Nullable in org.springframework.core.io.support
Modifier and TypeMethodDescriptionPropertySourceDescriptor.encoding()
Returns the value of theencoding
record component.final Charset
EncodedResource.getCharset()
PathMatchingResourcePatternResolver.getClassLoader()
final String
EncodedResource.getEncoding()
Return the encoding to use for reading from the resource, ornull
if none specified.protected <T> T
SpringFactoriesLoader.instantiateFactory
(String implementationName, Class<T> type, SpringFactoriesLoader.ArgumentResolver argumentResolver, SpringFactoriesLoader.FailureHandler failureHandler) PropertySourceDescriptor.name()
Returns the value of thename
record component.Class<? extends PropertySourceFactory>
PropertySourceDescriptor.propertySourceFactory()
Returns the value of thepropertySourceFactory
record component.<T> T
Resolve the given argument if possible.Modifier and TypeMethodDescriptionprotected void
PathMatchingResourcePatternResolver.addAllClassLoaderJarRoots
(ClassLoader classLoader, Set<Resource> result) Search allURLClassLoader
URLs for jar file references and add them to the given set of resources in the form of pointers to the root of the jar file content.DefaultPropertySourceFactory.createPropertySource
(String name, EncodedResource resource) PropertySourceFactory.createPropertySource
(String name, EncodedResource resource) Create aPropertySource
that wraps the given resource.boolean
LocalizedResourceHelper.findLocalizedResource
(String name, String extension, Locale locale) Find the most specific localized resource for the given name, extension and locale:static SpringFactoriesLoader
SpringFactoriesLoader.forDefaultResourceLocation
(ClassLoader classLoader) Create aSpringFactoriesLoader
instance that will load and instantiate the factory implementations from "META-INF/spring.factories", using the given class loader.static SpringFactoriesLoader
SpringFactoriesLoader.forResourceLocation
(String resourceLocation, ClassLoader classLoader) Create aSpringFactoriesLoader
instance that will load and instantiate the factory implementations from the given location, using the given class loader.static ResourcePatternResolver
ResourcePatternUtils.getResourcePatternResolver
(ResourceLoader resourceLoader) Return a defaultResourcePatternResolver
for the givenResourceLoader
.protected <T> T
SpringFactoriesLoader.instantiateFactory
(String implementationName, Class<T> type, SpringFactoriesLoader.ArgumentResolver argumentResolver, SpringFactoriesLoader.FailureHandler failureHandler) static boolean
Return whether the given resource location is a URL: either a special "classpath" or "classpath*" pseudo URL or a standard URL.<T> List<T>
SpringFactoriesLoader.load
(Class<T> factoryType, SpringFactoriesLoader.ArgumentResolver argumentResolver) Load and instantiate the factory implementations of the given type from "META-INF/spring.factories", using the configured class loader and the given argument resolver.<T> List<T>
SpringFactoriesLoader.load
(Class<T> factoryType, SpringFactoriesLoader.ArgumentResolver argumentResolver, SpringFactoriesLoader.FailureHandler failureHandler) Load and instantiate the factory implementations of the given type from "META-INF/spring.factories", using the configured class loader, the given argument resolver, and custom failure handling provided by the given failure handler.<T> List<T>
SpringFactoriesLoader.load
(Class<T> factoryType, SpringFactoriesLoader.ArgumentResolver argumentResolver, SpringFactoriesLoader.FailureHandler failureHandler) Load and instantiate the factory implementations of the given type from "META-INF/spring.factories", using the configured class loader, the given argument resolver, and custom failure handling provided by the given failure handler.<T> List<T>
SpringFactoriesLoader.load
(Class<T> factoryType, SpringFactoriesLoader.FailureHandler failureHandler) Load and instantiate the factory implementations of the given type from "META-INF/spring.factories", using the configured class loader with custom failure handling provided by the given failure handler.static Properties
PropertiesLoaderUtils.loadAllProperties
(String resourceName, ClassLoader classLoader) Load all properties from the specified class path resource (in ISO-8859-1 encoding), using the given class loader.static <T> List<T>
SpringFactoriesLoader.loadFactories
(Class<T> factoryType, ClassLoader classLoader) Load and instantiate the factory implementations of the given type from "META-INF/spring.factories", using the given class loader.SpringFactoriesLoader.loadFactoryNames
(Class<?> factoryType, ClassLoader classLoader) Deprecated.as of 6.0 in favor ofSpringFactoriesLoader.load(Class, ArgumentResolver, FailureHandler)
void
PropertiesLoaderSupport.setPropertiesPersister
(PropertiesPersister propertiesPersister) Set the PropertiesPersister to use for parsing properties files.void
LocalizedResourceHelper.setSeparator
(String separator) Set the separator to use in-between file name parts.ModifierConstructorDescriptionEncodedResource
(Resource resource, String encoding) Create a newEncodedResource
for the givenResource
, using the specifiedencoding
.EncodedResource
(Resource resource, Charset charset) Create a newEncodedResource
for the givenResource
, using the specifiedCharset
.PathMatchingResourcePatternResolver
(ClassLoader classLoader) Create a new PathMatchingResourcePatternResolver with a DefaultResourceLoader.PropertySourceDescriptor
(List<String> locations, boolean ignoreResourceNotFound, String name, Class<? extends PropertySourceFactory> propertySourceFactory, String encoding) Creates an instance of aPropertySourceDescriptor
record class.PropertySourceDescriptor
(List<String> locations, boolean ignoreResourceNotFound, String name, Class<? extends PropertySourceFactory> propertySourceFactory, String encoding) Creates an instance of aPropertySourceDescriptor
record class.PropertySourceDescriptor
(List<String> locations, boolean ignoreResourceNotFound, String name, Class<? extends PropertySourceFactory> propertySourceFactory, String encoding) Creates an instance of aPropertySourceDescriptor
record class.ResourceArrayPropertyEditor
(ResourcePatternResolver resourcePatternResolver, PropertyResolver propertyResolver) Create a new ResourceArrayPropertyEditor with the givenResourcePatternResolver
andPropertyResolver
(typically anEnvironment
).ResourceArrayPropertyEditor
(ResourcePatternResolver resourcePatternResolver, PropertyResolver propertyResolver, boolean ignoreUnresolvablePlaceholders) Create a new ResourceArrayPropertyEditor with the givenResourcePatternResolver
andPropertyResolver
(typically anEnvironment
).protected
SpringFactoriesLoader
(ClassLoader classLoader, Map<String, List<String>> factories) Create a newSpringFactoriesLoader
instance. -
Uses of Nullable in org.springframework.core.log
Modifier and TypeMethodDescriptionstatic LogMessage
Build a lazily formatted message from the given format string and argument.static LogMessage
Build a lazily formatted message from the given format string and varargs.static LogMessage
Build a lazily formatted message from the given format string and arguments.static LogMessage
Build a lazily formatted message from the given format string and arguments.static LogMessage
Build a lazily formatted message from the given format string and arguments.static LogMessage
Build a lazily formatted message from the given format string and arguments.static LogMessage
Build a lazily formatted message from the given format string and arguments.static LogMessage
Build a lazily formatted message from the given format string and arguments.static LogMessage
Build a lazily formatted message from the given format string and arguments.static LogMessage
Build a lazily formatted message from the given format string and arguments.static LogMessage
Build a lazily formatted message from the given format string and arguments.static String
LogFormatUtils.formatValue
(Object value, boolean limitLength) Convenience variant ofLogFormatUtils.formatValue(Object, int, boolean)
that limits the length of a log message to 100 characters and also replaces newline and control characters iflimitLength
is set to "true".static String
LogFormatUtils.formatValue
(Object value, int maxLength, boolean replaceNewlinesAndControlCharacters) Format the given value viatoString()
, quoting it if it is aCharSequence
, truncating at the specifiedmaxLength
, and compacting it into a single line whenreplaceNewLines
is set. -
Uses of Nullable in org.springframework.core.metrics
Modifier and TypeMethodDescriptionStartupStep.getParentId()
Return, if available, the id of the parent step. -
Uses of Nullable in org.springframework.core.serializer
-
Uses of Nullable in org.springframework.core.serializer.support
-
Uses of Nullable in org.springframework.core.style
Modifier and TypeMethodDescriptionAppend a field value.Style the given value, returning a String representation.void
DefaultToStringStyler.styleField
(StringBuilder buffer, String fieldName, Object value) void
ToStringStyler.styleField
(StringBuilder buffer, String fieldName, Object value) Style a field value as a string.void
DefaultToStringStyler.styleValue
(StringBuilder buffer, Object value) ModifierConstructorDescriptionToStringCreator
(Object obj, ToStringStyler styler) Create a ToStringCreator for the given object, using the provided style.ToStringCreator
(Object obj, ValueStyler styler) Create a ToStringCreator for the given object, using the provided style. -
Uses of Nullable in org.springframework.core.task
Modifier and TypeMethodDescriptionfinal ThreadFactory
SimpleAsyncTaskExecutor.getThreadFactory()
Return the external factory to use for creating new Threads, if any.Modifier and TypeMethodDescriptionvoid
SimpleAsyncTaskExecutor.setThreadFactory
(ThreadFactory threadFactory) Specify an external factory to use for creating new Threads, instead of relying on the local properties of this executor. -
Uses of Nullable in org.springframework.core.task.support
Modifier and TypeMethodDescriptionprotected void
TaskExecutorAdapter.doExecute
(Executor concurrentExecutor, TaskDecorator taskDecorator, Runnable runnable) Actually execute the givenRunnable
(which may be a user-supplied task or a wrapper around a user-supplied task) with the given executor. -
Uses of Nullable in org.springframework.core.test.io.support
Modifier and TypeMethodDescriptionprotected <T> T
MockSpringFactoriesLoader.instantiateFactory
(String implementationName, Class<T> type, SpringFactoriesLoader.ArgumentResolver argumentResolver, SpringFactoriesLoader.FailureHandler failureHandler) ModifierConstructorDescriptionMockSpringFactoriesLoader
(ClassLoader classLoader) Create a newMockSpringFactoriesLoader
instance with the given classloader.protected
MockSpringFactoriesLoader
(ClassLoader classLoader, Map<String, List<String>> factories) -
Uses of Nullable in org.springframework.core.test.tools
Modifier and TypeMethodDescriptionprotected URL
DynamicClassLoader.findResource
(String name) Get theClassFile
with the given class name.Get theResourceFile
with the given path.Get theSourceFile
with the given path.Modifier and TypeMethodDescriptionboolean
boolean
boolean
boolean
DynamicFileAssert.hasContent
(CharSequence content) Verify that the actual content is equal to the given one.static SourceFile
SourceFile.of
(String path, CharSequence charSequence) Factory method to create a newSourceFile
from the givenCharSequence
.static SourceFile
SourceFile.of
(String path, InputStreamSource inputStreamSource) Factory method to create a newSourceFile
from the givenInputStreamSource
.static SourceFile
SourceFile.of
(String path, WritableContent writableContent) Factory method to create a newSourceFile
from the givenWritableContent
. -
Uses of Nullable in org.springframework.core.type
Modifier and TypeMethodDescriptiondefault MultiValueMap<String,
Object> AnnotatedTypeMetadata.getAllAnnotationAttributes
(String annotationName) Retrieve all attributes of all annotations of the given type, if any (i.e.default MultiValueMap<String,
Object> AnnotatedTypeMetadata.getAllAnnotationAttributes
(String annotationName, boolean classValuesAsString) Retrieve all attributes of all annotations of the given type, if any (i.e.StandardAnnotationMetadata.getAllAnnotationAttributes
(String annotationName, boolean classValuesAsString) StandardMethodMetadata.getAllAnnotationAttributes
(String annotationName, boolean classValuesAsString) AnnotatedTypeMetadata.getAnnotationAttributes
(String annotationName) Retrieve the attributes of the annotation of the given type, if any (i.e.AnnotatedTypeMetadata.getAnnotationAttributes
(String annotationName, boolean classValuesAsString) Retrieve the attributes of the annotation of the given type, if any (i.e.StandardAnnotationMetadata.getAnnotationAttributes
(String annotationName, boolean classValuesAsString) StandardMethodMetadata.getAnnotationAttributes
(String annotationName, boolean classValuesAsString) ClassMetadata.getEnclosingClassName()
Return the name of the enclosing class of the underlying class, ornull
if the underlying class is a top-level class.StandardClassMetadata.getEnclosingClassName()
ClassMetadata.getSuperClassName()
Return the name of the superclass of the underlying class, ornull
if there is no superclass defined.StandardClassMetadata.getSuperClassName()
-
Uses of Nullable in org.springframework.core.type.classreading
ModifierConstructorDescriptionCachingMetadataReaderFactory
(ClassLoader classLoader) Create a new CachingMetadataReaderFactory for the givenClassLoader
, using a local resource cache.CachingMetadataReaderFactory
(ResourceLoader resourceLoader) Create a new CachingMetadataReaderFactory for the givenResourceLoader
, using a shared resource cache if supported or a local resource cache otherwise.SimpleMetadataReaderFactory
(ClassLoader classLoader) Create a new SimpleMetadataReaderFactory for the given class loader.SimpleMetadataReaderFactory
(ResourceLoader resourceLoader) Create a new SimpleMetadataReaderFactory for the given resource loader. -
Uses of Nullable in org.springframework.core.type.filter
Modifier and TypeMethodDescriptionprotected Boolean
AnnotationTypeFilter.hasAnnotation
(String typeName) protected Boolean
AbstractTypeHierarchyTraversingFilter.matchInterface
(String interfaceName) Override this to match on interface type name.protected Boolean
AnnotationTypeFilter.matchInterface
(String interfaceName) protected Boolean
AssignableTypeFilter.matchInterface
(String interfaceName) protected Boolean
AbstractTypeHierarchyTraversingFilter.matchSuperClass
(String superClassName) Override this to match on supertype name.protected Boolean
AnnotationTypeFilter.matchSuperClass
(String superClassName) protected Boolean
AssignableTypeFilter.matchSuperClass
(String superClassName) protected Boolean
AssignableTypeFilter.matchTargetType
(String typeName) ModifierConstructorDescriptionAspectJTypeFilter
(String typePatternExpression, ClassLoader classLoader) -
Uses of Nullable in org.springframework.dao
ModifierConstructorDescriptionConcurrencyFailureException
(String msg, Throwable cause) Constructor for ConcurrencyFailureException.DataAccessException
(String msg, Throwable cause) Constructor for DataAccessException.DataAccessException
(String msg, Throwable cause) Constructor for DataAccessException.DataAccessResourceFailureException
(String msg, Throwable cause) Constructor for DataAccessResourceFailureException.DataRetrievalFailureException
(String msg, Throwable cause) Constructor for DataRetrievalFailureException.NonTransientDataAccessException
(String msg, Throwable cause) Constructor for NonTransientDataAccessException.NonTransientDataAccessException
(String msg, Throwable cause) Constructor for NonTransientDataAccessException.NonTransientDataAccessResourceException
(String msg, Throwable cause) Constructor for NonTransientDataAccessResourceException.OptimisticLockingFailureException
(String msg, Throwable cause) Constructor for OptimisticLockingFailureException.TransientDataAccessException
(String msg, Throwable cause) Constructor for TransientDataAccessException.UncategorizedDataAccessException
(String msg, Throwable cause) Constructor for UncategorizedDataAccessException.UncategorizedDataAccessException
(String msg, Throwable cause) Constructor for UncategorizedDataAccessException. -
Uses of Nullable in org.springframework.dao.support
Modifier and TypeMethodDescriptionPersistenceExceptionTranslationInterceptor.invoke
(MethodInvocation mi) static <T> T
DataAccessUtils.nullableSingleResult
(Collection<T> results) Return a single result object from the given Collection.static <T> T
DataAccessUtils.singleResult
(Collection<T> results) Return a single result object from the given Collection.static <T> T
DataAccessUtils.singleResult
(Iterator<T> results) Return a single result object from the given Iterator.static <T> T
DataAccessUtils.singleResult
(Stream<T> results) Return a single result object from the given Stream.ChainedPersistenceExceptionTranslator.translateExceptionIfPossible
(RuntimeException ex) PersistenceExceptionTranslator.translateExceptionIfPossible
(RuntimeException ex) Translate the given runtime exception thrown by a persistence framework to a corresponding exception from Spring's genericDataAccessException
hierarchy, if possible.static <T> T
DataAccessUtils.uniqueResult
(Collection<T> results) Return a unique result object from the given Collection.Modifier and TypeMethodDescriptionstatic int
DataAccessUtils.intResult
(Collection<?> results) Return a unique int result from the given Collection.static long
DataAccessUtils.longResult
(Collection<?> results) Return a unique long result from the given Collection.static <T> T
DataAccessUtils.nullableSingleResult
(Collection<T> results) Return a single result object from the given Collection.static <T> T
DataAccessUtils.objectResult
(Collection<?> results, Class<T> requiredType) Return a unique result object from the given Collection.static <T> T
DataAccessUtils.objectResult
(Collection<?> results, Class<T> requiredType) Return a unique result object from the given Collection.static <T> Optional<T>
DataAccessUtils.optionalResult
(Collection<T> results) Return a single result object from the given Collection.static <T> Optional<T>
DataAccessUtils.optionalResult
(Iterator<T> results) Return a single result object from the given Iterator.static <T> Optional<T>
DataAccessUtils.optionalResult
(Stream<T> results) Return a single result object from the given Stream.static <T> T
DataAccessUtils.requiredSingleResult
(Collection<T> results) Return a single result object from the given Collection.static <T> T
DataAccessUtils.requiredUniqueResult
(Collection<T> results) Return a unique result object from the given Collection.static <T> T
DataAccessUtils.singleResult
(Collection<T> results) Return a single result object from the given Collection.static <T> T
DataAccessUtils.singleResult
(Iterator<T> results) Return a single result object from the given Iterator.static <T> T
DataAccessUtils.singleResult
(Stream<T> results) Return a single result object from the given Stream.static <T> T
DataAccessUtils.uniqueResult
(Collection<T> results) Return a unique result object from the given Collection. -
Uses of Nullable in org.springframework.expression
Modifier and TypeMethodDescriptionTypeConverter.convertValue
(Object value, TypeDescriptor sourceType, TypeDescriptor targetType) Convert (or coerce) a value from one type to another, for example from aboolean
to aString
.EvaluationContext.getBeanResolver()
Return a bean resolver that can look up beans by name.final String
ExpressionException.getExpressionString()
Return the expression string.Class<?>[]
PropertyAccessor.getSpecificTargetClasses()
Return an array of classes for which this resolver should be called.TypedValue.getTypeDescriptor()
Expression.getValue()
Evaluate this expression in the default standard context.<T> T
Evaluate the expression in the default context.Evaluate this expression against the specified root object.<T> T
Evaluate the expression in the default context against the specified root object.Expression.getValue
(EvaluationContext context) Evaluate this expression in the provided context and return the result of evaluation.<T> T
Expression.getValue
(EvaluationContext context, Class<T> desiredResultType) Evaluate the expression in a specified context which can resolve references to properties, methods, types, etc.Expression.getValue
(EvaluationContext context, Object rootObject) Evaluate this expression in the provided context and return the result of evaluation, but use the supplied root context as an override for any default root object specified in the context.<T> T
Expression.getValue
(EvaluationContext context, Object rootObject, Class<T> desiredResultType) Evaluate the expression in a specified context which can resolve references to properties, methods, types, etc.TypedValue.getValue()
Class<?>
Expression.getValueType()
Return the most general type that can be passed to aExpression.setValue(java.lang.Object, java.lang.Object)
method using the default context.Class<?>
Expression.getValueType
(Object rootObject) Return the most general type that can be passed to theExpression.setValue(Object, Object)
method using the default context.Class<?>
Expression.getValueType
(EvaluationContext context) Return the most general type that can be passed to theExpression.setValue(EvaluationContext, Object)
method for the given context.Class<?>
Expression.getValueType
(EvaluationContext context, Object rootObject) Return the most general type that can be passed to theExpression.setValue(EvaluationContext, Object, Object)
method for the given context.Expression.getValueTypeDescriptor()
Return the most general type that can be passed to aExpression.setValue(java.lang.Object, java.lang.Object)
method using the default context.Expression.getValueTypeDescriptor
(Object rootObject) Return the most general type that can be passed to theExpression.setValue(Object, Object)
method using the default context.Expression.getValueTypeDescriptor
(EvaluationContext context) Return the most general type that can be passed to theExpression.setValue(EvaluationContext, Object)
method for the given context.Expression.getValueTypeDescriptor
(EvaluationContext context, Object rootObject) Return the most general type that can be passed to theExpression.setValue(EvaluationContext, Object, Object)
method for the given context.EvaluationContext.lookupVariable
(String name) Look up a named variable within this evaluation context.ConstructorResolver.resolve
(EvaluationContext context, String typeName, List<TypeDescriptor> argumentTypes) Within the supplied context determine a suitable constructor on the supplied type that can handle the specified arguments.MethodResolver.resolve
(EvaluationContext context, Object targetObject, String name, List<TypeDescriptor> argumentTypes) Within the supplied context determine a suitable method on the supplied object that can handle the specified arguments.Modifier and TypeMethodDescriptionboolean
TypeComparator.canCompare
(Object firstObject, Object secondObject) Returntrue
if the comparator can compare these two objects.boolean
TypeComparator.canCompare
(Object firstObject, Object secondObject) Returntrue
if the comparator can compare these two objects.boolean
TypeConverter.canConvert
(TypeDescriptor sourceType, TypeDescriptor targetType) Returntrue
if the type converter can convert the specified type to the desired target type.boolean
PropertyAccessor.canRead
(EvaluationContext context, Object target, String name) Called to determine if a resolver instance is able to access a specified property on a specified target object.boolean
PropertyAccessor.canWrite
(EvaluationContext context, Object target, String name) Called to determine if a resolver instance is able to write to a specified property on a specified target object.int
Compare two given objects.int
Compare two given objects.TypeConverter.convertValue
(Object value, TypeDescriptor sourceType, TypeDescriptor targetType) Convert (or coerce) a value from one type to another, for example from aboolean
to aString
.TypeConverter.convertValue
(Object value, TypeDescriptor sourceType, TypeDescriptor targetType) Convert (or coerce) a value from one type to another, for example from aboolean
to aString
.boolean
<T> T
Evaluate the expression in the default context.Evaluate this expression against the specified root object.<T> T
Evaluate the expression in the default context against the specified root object.<T> T
Evaluate the expression in the default context against the specified root object.<T> T
Expression.getValue
(EvaluationContext context, Class<T> desiredResultType) Evaluate the expression in a specified context which can resolve references to properties, methods, types, etc.Expression.getValue
(EvaluationContext context, Object rootObject) Evaluate this expression in the provided context and return the result of evaluation, but use the supplied root context as an override for any default root object specified in the context.<T> T
Expression.getValue
(EvaluationContext context, Object rootObject, Class<T> desiredResultType) Evaluate the expression in a specified context which can resolve references to properties, methods, types, etc.<T> T
Expression.getValue
(EvaluationContext context, Object rootObject, Class<T> desiredResultType) Evaluate the expression in a specified context which can resolve references to properties, methods, types, etc.Class<?>
Expression.getValueType
(Object rootObject) Return the most general type that can be passed to theExpression.setValue(Object, Object)
method using the default context.Class<?>
Expression.getValueType
(EvaluationContext context, Object rootObject) Return the most general type that can be passed to theExpression.setValue(EvaluationContext, Object, Object)
method for the given context.Expression.getValueTypeDescriptor
(Object rootObject) Return the most general type that can be passed to theExpression.setValue(Object, Object)
method using the default context.Expression.getValueTypeDescriptor
(EvaluationContext context, Object rootObject) Return the most general type that can be passed to theExpression.setValue(EvaluationContext, Object, Object)
method for the given context.boolean
Expression.isWritable
(Object rootObject) Determine if an expression can be written to, i.e.boolean
Expression.isWritable
(EvaluationContext context, Object rootObject) Determine if an expression can be written to, i.e.Execute the specified operation on two operands, returning a result.Execute the specified operation on two operands, returning a result.boolean
OperatorOverloader.overridesOperation
(Operation operation, Object leftOperand, Object rightOperand) Return true if the operator overloader supports the specified operation between the two operands and so should be invoked to handle it.boolean
OperatorOverloader.overridesOperation
(Operation operation, Object leftOperand, Object rightOperand) Return true if the operator overloader supports the specified operation between the two operands and so should be invoked to handle it.PropertyAccessor.read
(EvaluationContext context, Object target, String name) Called to read a property from a specified target object.void
Set this expression in the provided context to the value provided.void
Set this expression in the provided context to the value provided.void
Expression.setValue
(EvaluationContext context, Object value) Set this expression in the provided context to the value provided.void
Expression.setValue
(EvaluationContext context, Object rootObject, Object value) Set this expression in the provided context to the value provided.void
Expression.setValue
(EvaluationContext context, Object rootObject, Object value) Set this expression in the provided context to the value provided.void
EvaluationContext.setVariable
(String name, Object value) Set a named variable in this evaluation context to a specified value.void
PropertyAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) Called to write to a property on a specified target object.void
PropertyAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) Called to write to a property on a specified target object.ModifierConstructorDescriptionExpressionException
(String expressionString, int position, String message) Construct a new expression exception.ExpressionException
(String expressionString, String message) Construct a new expression exception.ParseException
(String expressionString, int position, String message) Create a new expression parsing exception.TypedValue
(Object value) Create aTypedValue
for a simple object.TypedValue
(Object value, TypeDescriptor typeDescriptor) Create aTypedValue
for a particular value with a particularTypeDescriptor
which may contain additional generic declarations.TypedValue
(Object value, TypeDescriptor typeDescriptor) Create aTypedValue
for a particular value with a particularTypeDescriptor
which may contain additional generic declarations. -
Uses of Nullable in org.springframework.expression.common
Modifier and TypeMethodDescriptionstatic <T> T
ExpressionUtils.convertTypedValue
(EvaluationContext context, TypedValue typedValue, Class<T> targetType) Determines if there is a type converter available in the specified context and attempts to use it to convert the supplied value to the specified type.<T> T
<T> T
<T> T
CompositeStringExpression.getValue
(EvaluationContext context, Class<T> expectedResultType) <T> T
CompositeStringExpression.getValue
(EvaluationContext context, Object rootObject, Class<T> desiredResultType) <T> T
<T> T
<T> T
LiteralExpression.getValue
(EvaluationContext context, Class<T> expectedResultType) <T> T
LiteralExpression.getValue
(EvaluationContext context, Object rootObject, Class<T> desiredResultType) Modifier and TypeMethodDescriptionstatic <T> T
ExpressionUtils.convertTypedValue
(EvaluationContext context, TypedValue typedValue, Class<T> targetType) Determines if there is a type converter available in the specified context and attempts to use it to convert the supplied value to the specified type.static <T> T
ExpressionUtils.convertTypedValue
(EvaluationContext context, TypedValue typedValue, Class<T> targetType) Determines if there is a type converter available in the specified context and attempts to use it to convert the supplied value to the specified type.protected abstract Expression
TemplateAwareExpressionParser.doParseExpression
(String expressionString, ParserContext context) Actually parse the expression string and return an Expression object.<T> T
<T> T
<T> T
<T> T
CompositeStringExpression.getValue
(EvaluationContext context, Class<T> expectedResultType) CompositeStringExpression.getValue
(EvaluationContext context, Object rootObject) <T> T
CompositeStringExpression.getValue
(EvaluationContext context, Object rootObject, Class<T> desiredResultType) <T> T
CompositeStringExpression.getValue
(EvaluationContext context, Object rootObject, Class<T> desiredResultType) <T> T
<T> T
<T> T
<T> T
LiteralExpression.getValue
(EvaluationContext context, Class<T> expectedResultType) LiteralExpression.getValue
(EvaluationContext context, Object rootObject) <T> T
LiteralExpression.getValue
(EvaluationContext context, Object rootObject, Class<T> desiredResultType) <T> T
LiteralExpression.getValue
(EvaluationContext context, Object rootObject, Class<T> desiredResultType) Class<?>
CompositeStringExpression.getValueType
(Object rootObject) Class<?>
CompositeStringExpression.getValueType
(EvaluationContext context, Object rootObject) Class<?>
LiteralExpression.getValueType
(Object rootObject) Class<?>
LiteralExpression.getValueType
(EvaluationContext context, Object rootObject) CompositeStringExpression.getValueTypeDescriptor
(Object rootObject) CompositeStringExpression.getValueTypeDescriptor
(EvaluationContext context, Object rootObject) LiteralExpression.getValueTypeDescriptor
(Object rootObject) LiteralExpression.getValueTypeDescriptor
(EvaluationContext context, Object rootObject) boolean
CompositeStringExpression.isWritable
(Object rootObject) boolean
CompositeStringExpression.isWritable
(EvaluationContext context, Object rootObject) boolean
LiteralExpression.isWritable
(Object rootObject) boolean
LiteralExpression.isWritable
(EvaluationContext context, Object rootObject) TemplateAwareExpressionParser.parseExpression
(String expressionString, ParserContext context) void
void
void
CompositeStringExpression.setValue
(EvaluationContext context, Object value) void
CompositeStringExpression.setValue
(EvaluationContext context, Object rootObject, Object value) void
CompositeStringExpression.setValue
(EvaluationContext context, Object rootObject, Object value) void
void
void
LiteralExpression.setValue
(EvaluationContext context, Object value) void
LiteralExpression.setValue
(EvaluationContext context, Object rootObject, Object value) void
LiteralExpression.setValue
(EvaluationContext context, Object rootObject, Object value) -
Uses of Nullable in org.springframework.expression.spel
Modifier and TypeMethodDescriptionExpressionState.convertValue
(TypedValue value, TypeDescriptor targetTypeDescriptor) SpelParserConfiguration.getCompilerClassLoader()
Return the ClassLoader to use as the basis for expression compilation.Class<?>
SpelNode.getObjectClass
(Object obj) Determine the class of the object passed in, unless it is already a class object.SpelNode.getValue
(ExpressionState expressionState) Evaluate the expression node in the context of the supplied expression state and return the value.CodeFlow.lastDescriptor()
Return the descriptor for the item currently on top of the stack (in the current scope).ExpressionState.lookupLocalVariable
(String name) Modifier and TypeMethodDescriptionClass<?>
SpelNode.getObjectClass
(Object obj) Determine the class of the object passed in, unless it is already a class object.abstract Object
CompiledExpression.getValue
(Object target, EvaluationContext context) Subclasses of CompiledExpression generated by SpelCompiler will provide an implementation of this method.abstract Object
CompiledExpression.getValue
(Object target, EvaluationContext context) Subclasses of CompiledExpression generated by SpelCompiler will provide an implementation of this method.static void
CodeFlow.insertBoxIfNecessary
(MethodVisitor mv, String descriptor) Determine the appropriate boxing instruction for a specific type (if it needs boxing) and insert the instruction into the supplied visitor.static void
CodeFlow.insertCheckCast
(MethodVisitor mv, String descriptor) Insert the appropriate CHECKCAST instruction for the supplied descriptor.static void
CodeFlow.insertNumericUnboxOrPrimitiveTypeCoercion
(MethodVisitor mv, String stackDescriptor, char targetDescriptor) For use in mathematical operators, handles converting from a (possibly boxed) number on the stack to a primitive numeric type.static void
CodeFlow.insertUnboxInsns
(MethodVisitor mv, char ch, String stackDescriptor) Insert any necessary cast and value call to convert from a boxed type to a primitive value.static void
CodeFlow.insertUnboxNumberInsns
(MethodVisitor mv, char targetDescriptor, String stackDescriptor) For numbers, use the appropriate method on the number to convert it to the primitive type requested.static boolean
CodeFlow.isBooleanCompatible
(String descriptor) Determine whether the descriptor is for a boolean primitive or boolean reference type.static boolean
CodeFlow.isPrimitive
(String descriptor) Determine whether the descriptor is for a primitive type.static boolean
CodeFlow.isPrimitiveArray
(String descriptor) Determine whether the descriptor is for a primitive array (e.g.static boolean
CodeFlow.isPrimitiveOrUnboxableSupportedNumber
(String descriptor) Determine if the supplied descriptor is for a supported number.static boolean
CodeFlow.isPrimitiveOrUnboxableSupportedNumberOrBoolean
(String descriptor) Determine if the supplied descriptor is for a supported number type or boolean.void
CodeFlow.pushDescriptor
(String descriptor) Record the descriptor for the most recently evaluated expression element.void
SpelNode.setValue
(ExpressionState expressionState, Object newValue) Evaluate the expression to a node and then set the new value on that node.void
ExpressionState.setVariable
(String name, Object value) Set a named variable in the evaluation context to a specified value.static String
CodeFlow.toDescriptorFromObject
(Object value) Determine the descriptor for an object instance (ornull
).ModifierConstructorDescriptionSpelParseException
(String expressionString, int position, SpelMessage message, Object... inserts) SpelParserConfiguration
(SpelCompilerMode compilerMode, ClassLoader compilerClassLoader) Create a newSpelParserConfiguration
instance.SpelParserConfiguration
(SpelCompilerMode compilerMode, ClassLoader compilerClassLoader) Create a newSpelParserConfiguration
instance.SpelParserConfiguration
(SpelCompilerMode compilerMode, ClassLoader compilerClassLoader, boolean autoGrowNullReferences, boolean autoGrowCollections, int maximumAutoGrowSize) Create a newSpelParserConfiguration
instance.SpelParserConfiguration
(SpelCompilerMode compilerMode, ClassLoader compilerClassLoader, boolean autoGrowNullReferences, boolean autoGrowCollections, int maximumAutoGrowSize) Create a newSpelParserConfiguration
instance.SpelParserConfiguration
(SpelCompilerMode compilerMode, ClassLoader compilerClassLoader, boolean autoGrowNullReferences, boolean autoGrowCollections, int maximumAutoGrowSize, int maximumExpressionLength) Create a newSpelParserConfiguration
instance.SpelParserConfiguration
(SpelCompilerMode compilerMode, ClassLoader compilerClassLoader, boolean autoGrowNullReferences, boolean autoGrowCollections, int maximumAutoGrowSize, int maximumExpressionLength) Create a newSpelParserConfiguration
instance. -
Uses of Nullable in org.springframework.expression.spel.ast
Modifier and TypeFieldDescriptionprotected String
SpelNodeImpl.exitTypeDescriptor
Indicates the type descriptor for the result of this expression node.protected String
Operator.leftActualDescriptor
protected String
Operator.rightActualDescriptor
Modifier and TypeMethodDescriptionInlineList.getConstantValue()
InlineMap.getConstantValue()
SpelNodeImpl.getExitDescriptor()
Class<?>
SpelNodeImpl.getObjectClass
(Object obj) final String
Literal.getOriginalValue()
final Object
SpelNodeImpl.getValue
(ExpressionState expressionState) protected final <T> T
SpelNodeImpl.getValue
(ExpressionState state, Class<T> desiredReturnType) Modifier and TypeMethodDescriptionOperator.DescriptorComparison.checkNumericCompatibility
(String leftDeclaredDescriptor, String rightDeclaredDescriptor, String leftActualDescriptor, String rightActualDescriptor) Return an object that indicates whether the input descriptors are compatible.Operator.DescriptorComparison.checkNumericCompatibility
(String leftDeclaredDescriptor, String rightDeclaredDescriptor, String leftActualDescriptor, String rightActualDescriptor) Return an object that indicates whether the input descriptors are compatible.Operator.DescriptorComparison.checkNumericCompatibility
(String leftDeclaredDescriptor, String rightDeclaredDescriptor, String leftActualDescriptor, String rightActualDescriptor) Return an object that indicates whether the input descriptors are compatible.Operator.DescriptorComparison.checkNumericCompatibility
(String leftDeclaredDescriptor, String rightDeclaredDescriptor, String leftActualDescriptor, String rightActualDescriptor) Return an object that indicates whether the input descriptors are compatible.static boolean
Operator.equalityCheck
(EvaluationContext context, Object left, Object right) Perform an equality check for the given operand values.static boolean
Operator.equalityCheck
(EvaluationContext context, Object left, Object right) Perform an equality check for the given operand values.Class<?>
SpelNodeImpl.getObjectClass
(Object obj) static List<PropertyAccessor>
AstUtils.getPropertyAccessorsToTry
(Class<?> targetType, List<PropertyAccessor> propertyAccessors) Determines the set of property resolvers that should be used to try and access a property on the specified target type.void
SpelNodeImpl.setValue
(ExpressionState expressionState, Object newValue) void
void
Sets the value this ValueRef points to, it should not require expression component re-evaluation.void
-
Uses of Nullable in org.springframework.expression.spel.standard
Modifier and TypeMethodDescriptionSpelCompiler.compile
(SpelNodeImpl expression) Attempt compilation of the supplied expression.SpelExpression.getValue()
<T> T
<T> T
SpelExpression.getValue
(EvaluationContext context) <T> T
SpelExpression.getValue
(EvaluationContext context, Class<T> expectedResultType) SpelExpression.getValue
(EvaluationContext context, Object rootObject) <T> T
SpelExpression.getValue
(EvaluationContext context, Object rootObject, Class<T> expectedResultType) Class<?>
SpelExpression.getValueType()
Class<?>
SpelExpression.getValueType
(Object rootObject) Class<?>
SpelExpression.getValueType
(EvaluationContext context) Class<?>
SpelExpression.getValueType
(EvaluationContext context, Object rootObject) SpelExpression.getValueTypeDescriptor()
SpelExpression.getValueTypeDescriptor
(Object rootObject) SpelExpression.getValueTypeDescriptor
(EvaluationContext context) SpelExpression.getValueTypeDescriptor
(EvaluationContext context, Object rootObject) Modifier and TypeMethodDescriptionprotected SpelExpression
SpelExpressionParser.doParseExpression
(String expressionString, ParserContext context) static SpelCompiler
SpelCompiler.getCompiler
(ClassLoader classLoader) Factory method for compiler instances.<T> T
<T> T
<T> T
<T> T
SpelExpression.getValue
(EvaluationContext context, Class<T> expectedResultType) SpelExpression.getValue
(EvaluationContext context, Object rootObject) <T> T
SpelExpression.getValue
(EvaluationContext context, Object rootObject, Class<T> expectedResultType) <T> T
SpelExpression.getValue
(EvaluationContext context, Object rootObject, Class<T> expectedResultType) Class<?>
SpelExpression.getValueType
(Object rootObject) Class<?>
SpelExpression.getValueType
(EvaluationContext context, Object rootObject) SpelExpression.getValueTypeDescriptor
(Object rootObject) SpelExpression.getValueTypeDescriptor
(EvaluationContext context, Object rootObject) boolean
SpelExpression.isWritable
(Object rootObject) boolean
SpelExpression.isWritable
(EvaluationContext context, Object rootObject) void
void
void
SpelExpression.setValue
(EvaluationContext context, Object value) void
SpelExpression.setValue
(EvaluationContext context, Object rootObject, Object value) void
SpelExpression.setValue
(EvaluationContext context, Object rootObject, Object value) -
Uses of Nullable in org.springframework.expression.spel.support
Modifier and TypeMethodDescriptionStandardTypeConverter.convertValue
(Object value, TypeDescriptor sourceType, TypeDescriptor targetType) protected Field
Find a field of a certain name on a specified class.protected Method
ReflectivePropertyAccessor.findGetterForProperty
(String propertyName, Class<?> clazz, boolean mustBeStatic) Find a getter method for the specified property.protected Method
ReflectivePropertyAccessor.findSetterForProperty
(String propertyName, Class<?> clazz, boolean mustBeStatic) Find a setter method for the specified property.SimpleEvaluationContext.getBeanResolver()
SimpleEvaluationContext
does not support the use of bean references.StandardEvaluationContext.getBeanResolver()
Class<?>
ReflectiveMethodExecutor.getPublicDeclaringClass()
Find the first public class in the methods declaring class hierarchy that declares this method.Class<?>[]
ReflectivePropertyAccessor.getSpecificTargetClasses()
Returnsnull
which means this is a general purpose accessor.Class<?>[]
ReflectivePropertyAccessor.OptimalPropertyAccessor.getSpecificTargetClasses()
SimpleEvaluationContext.lookupVariable
(String name) StandardEvaluationContext.lookupVariable
(String name) DataBindingMethodResolver.resolve
(EvaluationContext context, Object targetObject, String name, List<TypeDescriptor> argumentTypes) ReflectiveConstructorResolver.resolve
(EvaluationContext context, String typeName, List<TypeDescriptor> argumentTypes) Locate a constructor on the type.ReflectiveMethodResolver.resolve
(EvaluationContext context, Object targetObject, String name, List<TypeDescriptor> argumentTypes) Locate a method on a type.Modifier and TypeMethodDescriptionboolean
StandardTypeComparator.canCompare
(Object left, Object right) boolean
StandardTypeComparator.canCompare
(Object left, Object right) boolean
StandardTypeConverter.canConvert
(TypeDescriptor sourceType, TypeDescriptor targetType) boolean
ReflectivePropertyAccessor.canRead
(EvaluationContext context, Object target, String name) boolean
ReflectivePropertyAccessor.OptimalPropertyAccessor.canRead
(EvaluationContext context, Object target, String name) boolean
ReflectivePropertyAccessor.canWrite
(EvaluationContext context, Object target, String name) boolean
ReflectivePropertyAccessor.OptimalPropertyAccessor.canWrite
(EvaluationContext context, Object target, String name) int
int
static boolean
ReflectionHelper.convertAllMethodHandleArguments
(TypeConverter converter, Object[] arguments, MethodHandle methodHandle, Integer varargsPosition) Takes an input set of argument values and converts them to the types specified as the required parameter types.StandardTypeConverter.convertValue
(Object value, TypeDescriptor sourceType, TypeDescriptor targetType) StandardTypeConverter.convertValue
(Object value, TypeDescriptor sourceType, TypeDescriptor targetType) ReflectivePropertyAccessor.createOptimalAccessor
(EvaluationContext context, Object target, String name) Attempt to create an optimized property accessor tailored for a property of a particular name on a particular class.boolean
StandardOperatorOverloader.overridesOperation
(Operation operation, Object leftOperand, Object rightOperand) boolean
StandardOperatorOverloader.overridesOperation
(Operation operation, Object leftOperand, Object rightOperand) ReflectivePropertyAccessor.OptimalPropertyAccessor.read
(EvaluationContext context, Object target, String name) ReflectivePropertyAccessor.read
(EvaluationContext context, Object target, String name) void
ReflectiveMethodResolver.registerMethodFilter
(Class<?> type, MethodFilter filter) Register a filter for methods on the given type.void
StandardEvaluationContext.setRootObject
(Object rootObject) void
StandardEvaluationContext.setRootObject
(Object rootObject, TypeDescriptor typeDescriptor) void
SimpleEvaluationContext.setVariable
(String name, Object value) void
StandardEvaluationContext.setVariable
(String name, Object value) void
StandardEvaluationContext.setVariable
(String name, Object value) void
ReflectivePropertyAccessor.OptimalPropertyAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) void
ReflectivePropertyAccessor.OptimalPropertyAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) void
ReflectivePropertyAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) void
ReflectivePropertyAccessor.write
(EvaluationContext context, Object target, String name, Object newValue) ModifierConstructorDescriptionReflectiveMethodExecutor
(Method method, Class<?> targetClass) Create a new executor for the given method.StandardEvaluationContext
(Object rootObject) Create aStandardEvaluationContext
with the given root object.StandardTypeLocator
(ClassLoader classLoader) Create a StandardTypeLocator for the given ClassLoader. -
Uses of Nullable in org.springframework.format.datetime.standard
Modifier and TypeMethodDescriptionDateTimeContext.getChronology()
Return the user's chronology (calendar system), if any.static DateTimeContext
DateTimeContextHolder.getDateTimeContext()
Return the DateTimeContext associated with the current thread, if any.DateTimeFormatterFactoryBean.getObject()
DateTimeContext.getTimeZone()
Return the user's time zone, if any.Modifier and TypeMethodDescriptionstatic DateTimeFormatter
DateTimeContextHolder.getFormatter
(DateTimeFormatter formatter, Locale locale) Obtain a DateTimeFormatter with user-specific settings applied to the given base formatter.void
DateTimeContext.setChronology
(Chronology chronology) Set the user's chronology (calendar system).static void
DateTimeContextHolder.setDateTimeContext
(DateTimeContext dateTimeContext) Associate the given DateTimeContext with the current thread.void
DateTimeContext.setTimeZone
(ZoneId timeZone) Set the user's time zone. -
Uses of Nullable in org.springframework.format.support
ModifierConstructorDescriptionDefaultFormattingConversionService
(StringValueResolver embeddedValueResolver, boolean registerDefaultFormatters) Create a newDefaultFormattingConversionService
with the set of default converters and, based on the value ofregisterDefaultFormatters
, the set of default formatters. -
Uses of Nullable in org.springframework.http
Modifier and TypeMethodDescriptionHttpHeaders.getAccessControlAllowOrigin()
Return the value of theAccess-Control-Allow-Origin
response header.HttpHeaders.getAccessControlRequestMethod()
Return the value of theAccess-Control-Request-Method
request header.HttpEntity.getBody()
Returns the body of this entity.HttpHeaders.getCacheControl()
Return the value of theCache-Control
header.ContentDisposition.getCharset()
Return the charset defined in filename* parameter, ornull
if not defined.HttpHeaders.getContentLanguage()
Get the firstLocale
of the content languages, as specified by theContent-Language
header.HttpHeaders.getContentType()
Return the media type of the body, as specified by theContent-Type
header.ContentDisposition.getCreationDate()
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.ProblemDetail.getDetail()
Return the configuredproblem detail
.ResponseCookie.getDomain()
Return the cookie "Domain" attribute, ornull
if not set.HttpHeaders.getETag()
Return the entity tag of the body, as specified by theETag
header.protected String
HttpHeaders.getFieldValues
(String headerName) Retrieve a combined result from the field values of multivalued headers.ContentDisposition.getFilename()
Return the value of the filename parameter, possibly decoded from BASE64 encoding based on RFC 2047, or of the filename* parameter, possibly decoded as defined in the RFC 5987.Return the first header value for the given header name, if any.HttpHeaders.getFirstZonedDateTime
(String headerName) Parse the first header value for the given header name as a date, returnnull
if there is no value, or raiseIllegalArgumentException
if the value cannot be parsed as a date.CacheControl.getHeaderValue()
Return the "Cache-Control" header value, if any.HttpHeaders.getHost()
Return the value of theHost
header, if available.ProblemDetail.getInstance()
Return the configuredproblem instance
.HttpHeaders.getLocation()
Return the (new) location of a resource as specified by theLocation
header.RequestEntity.getMethod()
Return the HTTP method of the request.ContentDisposition.getModificationDate()
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.ContentDisposition.getName()
Return the value of the name parameter, ornull
if not defined.HttpHeaders.getOrigin()
Return the value of theOrigin
header.ResponseCookie.getPath()
Return the cookie "Path" attribute, ornull
if not set.HttpHeaders.getPragma()
Return the value of thePragma
header.ProblemDetail.getProperties()
Return a generic map of properties that are not known ahead of time, possiblynull
if no properties have been added.ContentDisposition.getReadDate()
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.ResponseCookie.getSameSite()
Return the cookie "SameSite" attribute, ornull
if not set.ContentDisposition.getSize()
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.ProblemDetail.getTitle()
Return the configuredproblem title
.ContentDisposition.getType()
Return the disposition type.RequestEntity.getType()
Return the type of the request's body.HttpHeaders.getUpgrade()
Return the value of theUpgrade
header.Object[]
RequestEntity.UriTemplateRequestEntity.getVars()
RequestEntity.UriTemplateRequestEntity.getVarsMap()
static HttpStatus
HttpStatus.resolve
(int statusCode) Resolve the given status code to anHttpStatus
, if possible.static HttpStatus.Series
HttpStatus.Series.resolve
(int statusCode) Resolve the given status code to anHttpStatus.Series
, if possible.Modifier and TypeMethodDescriptionvoid
Add the given, single header value under the given name.<T> ResponseEntity<T>
ResponseEntity.BodyBuilder.body
(T body) Set the body of the response entity and returns it.ContentDisposition.Builder.creationDate
(ZonedDateTime creationDate) Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.Set the cookie "Domain" attribute.static String
HttpHeaders.encodeBasicAuth
(String username, String password, Charset charset) Encode the given username and password into Basic Authentication credentials.boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
Set the entity tag of the body, as specified by theETag
header.Set the value of the filename parameter.Set the value of thefilename
that will be encoded as defined in RFC 5987.Set the value of thefilename
that will be encoded as defined in RFC 5987.MediaTypeFactory.getMediaType
(String filename) Determine a media type for the given file name, if possible.MediaTypeFactory.getMediaType
(Resource resource) Determine a media type for the given resource, if possible.MediaTypeFactory.getMediaTypes
(String filename) Determine the media types for the given file name, if possible.RequestEntity.HeadersBuilder.headers
(HttpHeaders headers) Copy the given headers into the entity's headers map.ResponseEntity.HeadersBuilder.headers
(HttpHeaders headers) Copy the given headers into the entity's headers map.boolean
Indicate whether thisMediaType
includes the given media type.boolean
MediaType.isCompatibleWith
(MediaType other) Indicate whether thisMediaType
is compatible with the given media type.ContentDisposition.Builder.modificationDate
(ZonedDateTime modificationDate) Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.Set the value of the name parameter.static <T> ResponseEntity<T>
ResponseEntity.ofNullable
(T body) static <T> ResponseEntity<T>
ResponseEntity.ok
(T body) A shortcut for creating aResponseEntity
with the given body and the status set to OK.MediaType.parseMediaTypes
(String mediaTypes) Parse the comma-separated string into a list ofMediaType
objects.MediaType.parseMediaTypes
(List<String> mediaTypes) Parse the given list of (potentially) comma-separated strings into a list ofMediaType
objects.HttpRange.parseRanges
(String ranges) Parse the given, comma-separated string into a list ofHttpRange
objects.Set the cookie "Path" attribute.ContentDisposition.Builder.readDate
(ZonedDateTime readDate) Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.Add the "SameSite" attribute to the cookie.void
Set the given, single header value under the given name.void
HttpHeaders.setAccessControlAllowOrigin
(String allowedOrigin) Set the (new) value of theAccess-Control-Allow-Origin
response header.void
HttpHeaders.setAccessControlRequestMethod
(HttpMethod requestMethod) Set the (new) value of theAccess-Control-Request-Method
request header.void
HttpHeaders.setBasicAuth
(String username, String password, Charset charset) Set the value of the Authorization header to Basic Authentication based on the given username and password.void
HttpHeaders.setCacheControl
(String cacheControl) Set the (new) value of theCache-Control
header.void
HttpHeaders.setContentDispositionFormData
(String name, String filename) Set theContent-Disposition
header when creating a"multipart/form-data"
request.void
HttpHeaders.setContentLanguage
(Locale locale) Set theLocale
of the content language, as specified by the Content-Language header.void
HttpHeaders.setContentType
(MediaType mediaType) Set the media type of the body, as specified by theContent-Type
header.void
Setter for theproblem detail
.void
Set the (new) entity tag of the body, as specified by theETag
header.void
HttpHeaders.setHost
(InetSocketAddress host) Set the (new) value of theHost
header.void
ProblemDetail.setInstance
(URI instance) Setter for theproblem instance
.void
HttpHeaders.setLocation
(URI location) Set the (new) location of a resource, as specified by theLocation
header.void
Set the (new) value of theOrigin
header.void
Set the (new) value of thePragma
header.void
ProblemDetail.setProperty
(String name, Object value) Set a "dynamic" property to be added to a genericproperties map
.void
Setter for theproblem title
.void
HttpHeaders.setUpgrade
(String upgrade) Set the (new) value of theUpgrade
header.Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.Set the cookie value.ModifierConstructorDescriptionHttpCookie
(String name, String value) HttpEntity
(T body, MultiValueMap<String, String> headers) Create a newHttpEntity
with the given body and headers.HttpEntity
(T body, MultiValueMap<String, String> headers) Create a newHttpEntity
with the given body and headers.Create a newMediaType
for the given type, subtype, and parameters.Copy-constructor that copies the type and subtype of the givenMediaType
, and allows for different parameters.RequestEntity
(T body, HttpMethod method, URI url) Constructor with method, URL and body but without headers.RequestEntity
(T body, HttpMethod method, URI url, Type type) Constructor with method, URL, body and type but without headers.RequestEntity
(T body, MultiValueMap<String, String> headers, HttpMethod method, URI url) Constructor with method, URL, headers and body.RequestEntity
(T body, MultiValueMap<String, String> headers, HttpMethod method, URI url) Constructor with method, URL, headers and body.RequestEntity
(T body, MultiValueMap<String, String> headers, HttpMethod method, URI url) Constructor with method, URL, headers and body.RequestEntity
(T body, MultiValueMap<String, String> headers, HttpMethod method, URI url, Type type) Constructor with method, URL, headers, body and type.RequestEntity
(T body, MultiValueMap<String, String> headers, HttpMethod method, URI url, Type type) Constructor with method, URL, headers, body and type.RequestEntity
(T body, MultiValueMap<String, String> headers, HttpMethod method, URI url, Type type) Constructor with method, URL, headers, body and type.RequestEntity
(T body, MultiValueMap<String, String> headers, HttpMethod method, URI url, Type type) Constructor with method, URL, headers, body and type.RequestEntity
(T body, MultiValueMap<String, String> headers, HttpMethod method, URI url, Type type) Constructor with method, URL, headers, body and type.ResponseEntity
(T body, HttpStatusCode status) Create aResponseEntity
with a body and status code.ResponseEntity
(T body, MultiValueMap<String, String> headers, int rawStatus) Create aResponseEntity
with a body, headers, and a raw status code.ResponseEntity
(T body, MultiValueMap<String, String> headers, int rawStatus) Create aResponseEntity
with a body, headers, and a raw status code.ResponseEntity
(T body, MultiValueMap<String, String> headers, HttpStatusCode statusCode) Create aResponseEntity
with a body, headers, and a status code.ResponseEntity
(T body, MultiValueMap<String, String> headers, HttpStatusCode statusCode) Create aResponseEntity
with a body, headers, and a status code. -
Uses of Nullable in org.springframework.http.client
Modifier and TypeMethodDescriptionprotected org.apache.hc.core5.http.protocol.HttpContext
HttpComponentsClientHttpRequestFactory.createHttpContext
(HttpMethod httpMethod, URI uri) Template methods that creates aHttpContext
for the given HTTP method and URI.protected RequestConfig
HttpComponentsClientHttpRequestFactory.createRequestConfig
(Object client) Create a defaultRequestConfig
to use with the given client.Modifier and TypeMethodDescriptionprotected HttpURLConnection
SimpleClientHttpRequestFactory.openConnection
(URL url, Proxy proxy) Opens and returns a connection to the given URL.Variant ofMultipartBodyBuilder.part(String, Object)
that also accepts a MediaType.ModifierConstructorDescriptionInterceptingClientHttpRequestFactory
(ClientHttpRequestFactory requestFactory, List<ClientHttpRequestInterceptor> interceptors) Create a new instance of theInterceptingClientHttpRequestFactory
with the given parameters. -
Uses of Nullable in org.springframework.http.client.observation
Modifier and TypeMethodDescriptionClientRequestObservationContext.getUriTemplate()
Return the URI template used for the current client exchange,null
if none was used.Modifier and TypeMethodDescriptionvoid
ClientRequestObservationContext.setUriTemplate
(String uriTemplate) Set the URI template used for the current client exchange. -
Uses of Nullable in org.springframework.http.client.reactive
Modifier and TypeMethodDescriptionorg.eclipse.jetty.io.ByteBufferPool
JettyResourceFactory.getByteBufferPool()
Return the configuredByteBufferPool
.JdkHttpClientResourceFactory.getExecutor()
Return the configuredExecutor
.JettyResourceFactory.getExecutor()
Return the configuredExecutor
.org.eclipse.jetty.util.thread.Scheduler
JettyResourceFactory.getScheduler()
Return the configuredScheduler
.Modifier and TypeMethodDescriptionprotected reactor.core.publisher.Mono<Void>
ApplybeforeCommit
actions, apply the request headers/cookies, and write the request body.void
JettyResourceFactory.setByteBufferPool
(org.eclipse.jetty.io.ByteBufferPool byteBufferPool) Configure theByteBufferPool
to use.void
JdkHttpClientResourceFactory.setExecutor
(Executor executor) Configure theExecutor
to use forHttpClient
exchanges.void
JettyResourceFactory.setExecutor
(Executor executor) Configure theExecutor
to use.void
JettyResourceFactory.setScheduler
(org.eclipse.jetty.util.thread.Scheduler scheduler) Configure theScheduler
to use.ModifierConstructorDescriptionJdkClientHttpConnector
(HttpClient.Builder clientBuilder, JdkHttpClientResourceFactory resourceFactory) Constructor with aJdkHttpClientResourceFactory
that provides shared resources.JettyClientHttpConnector
(org.eclipse.jetty.client.HttpClient httpClient, JettyResourceFactory resourceFactory) Constructor with an initializedHttpClient
and configures it with the givenJettyResourceFactory
.JettyClientHttpConnector
(JettyResourceFactory resourceFactory, Consumer<org.eclipse.jetty.client.HttpClient> customizer) Deprecated.as of 5.2, in favor ofJettyClientHttpConnector(HttpClient, JettyResourceFactory)
-
Uses of Nullable in org.springframework.http.client.support
ModifierConstructorDescriptionBasicAuthenticationInterceptor
(String username, String password, Charset charset) Create a new interceptor which adds Basic Authentication for the given username and password, encoded using the specified charset. -
Uses of Nullable in org.springframework.http.codec
Modifier and TypeMethodDescriptionServerSentEvent.comment()
Return the comment of this event, if available.ServerSentEvent.data()
Return thedata
field of this event, if available.ServerSentEvent.event()
Return theevent
field of this event, if available.protected MediaType
DecoderHttpMessageReader.getContentType
(HttpMessage inputMessage) Determine the Content-Type of the HTTP message based on the "Content-Type" header or otherwise default toMediaType.APPLICATION_OCTET_STREAM
.Decoder<?>
ServerSentEventHttpMessageReader.getDecoder()
Return the configuredDecoder
.Encoder<?>
ServerSentEventHttpMessageWriter.getEncoder()
Return the configuredEncoder
, if any.ServerSentEvent.id()
Return theid
field of this event, if available.CodecConfigurer.DefaultCodecConfig.isEnableLoggingRequestDetails()
Whether to log form data at DEBUG level, and headers at TRACE level.CodecConfigurer.DefaultCodecConfig.maxInMemorySize()
Get the configured limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated.ServerSentEvent.retry()
Return theretry
field of this event, if available.protected final kotlinx.serialization.KSerializer<Object>
KotlinSerializationSupport.serializer
(ResolvableType resolvableType) Returns the serializer that can (de)serialize instances of the given type.Modifier and TypeMethodDescriptionvoid
ResourceHttpMessageWriter.addHeaders
(ReactiveHttpOutputMessage message, Resource resource, MediaType contentType, Map<String, Object> hints) Adds the default headers for the given resource to the given message.boolean
KotlinSerializationBinaryDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
KotlinSerializationStringDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
KotlinSerializationBinaryEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) boolean
KotlinSerializationStringEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) boolean
DecoderHttpMessageReader.canRead
(ResolvableType elementType, MediaType mediaType) boolean
FormHttpMessageReader.canRead
(ResolvableType elementType, MediaType mediaType) boolean
HttpMessageReader.canRead
(ResolvableType elementType, MediaType mediaType) Whether the given object type is supported by this reader.boolean
ServerSentEventHttpMessageReader.canRead
(ResolvableType elementType, MediaType mediaType) protected final boolean
KotlinSerializationSupport.canSerialize
(ResolvableType type, MimeType mimeType) Indicates whether the given type can be serialized using Kotlin serialization.boolean
EncoderHttpMessageWriter.canWrite
(ResolvableType elementType, MediaType mediaType) boolean
FormHttpMessageWriter.canWrite
(ResolvableType elementType, MediaType mediaType) boolean
HttpMessageWriter.canWrite
(ResolvableType elementType, MediaType mediaType) Whether the given object type is supported by this writer.boolean
ResourceHttpMessageWriter.canWrite
(ResolvableType elementType, MediaType mediaType) boolean
ServerSentEventHttpMessageWriter.canWrite
(ResolvableType elementType, MediaType mediaType) Set the value of thedata
field.reactor.core.publisher.Flux<Object>
KotlinSerializationBinaryDecoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<Object>
KotlinSerializationBinaryDecoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<Object>
KotlinSerializationStringDecoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<Object>
KotlinSerializationStringDecoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<Object>
KotlinSerializationBinaryDecoder.decodeToMono
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<Object>
KotlinSerializationBinaryDecoder.decodeToMono
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<Object>
KotlinSerializationStringDecoder.decodeToMono
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<Object>
KotlinSerializationStringDecoder.decodeToMono
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
KotlinSerializationBinaryEncoder.encode
(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
KotlinSerializationBinaryEncoder.encode
(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
KotlinSerializationStringEncoder.encode
(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
KotlinSerializationStringEncoder.encode
(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) KotlinSerializationBinaryEncoder.encodeValue
(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) KotlinSerializationBinaryEncoder.encodeValue
(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) KotlinSerializationStringEncoder.encodeValue
(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) KotlinSerializationStringEncoder.encodeValue
(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) HttpMessageEncoder.getEncodeHints
(ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response) Get decoding hints based on the server request or annotations on the target controller method parameter.protected MediaType
FormHttpMessageWriter.getMediaType
(MediaType mediaType) EncoderHttpMessageWriter.getWriteHints
(ResolvableType streamType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response) Get additional hints for encoding for example based on the server request or annotations from controller method parameters.reactor.core.publisher.Mono<Void>
EncoderHttpMessageWriter.write
(Publisher<? extends T> inputStream, ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, Map<String, Object> hints) reactor.core.publisher.Mono<Void>
EncoderHttpMessageWriter.write
(Publisher<? extends T> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, Map<String, Object> hints) reactor.core.publisher.Mono<Void>
FormHttpMessageWriter.write
(Publisher<? extends MultiValueMap<String, String>> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, Map<String, Object> hints) default reactor.core.publisher.Mono<Void>
HttpMessageWriter.write
(Publisher<? extends T> inputStream, ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, Map<String, Object> hints) Server-side only alternative toHttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)
with additional context available.reactor.core.publisher.Mono<Void>
HttpMessageWriter.write
(Publisher<? extends T> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, Map<String, Object> hints) Write a given stream of object to the output message.reactor.core.publisher.Mono<Void>
ResourceHttpMessageWriter.write
(Publisher<? extends Resource> inputStream, ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, Map<String, Object> hints) reactor.core.publisher.Mono<Void>
ResourceHttpMessageWriter.write
(Publisher<? extends Resource> inputStream, ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, Map<String, Object> hints) reactor.core.publisher.Mono<Void>
ResourceHttpMessageWriter.write
(Publisher<? extends Resource> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, Map<String, Object> hints) reactor.core.publisher.Mono<Void>
ServerSentEventHttpMessageWriter.write
(Publisher<?> input, ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, Map<String, Object> hints) reactor.core.publisher.Mono<Void>
ServerSentEventHttpMessageWriter.write
(Publisher<?> input, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, Map<String, Object> hints) ModifierConstructorDescriptionServerSentEventHttpMessageReader
(Decoder<?> decoder) Constructor with JSONDecoder
for decoding to Objects.ServerSentEventHttpMessageWriter
(Encoder<?> encoder) Constructor with JSONEncoder
for encoding objects. -
Uses of Nullable in org.springframework.http.codec.json
Modifier and TypeMethodDescriptionprotected abstract <A extends Annotation>
AJackson2CodecSupport.getAnnotation
(MethodParameter parameter, Class<A> annotType) Jackson2CodecSupport.getObjectMappersForType
(Class<?> clazz) Return ObjectMapper registrations for the given class, if any.protected MethodParameter
Jackson2CodecSupport.getParameter
(ResolvableType type) protected byte[]
AbstractJackson2Encoder.getStreamingMediaTypeSeparator
(MimeType mimeType) Return the separator to use for the given mime type.protected byte[]
Jackson2SmileEncoder.getStreamingMediaTypeSeparator
(MimeType mimeType) Return the separator to use for the given mime type.protected ObjectMapper
Jackson2CodecSupport.selectObjectMapper
(ResolvableType targetType, MimeType targetMimeType) Select an ObjectMapper to use, either the main ObjectMapper or another if the handling for the given Class has been customized throughJackson2CodecSupport.registerObjectMappersForType(Class, Consumer)
.Modifier and TypeMethodDescriptionboolean
AbstractJackson2Decoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
AbstractJackson2Encoder.canEncode
(ResolvableType elementType, MimeType mimeType) protected ObjectReader
AbstractJackson2Decoder.customizeReader
(ObjectReader reader, ResolvableType elementType, Map<String, Object> hints) Subclasses can use this method to customizeObjectReader
used for reading values.protected ObjectWriter
AbstractJackson2Encoder.customizeWriter
(ObjectWriter writer, MimeType mimeType, ResolvableType elementType, Map<String, Object> hints) Subclasses can use this method to customize theObjectWriter
used for writing values.protected ObjectWriter
AbstractJackson2Encoder.customizeWriter
(ObjectWriter writer, MimeType mimeType, ResolvableType elementType, Map<String, Object> hints) Subclasses can use this method to customize theObjectWriter
used for writing values.protected ObjectWriter
Jackson2JsonEncoder.customizeWriter
(ObjectWriter writer, MimeType mimeType, ResolvableType elementType, Map<String, Object> hints) protected ObjectWriter
Jackson2JsonEncoder.customizeWriter
(ObjectWriter writer, MimeType mimeType, ResolvableType elementType, Map<String, Object> hints) reactor.core.publisher.Flux<Object>
AbstractJackson2Decoder.decode
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<Object>
AbstractJackson2Decoder.decode
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) AbstractJackson2Decoder.decode
(DataBuffer dataBuffer, ResolvableType targetType, MimeType mimeType, Map<String, Object> hints) AbstractJackson2Decoder.decode
(DataBuffer dataBuffer, ResolvableType targetType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<Object>
AbstractJackson2Decoder.decodeToMono
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<Object>
AbstractJackson2Decoder.decodeToMono
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
AbstractJackson2Encoder.encode
(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
AbstractJackson2Encoder.encode
(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) AbstractJackson2Encoder.encodeValue
(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) AbstractJackson2Encoder.encodeValue
(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) AbstractJackson2Encoder.getEncodeHints
(ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response) AbstractJackson2Encoder.getEncodeHints
(ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response) protected JavaType
Jackson2CodecSupport.getJavaType
(Type type, Class<?> contextClass) protected JsonEncoding
AbstractJackson2Encoder.getJsonEncoding
(MimeType mimeType) Determine the JSON encoding to use for the given mime type.protected byte[]
AbstractJackson2Encoder.getStreamingMediaTypeSeparator
(MimeType mimeType) Return the separator to use for the given mime type.protected byte[]
Jackson2SmileEncoder.getStreamingMediaTypeSeparator
(MimeType mimeType) Return the separator to use for the given mime type.protected void
Jackson2CodecSupport.logWarningIfNecessary
(Type type, Throwable cause) Determine whether to log the given exception coming from aObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType)
/ObjectMapper.canSerialize(java.lang.Class<?>)
check.protected reactor.core.publisher.Flux<DataBuffer>
AbstractJackson2Decoder.processInput
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Process the input publisher into a flux.protected reactor.core.publisher.Flux<DataBuffer>
AbstractJackson2Decoder.processInput
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Process the input publisher into a flux.protected reactor.core.publisher.Flux<DataBuffer>
Jackson2JsonDecoder.processInput
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) protected reactor.core.publisher.Flux<DataBuffer>
Jackson2JsonDecoder.processInput
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) protected ObjectMapper
Jackson2CodecSupport.selectObjectMapper
(ResolvableType targetType, MimeType targetMimeType) Select an ObjectMapper to use, either the main ObjectMapper or another if the handling for the given Class has been customized throughJackson2CodecSupport.registerObjectMappersForType(Class, Consumer)
.protected boolean
Jackson2CodecSupport.supportsMimeType
(MimeType mimeType) -
Uses of Nullable in org.springframework.http.codec.multipart
Modifier and TypeMethodDescriptionMultipartHttpMessageWriter.getFormWriter()
Return the configured form writer.Modifier and TypeMethodDescriptionboolean
DefaultPartHttpMessageReader.canRead
(ResolvableType elementType, MediaType mediaType) boolean
MultipartHttpMessageReader.canRead
(ResolvableType elementType, MediaType mediaType) boolean
PartEventHttpMessageReader.canRead
(ResolvableType elementType, MediaType mediaType) boolean
MultipartHttpMessageWriter.canWrite
(ResolvableType elementType, MediaType mediaType) boolean
PartEventHttpMessageWriter.canWrite
(ResolvableType elementType, MediaType mediaType) boolean
PartHttpMessageWriter.canWrite
(ResolvableType elementType, MediaType mediaType) static reactor.core.publisher.Flux<FilePartEvent>
FilePartEvent.create
(String partName, String filename, MediaType contentType, reactor.core.publisher.Flux<DataBuffer> contents, Consumer<HttpHeaders> headersConsumer) Creates a stream ofFilePartEvent
objects based on the given name, FilePartEvent.filename(), content-type, and contents.static reactor.core.publisher.Flux<FilePartEvent>
FilePartEvent.create
(String name, Path path, Consumer<HttpHeaders> headersConsumer) Creates a stream ofFilePartEvent
objects based on the given name and file path.static reactor.core.publisher.Flux<FilePartEvent>
FilePartEvent.create
(String name, Resource resource, Consumer<HttpHeaders> headersConsumer) Creates a stream ofFilePartEvent
objects based on the given name and resource.static reactor.core.publisher.Mono<FormPartEvent>
FormPartEvent.create
(String name, String value, Consumer<HttpHeaders> headersConsumer) protected MediaType
MultipartWriterSupport.getMultipartMediaType
(MediaType mediaType, byte[] boundary) Prepare theMediaType
to use by adding "boundary" and "charset" parameters to the givenmediaType
or "multipart/form-data" otherwise by default.reactor.core.publisher.Mono<Void>
MultipartHttpMessageWriter.write
(Publisher<? extends MultiValueMap<String, ?>> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage outputMessage, Map<String, Object> hints) reactor.core.publisher.Mono<Void>
PartEventHttpMessageWriter.write
(Publisher<? extends PartEvent> partDataStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage outputMessage, Map<String, Object> hints) reactor.core.publisher.Mono<Void>
PartHttpMessageWriter.write
(Publisher<? extends Part> parts, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage outputMessage, Map<String, Object> hints) ModifierConstructorDescriptionMultipartHttpMessageWriter
(Supplier<List<HttpMessageWriter<?>>> partWritersSupplier, HttpMessageWriter<MultiValueMap<String, String>> formWriter) Constructor with a supplier for an explicit list of writers for serializing parts and a writer for plain form data to fall back when no media type is specified and the actual map consists of String values only.MultipartHttpMessageWriter
(List<HttpMessageWriter<?>> partWriters, HttpMessageWriter<MultiValueMap<String, String>> formWriter) Constructor with explicit list of writers for serializing parts and a writer for plain form data to fall back when no media type is specified and the actual map consists of String values only. -
Uses of Nullable in org.springframework.http.codec.protobuf
Modifier and TypeMethodDescriptionboolean
ProtobufDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
ProtobufEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) reactor.core.publisher.Flux<com.google.protobuf.Message>
ProtobufDecoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<com.google.protobuf.Message>
ProtobufDecoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) com.google.protobuf.Message
ProtobufDecoder.decode
(DataBuffer dataBuffer, ResolvableType targetType, MimeType mimeType, Map<String, Object> hints) com.google.protobuf.Message
ProtobufDecoder.decode
(DataBuffer dataBuffer, ResolvableType targetType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<com.google.protobuf.Message>
ProtobufDecoder.decodeToMono
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<com.google.protobuf.Message>
ProtobufDecoder.decodeToMono
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
ProtobufEncoder.encode
(Publisher<? extends com.google.protobuf.Message> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<DataBuffer>
ProtobufEncoder.encode
(Publisher<? extends com.google.protobuf.Message> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) ProtobufEncoder.encodeValue
(com.google.protobuf.Message message, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) ProtobufEncoder.encodeValue
(com.google.protobuf.Message message, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) protected boolean
ProtobufCodecSupport.supportsMimeType
(MimeType mimeType) reactor.core.publisher.Mono<Void>
ProtobufHttpMessageWriter.write
(Publisher<? extends com.google.protobuf.Message> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, Map<String, Object> hints) -
Uses of Nullable in org.springframework.http.codec.xml
Modifier and TypeMethodDescriptionboolean
Jaxb2XmlDecoder.canDecode
(ResolvableType elementType, MimeType mimeType) boolean
Jaxb2XmlEncoder.canEncode
(ResolvableType elementType, MimeType mimeType) reactor.core.publisher.Flux<Object>
Jaxb2XmlDecoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<Object>
Jaxb2XmlDecoder.decode
(Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Jaxb2XmlDecoder.decode
(DataBuffer dataBuffer, ResolvableType targetType, MimeType mimeType, Map<String, Object> hints) Jaxb2XmlDecoder.decode
(DataBuffer dataBuffer, ResolvableType targetType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<XMLEvent>
XmlEventDecoder.decode
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Flux<XMLEvent>
XmlEventDecoder.decode
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<Object>
Jaxb2XmlDecoder.decodeToMono
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) reactor.core.publisher.Mono<Object>
Jaxb2XmlDecoder.decodeToMono
(Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) protected reactor.core.publisher.Flux<DataBuffer>
Jaxb2XmlEncoder.encode
(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) protected reactor.core.publisher.Flux<DataBuffer>
Jaxb2XmlEncoder.encode
(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) Jaxb2XmlEncoder.encodeValue
(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) Jaxb2XmlEncoder.encodeValue
(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) -
Uses of Nullable in org.springframework.http.converter
Modifier and TypeMethodDescriptionprotected Long
AbstractHttpMessageConverter.getContentLength
(T t, MediaType contentType) Returns the content length for the given type.AbstractHttpMessageConverter.getDefaultCharset()
Return the default character set, if any.protected MediaType
AbstractHttpMessageConverter.getDefaultContentType
(T t) Returns the default content type for the given type.BufferedImageHttpMessageConverter.getDefaultContentType()
Returns the defaultContent-Type
to be used for writing.protected String
FormHttpMessageConverter.getFilename
(Object part) Return the filename of the given multipart part.Modifier and TypeMethodDescriptionprotected void
AbstractHttpMessageConverter.addDefaultHeaders
(HttpHeaders headers, T t, MediaType contentType) Add default headers to the output message.void
ResourceHttpMessageConverter.addDefaultHeaders
(HttpOutputMessage message, Resource resource, MediaType contentType) Adds the default headers for the given resource to the given message.protected void
StringHttpMessageConverter.addDefaultHeaders
(HttpHeaders headers, String s, MediaType type) boolean
boolean
boolean
This implementation checks if the given class is supported, and if the supported media types include the given media type.protected boolean
boolean
AbstractKotlinSerializationHttpMessageConverter.canRead
(Type type, Class<?> contextClass, MediaType mediaType) boolean
AbstractKotlinSerializationHttpMessageConverter.canRead
(Type type, Class<?> contextClass, MediaType mediaType) boolean
boolean
boolean
Indicates whether the given type can be read by this converter.boolean
Indicates whether the given type can be read by this converter.boolean
Indicates whether the given class can be read by this converter.boolean
boolean
boolean
boolean
boolean
boolean
boolean
protected boolean
Returnstrue
if the given media type includes any of the supported media types.boolean
AbstractKotlinSerializationHttpMessageConverter.canWrite
(Type type, Class<?> clazz, MediaType mediaType) boolean
AbstractKotlinSerializationHttpMessageConverter.canWrite
(Type type, Class<?> clazz, MediaType mediaType) boolean
boolean
boolean
Indicates whether the given class can be written by this converter.boolean
Indicates whether the given class can be written by this converter.boolean
Indicates whether the given class can be written by this converter.boolean
boolean
boolean
boolean
boolean
protected Long
AbstractHttpMessageConverter.getContentLength
(T t, MediaType contentType) Returns the content length for the given type.protected Long
ByteArrayHttpMessageConverter.getContentLength
(byte[] bytes, MediaType contentType) protected Long
ObjectToStringHttpMessageConverter.getContentLength
(Object obj, MediaType contentType) protected Long
ResourceHttpMessageConverter.getContentLength
(Resource resource, MediaType contentType) protected Long
StringHttpMessageConverter.getContentLength
(String str, MediaType contentType) protected MediaType
FormHttpMessageConverter.getFormContentType
(MediaType contentType) Return the content type used to write forms, given the preferred content type.final Object
AbstractKotlinSerializationHttpMessageConverter.read
(Type type, Class<?> contextClass, HttpInputMessage inputMessage) BufferedImageHttpMessageConverter.read
(Class<? extends BufferedImage> clazz, HttpInputMessage inputMessage) FormHttpMessageConverter.read
(Class<? extends MultiValueMap<String, ?>> clazz, HttpInputMessage inputMessage) GenericHttpMessageConverter.read
(Type type, Class<?> contextClass, HttpInputMessage inputMessage) Read an object of the given type form the given input message, and returns it.ResourceRegionHttpMessageConverter.read
(Type type, Class<?> contextClass, HttpInputMessage inputMessage) void
FormHttpMessageConverter.setCharset
(Charset charset) Set the default character set to use for reading and writing form data when the request or responseContent-Type
header does not explicitly specify it.void
AbstractHttpMessageConverter.setDefaultCharset
(Charset defaultCharset) Set the default character set, if any.void
BufferedImageHttpMessageConverter.setDefaultContentType
(MediaType defaultContentType) Sets the defaultContent-Type
to be used for writing.final void
AbstractGenericHttpMessageConverter.write
(T t, Type type, MediaType contentType, HttpOutputMessage outputMessage) This implementation sets the default headers by callingAbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType)
, and then callsAbstractGenericHttpMessageConverter.writeInternal(T, org.springframework.http.HttpOutputMessage)
.final void
AbstractGenericHttpMessageConverter.write
(T t, Type type, MediaType contentType, HttpOutputMessage outputMessage) This implementation sets the default headers by callingAbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType)
, and then callsAbstractGenericHttpMessageConverter.writeInternal(T, org.springframework.http.HttpOutputMessage)
.final void
AbstractHttpMessageConverter.write
(T t, MediaType contentType, HttpOutputMessage outputMessage) This implementation sets the default headers by callingAbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType)
, and then callsAbstractHttpMessageConverter.writeInternal(T, org.springframework.http.HttpOutputMessage)
.void
BufferedImageHttpMessageConverter.write
(BufferedImage image, MediaType contentType, HttpOutputMessage outputMessage) void
FormHttpMessageConverter.write
(MultiValueMap<String, ?> map, MediaType contentType, HttpOutputMessage outputMessage) void
GenericHttpMessageConverter.write
(T t, Type type, MediaType contentType, HttpOutputMessage outputMessage) Write a given object to the given output message.void
GenericHttpMessageConverter.write
(T t, Type type, MediaType contentType, HttpOutputMessage outputMessage) Write a given object to the given output message.void
HttpMessageConverter.write
(T t, MediaType contentType, HttpOutputMessage outputMessage) Write a given object to the given output message.protected abstract void
AbstractGenericHttpMessageConverter.writeInternal
(T t, Type type, HttpOutputMessage outputMessage) Abstract template method that writes the actual body.protected final void
AbstractKotlinSerializationHttpMessageConverter.writeInternal
(Object object, Type type, HttpOutputMessage outputMessage) protected void
ResourceRegionHttpMessageConverter.writeInternal
(Object object, Type type, HttpOutputMessage outputMessage) ModifierConstructorDescriptionHttpMessageConversionException
(String msg, Throwable cause) Create a new HttpMessageConversionException.HttpMessageNotReadableException
(String msg, Throwable cause) Deprecated.as of 5.1, in favor ofHttpMessageNotReadableException(String, Throwable, HttpInputMessage)
HttpMessageNotReadableException
(String msg, Throwable cause, HttpInputMessage httpInputMessage) Create a new HttpMessageNotReadableException.HttpMessageNotWritableException
(String msg, Throwable cause) Create a new HttpMessageNotWritableException. -
Uses of Nullable in org.springframework.http.converter.json
Modifier and TypeMethodDescriptionprotected MediaType
AbstractJackson2HttpMessageConverter.getDefaultContentType
(Object object) Class<?>
MappingJacksonInputMessage.getDeserializationView()
MappingJacksonValue.getFilters()
Return the Jackson filter provider to use.com.google.gson.Gson
GsonFactoryBean.getObject()
Return the created Gson instance.Jackson2ObjectMapperFactoryBean.getObject()
Return the singleton ObjectMapper.AbstractJackson2HttpMessageConverter.getObjectMappersForType
(Class<?> clazz) Return ObjectMapper registrations for the given class, if any.Class<?>
MappingJacksonValue.getSerializationView()
Return the serialization view to use.Modifier and TypeMethodDescriptionboolean
boolean
boolean
boolean
protected ObjectWriter
AbstractJackson2HttpMessageConverter.customizeWriter
(ObjectWriter writer, JavaType javaType, MediaType contentType) Subclasses can use this method to customizeObjectWriter
used for writing values.protected ObjectWriter
AbstractJackson2HttpMessageConverter.customizeWriter
(ObjectWriter writer, JavaType javaType, MediaType contentType) Subclasses can use this method to customizeObjectWriter
used for writing values.protected Charset
AbstractJackson2HttpMessageConverter.getCharset
(MediaType contentType) Determine the charset to use for JSON input.protected Long
AbstractJackson2HttpMessageConverter.getContentLength
(Object object, MediaType contentType) protected JavaType
AbstractJackson2HttpMessageConverter.getJavaType
(Type type, Class<?> contextClass) Return the JacksonJavaType
for the specified type and context class.protected JsonEncoding
AbstractJackson2HttpMessageConverter.getJsonEncoding
(MediaType contentType) Determine the JSON encoding to use for the given content type.protected void
AbstractJackson2HttpMessageConverter.logWarningIfNecessary
(Type type, Throwable cause) Determine whether to log the given exception coming from aObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType)
/ObjectMapper.canSerialize(java.lang.Class<?>)
check.AbstractJackson2HttpMessageConverter.read
(Type type, Class<?> contextClass, HttpInputMessage inputMessage) final Object
AbstractJsonHttpMessageConverter.read
(Type type, Class<?> contextClass, HttpInputMessage inputMessage) void
MappingJacksonInputMessage.setDeserializationView
(Class<?> deserializationView) void
MappingJacksonValue.setFilters
(FilterProvider filters) Set the Jackson filter provider to serialize the POJO with.void
ProblemDetailJacksonMixin.setProperty
(String name, Object value) void
ProblemDetailJacksonXmlMixin.setProperty
(String name, Object value) void
MappingJacksonValue.setSerializationView
(Class<?> serializationView) Set the serialization view to serialize the POJO with.protected void
AbstractJackson2HttpMessageConverter.writeInternal
(Object object, Type type, HttpOutputMessage outputMessage) protected abstract void
AbstractJsonHttpMessageConverter.writeInternal
(Object object, Type type, Writer writer) Template method that writes the JSON-bound object to the givenWriter
.protected final void
AbstractJsonHttpMessageConverter.writeInternal
(Object object, Type type, HttpOutputMessage outputMessage) protected void
GsonHttpMessageConverter.writeInternal
(Object object, Type type, Writer writer) protected void
JsonbHttpMessageConverter.writeInternal
(Object object, Type type, Writer writer) -
Uses of Nullable in org.springframework.http.converter.protobuf
Modifier and TypeMethodDescriptionprotected boolean
ModifierConstructorDescriptionProtobufJsonFormatHttpMessageConverter
(com.google.protobuf.util.JsonFormat.Parser parser, com.google.protobuf.util.JsonFormat.Printer printer) Constructor with given instances ofJsonFormat.Parser
,JsonFormat.Printer
, and a default instance ofExtensionRegistry
.ProtobufJsonFormatHttpMessageConverter
(com.google.protobuf.util.JsonFormat.Parser parser, com.google.protobuf.util.JsonFormat.Printer printer) Constructor with given instances ofJsonFormat.Parser
,JsonFormat.Printer
, and a default instance ofExtensionRegistry
.ProtobufJsonFormatHttpMessageConverter
(com.google.protobuf.util.JsonFormat.Parser parser, com.google.protobuf.util.JsonFormat.Printer printer, com.google.protobuf.ExtensionRegistry extensionRegistry) Constructor with given instances ofJsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
.ProtobufJsonFormatHttpMessageConverter
(com.google.protobuf.util.JsonFormat.Parser parser, com.google.protobuf.util.JsonFormat.Printer printer, com.google.protobuf.ExtensionRegistry extensionRegistry) Constructor with given instances ofJsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
.ProtobufJsonFormatHttpMessageConverter
(com.google.protobuf.util.JsonFormat.Parser parser, com.google.protobuf.util.JsonFormat.Printer printer, com.google.protobuf.ExtensionRegistry extensionRegistry) Constructor with given instances ofJsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
. -
Uses of Nullable in org.springframework.http.converter.xml
Modifier and TypeMethodDescriptionprotected Long
SourceHttpMessageConverter.getContentLength
(T t, MediaType contentType) Modifier and TypeMethodDescriptionboolean
Always returnsfalse
since Jaxb2CollectionHttpMessageConverter required generic type information in order to read a Collection.boolean
Indicates whether the given type can be read by this converter.boolean
Indicates whether the given type can be read by this converter.boolean
boolean
boolean
Always returnsfalse
since Jaxb2CollectionHttpMessageConverter does not convert collections to XML.boolean
Always returnsfalse
since Jaxb2CollectionHttpMessageConverter does not convert collections to XML.boolean
Always returnsfalse
since Jaxb2CollectionHttpMessageConverter does not convert collections to XML.boolean
Always returnsfalse
since Jaxb2CollectionHttpMessageConverter does not convert collections to XML.boolean
boolean
protected Long
SourceHttpMessageConverter.getContentLength
(T t, MediaType contentType) Jaxb2CollectionHttpMessageConverter.read
(Type type, Class<?> contextClass, HttpInputMessage inputMessage) void
Jaxb2CollectionHttpMessageConverter.write
(T t, Type type, MediaType contentType, HttpOutputMessage outputMessage) void
Jaxb2CollectionHttpMessageConverter.write
(T t, Type type, MediaType contentType, HttpOutputMessage outputMessage) -
Uses of Nullable in org.springframework.http.server
Modifier and TypeMethodDescriptionServerHttpRequest.getPrincipal()
Return aPrincipal
instance containing the name of the authenticated user.Modifier and TypeMethodDescriptionstatic RequestPath
Variant ofRequestPath.parse(URI, String)
with the encodedraw path
.static RequestPath
Parse the URI for a request into aRequestPath
. -
Uses of Nullable in org.springframework.http.server.observation
Modifier and TypeMethodDescriptionvoid
ServerRequestObservationContext.setPathPattern
(String pathPattern) -
Uses of Nullable in org.springframework.http.server.reactive
Modifier and TypeMethodDescriptiondefault InetSocketAddress
ServerHttpRequest.getLocalAddress()
Return the local address the request was accepted on, if available.ServerHttpRequestDecorator.getLocalAddress()
SslInfo.getPeerCertificates()
Return SSL certificates associated with the request, if any.AbstractServerHttpResponse.getRawStatusCode()
Deprecated.default Integer
ServerHttpResponse.getRawStatusCode()
Deprecated.as of 6.0, in favor ofServerHttpResponse.getStatusCode()
default InetSocketAddress
ServerHttpRequest.getRemoteAddress()
Return the remote address where this request is connected to, if available.ServerHttpRequestDecorator.getRemoteAddress()
ServletHttpHandlerAdapter.getServletConfig()
ServletHttpHandlerAdapter.getServletPath()
Return the Servlet path under which the Servlet is deployed by checking the Servlet registration fromServletHttpHandlerAdapter.init(ServletConfig)
.SslInfo.getSessionId()
Return the SSL session id, if any.AbstractServerHttpRequest.getSslInfo()
default SslInfo
ServerHttpRequest.getSslInfo()
Return the SSL session information if the request has been transmitted over a secure protocol including SSL certificates, if available.ServerHttpRequestDecorator.getSslInfo()
AbstractServerHttpResponse.getStatusCode()
ServerHttpResponse.getStatusCode()
Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server.protected String
AbstractServerHttpRequest.initId()
Obtain the request id to use, ornull
in which case the Object identity of this request instance is used.protected abstract SslInfo
AbstractServerHttpRequest.initSslInfo()
Obtain SSL session information from the underlying "native" request.protected abstract T
AbstractListenerReadPublisher.read()
Read once from the input, if possible.ChannelSendOperator.scanUnsafe
(reactor.core.Scannable.Attr key) Modifier and TypeMethodDescriptionprotected reactor.core.publisher.Mono<Void>
AbstractServerHttpResponse.doCommit
(Supplier<? extends reactor.core.publisher.Mono<Void>> writeAction) ApplybeforeCommit
actions, apply the response status and headers/cookies, and write the response body.boolean
AbstractServerHttpResponse.setRawStatusCode
(Integer statusCode) default boolean
ServerHttpResponse.setRawStatusCode
(Integer value) Set the HTTP status code to the given value as an integer.boolean
ServerHttpResponseDecorator.setRawStatusCode
(Integer value) boolean
AbstractServerHttpResponse.setStatusCode
(HttpStatusCode status) boolean
ServerHttpResponse.setStatusCode
(HttpStatusCode status) Set the HTTP status code of the response.boolean
ServerHttpResponseDecorator.setStatusCode
(HttpStatusCode status) ModifierConstructorDescriptionAbstractServerHttpRequest
(HttpMethod method, URI uri, String contextPath, MultiValueMap<String, String> headers) Constructor with the method, URI and headers for the request. -
Uses of Nullable in org.springframework.http.server.reactive.observation
Modifier and TypeMethodDescriptionServerRequestObservationContext.getPathPattern()
Return the path pattern for the handler that matches the current request.Modifier and TypeMethodDescriptionvoid
ServerRequestObservationContext.setPathPattern
(String pathPattern) Set the path pattern for the handler that matches the current request. -
Uses of Nullable in org.springframework.http.support
Modifier and TypeMethodDescriptionModifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
-
Uses of Nullable in org.springframework.instrument.classloading
Modifier and TypeMethodDescriptionResourceOverridingShadowingClassLoader.getResourceAsStream
(String requestedPath) ShadowingClassLoader.getResourceAsStream
(String name) Modifier and TypeMethodDescriptionbyte[]
WeavingTransformer.transformIfNecessary
(String className, String internalName, byte[] bytes, ProtectionDomain pd) Apply transformation on a given class byte definition.ModifierConstructorDescriptionInstrumentationLoadTimeWeaver
(ClassLoader classLoader) Create a new InstrumentationLoadTimeWeaver for the given ClassLoader.ReflectiveLoadTimeWeaver
(ClassLoader classLoader) Create a new SimpleLoadTimeWeaver for the given class loader.Create a new SimpleInstrumentableClassLoader for the given ClassLoader.Create a new SimpleThrowawayClassLoader for the given ClassLoader.WeavingTransformer
(ClassLoader classLoader) Create a new WeavingTransformer for the given class loader. -
Uses of Nullable in org.springframework.instrument.classloading.glassfish
ModifierConstructorDescriptionGlassFishLoadTimeWeaver
(ClassLoader classLoader) Create a new instance of theGlassFishLoadTimeWeaver
class using the suppliedClassLoader
. -
Uses of Nullable in org.springframework.instrument.classloading.jboss
ModifierConstructorDescriptionJBossLoadTimeWeaver
(ClassLoader classLoader) Create a new instance of theJBossLoadTimeWeaver
class using the suppliedClassLoader
. -
Uses of Nullable in org.springframework.instrument.classloading.tomcat
ModifierConstructorDescriptionTomcatLoadTimeWeaver
(ClassLoader classLoader) Create a new instance of theTomcatLoadTimeWeaver
class using the suppliedClassLoader
. -
Uses of Nullable in org.springframework.jca.endpoint
Modifier and TypeMethodDescriptionAbstractMessageEndpointFactory.getActivationName()
Implementation of the JCA 1.7#getActivationName()
method, returning the bean name as set on this MessageEndpointFactory.GenericMessageEndpointManager.getActivationSpec()
Return the JCA ActivationSpec to use for activating the endpoint.Class<?>
AbstractMessageEndpointFactory.getEndpointClass()
Implementation of the JCA 1.7#getEndpointClass()
method, returning null in order to indicate a synthetic endpoint type.GenericMessageEndpointManager.getMessageEndpointFactory()
Return the JCA MessageEndpointFactory to activate.GenericMessageEndpointManager.getResourceAdapter()
Return the JCA ResourceAdapter to manage endpoints for.Modifier and TypeMethodDescriptionvoid
AbstractMessageEndpointFactory.AbstractMessageEndpoint.beforeDelivery
(Method method) ThisbeforeDelivery
implementation starts a transaction, if necessary, and exposes the endpoint ClassLoader as current thread context ClassLoader.void
GenericMessageEndpointManager.setActivationSpec
(ActivationSpec activationSpec) Set the JCA ActivationSpec to use for activating the endpoint.void
GenericMessageEndpointManager.setMessageEndpointFactory
(MessageEndpointFactory messageEndpointFactory) Set the JCA MessageEndpointFactory to activate, pointing to a MessageListener object that the endpoints will delegate to.void
GenericMessageEndpointManager.setResourceAdapter
(ResourceAdapter resourceAdapter) Set the JCA ResourceAdapter to manage endpoints for. -
Uses of Nullable in org.springframework.jca.support
Modifier and TypeMethodDescriptionLocalConnectionFactoryBean.getObject()
ResourceAdapterFactoryBean.getObject()
SimpleBootstrapContext.getTransactionSynchronizationRegistry()
SimpleBootstrapContext.getXATerminator()
ModifierConstructorDescriptionSimpleBootstrapContext
(WorkManager workManager) Create a new SimpleBootstrapContext for the given WorkManager, with no XATerminator available.SimpleBootstrapContext
(WorkManager workManager, XATerminator xaTerminator) Create a new SimpleBootstrapContext for the given WorkManager and XATerminator.SimpleBootstrapContext
(WorkManager workManager, XATerminator xaTerminator) Create a new SimpleBootstrapContext for the given WorkManager and XATerminator.SimpleBootstrapContext
(WorkManager workManager, XATerminator xaTerminator, TransactionSynchronizationRegistry transactionSynchronizationRegistry) Create a new SimpleBootstrapContext for the given WorkManager, XATerminator and TransactionSynchronizationRegistry.SimpleBootstrapContext
(WorkManager workManager, XATerminator xaTerminator, TransactionSynchronizationRegistry transactionSynchronizationRegistry) Create a new SimpleBootstrapContext for the given WorkManager, XATerminator and TransactionSynchronizationRegistry.SimpleBootstrapContext
(WorkManager workManager, XATerminator xaTerminator, TransactionSynchronizationRegistry transactionSynchronizationRegistry) Create a new SimpleBootstrapContext for the given WorkManager, XATerminator and TransactionSynchronizationRegistry. -
Uses of Nullable in org.springframework.jdbc
Modifier and TypeMethodDescriptionInvalidResultSetAccessException.getSql()
Return the SQL that caused the problem.UncategorizedSQLException.getSql()
Return the SQL that led to the problem (if known).ModifierConstructorDescriptionConstructor forCannotGetJdbcConnectionException
.UncategorizedSQLException
(String task, String sql, SQLException ex) Constructor for UncategorizedSQLException. -
Uses of Nullable in org.springframework.jdbc.core
Modifier and TypeMethodDescriptionprotected Object
SingleColumnRowMapper.convertValueToRequiredType
(Object value, Class<?> requiredType) Convert the given column value to the specified required type.CallableStatementCallback.doInCallableStatement
(CallableStatement cs) Gets called byJdbcTemplate.execute
with an active JDBC CallableStatement.ConnectionCallback.doInConnection
(Connection con) Gets called byJdbcTemplate.execute
with an active JDBC Connection.PreparedStatementCallback.doInPreparedStatement
(PreparedStatement ps) Gets called byJdbcTemplate.execute
with an active JDBC PreparedStatement.StatementCallback.doInStatement
(Statement stmt) Gets called byJdbcTemplate.execute
with an active JDBC Statement.<T> T
JdbcOperations.execute
(String callString, CallableStatementCallback<T> action) Execute a JDBC data access operation, implemented as callback action working on a JDBC CallableStatement.<T> T
JdbcOperations.execute
(String sql, PreparedStatementCallback<T> action) Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement.<T> T
JdbcOperations.execute
(CallableStatementCreator csc, CallableStatementCallback<T> action) Execute a JDBC data access operation, implemented as callback action working on a JDBC CallableStatement.<T> T
JdbcOperations.execute
(ConnectionCallback<T> action) Execute a JDBC data access operation, implemented as callback action working on a JDBC Connection.<T> T
JdbcOperations.execute
(PreparedStatementCreator psc, PreparedStatementCallback<T> action) Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement.<T> T
JdbcOperations.execute
(StatementCallback<T> action) Execute a JDBC data access operation, implemented as callback action working on a JDBC Statement.<T> T
JdbcTemplate.execute
(String callString, CallableStatementCallback<T> action) <T> T
JdbcTemplate.execute
(String sql, PreparedStatementCallback<T> action) <T> T
JdbcTemplate.execute
(CallableStatementCreator csc, CallableStatementCallback<T> action) <T> T
JdbcTemplate.execute
(ConnectionCallback<T> action) <T> T
JdbcTemplate.execute
(PreparedStatementCreator psc, PreparedStatementCallback<T> action) <T> T
JdbcTemplate.execute
(StatementCallback<T> action) ResultSetExtractor.extractData
(ResultSet rs) Implementations must implement this method to process the entire ResultSet.final String[]
RowCountCallbackHandler.getColumnNames()
Return the names of the columns.final int[]
RowCountCallbackHandler.getColumnTypes()
Return the types of the columns as java.sql.Types constants Valid after processRow is invoked the first time.protected Object
BeanPropertyRowMapper.getColumnValue
(ResultSet rs, int index, PropertyDescriptor pd) Retrieve a JDBC object value for the specified column.protected Object
BeanPropertyRowMapper.getColumnValue
(ResultSet rs, int index, Class<?> paramType) Retrieve a JDBC object value for the specified column.protected Object
ColumnMapRowMapper.getColumnValue
(ResultSet rs, int index) Retrieve a JDBC object value for the specified column.protected Object
SingleColumnRowMapper.getColumnValue
(ResultSet rs, int index) Retrieve a JDBC object value for the specified column, using the most appropriate value type.protected Object
SingleColumnRowMapper.getColumnValue
(ResultSet rs, int index, Class<?> requiredType) Retrieve a JDBC object value for the specified column.BeanPropertyRowMapper.getConversionService()
Return aConversionService
for binding JDBC values to bean properties, ornull
if none.BeanPropertyRowMapper.getMappedClass()
Get the class that we are mapping to.SqlParameter.getName()
Return the name of the parameter, ornull
if anonymous.ResultSetSupportingSqlParameter.getResultSetExtractor()
Return the ResultSetExtractor held by this parameter, if any.ResultSetSupportingSqlParameter.getRowCallbackHandler()
Return the RowCallbackHandler held by this parameter, if any.RowMapper<?>
ResultSetSupportingSqlParameter.getRowMapper()
Return the RowMapper held by this parameter, if any.SqlParameter.getScale()
Return the scale of the parameter, if any.SqlProvider.getSql()
Return the SQL string for this object, i.e.SqlOutParameter.getSqlReturnType()
Return the custom return type, if any.SqlParameter.getTypeName()
Return the type name of the parameter, if any.SqlParameterValue.getValue()
Return the value object that this parameter value holds.Implementations must implement this method to map each row of data in theResultSet
.Extract a value for the single column in the current row.<T> T
JdbcOperations.query
(String sql, Object[] args, int[] argTypes, ResultSetExtractor<T> rse) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor.<T> T
JdbcOperations.query
(String sql, Object[] args, ResultSetExtractor<T> rse) Deprecated.as of 5.3, in favor ofJdbcOperations.query(String, ResultSetExtractor, Object...)
<T> T
JdbcOperations.query
(String sql, PreparedStatementSetter pss, ResultSetExtractor<T> rse) Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.<T> T
JdbcOperations.query
(String sql, ResultSetExtractor<T> rse) Execute a query given static SQL, reading the ResultSet with a ResultSetExtractor.<T> T
JdbcOperations.query
(String sql, ResultSetExtractor<T> rse, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor.<T> T
JdbcOperations.query
(PreparedStatementCreator psc, ResultSetExtractor<T> rse) Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.<T> T
JdbcTemplate.query
(String sql, Object[] args, int[] argTypes, ResultSetExtractor<T> rse) <T> T
JdbcTemplate.query
(String sql, Object[] args, ResultSetExtractor<T> rse) Deprecated.<T> T
JdbcTemplate.query
(String sql, PreparedStatementSetter pss, ResultSetExtractor<T> rse) <T> T
JdbcTemplate.query
(String sql, ResultSetExtractor<T> rse) <T> T
JdbcTemplate.query
(String sql, ResultSetExtractor<T> rse, Object... args) <T> T
JdbcTemplate.query
(PreparedStatementCreator psc, PreparedStatementSetter pss, ResultSetExtractor<T> rse) Query using a prepared statement, allowing for a PreparedStatementCreator and a PreparedStatementSetter.<T> T
JdbcTemplate.query
(PreparedStatementCreator psc, ResultSetExtractor<T> rse) <T> T
JdbcOperations.queryForObject
(String sql, Class<T> requiredType) Execute a query for a result object, given static SQL.<T> T
JdbcOperations.queryForObject
(String sql, Class<T> requiredType, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object.<T> T
JdbcOperations.queryForObject
(String sql, Object[] args, int[] argTypes, Class<T> requiredType) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object.<T> T
JdbcOperations.queryForObject
(String sql, Object[] args, int[] argTypes, RowMapper<T> rowMapper) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping a single result row to a result object via a RowMapper.<T> T
JdbcOperations.queryForObject
(String sql, Object[] args, Class<T> requiredType) Deprecated.as of 5.3, in favor ofJdbcOperations.queryForObject(String, Class, Object...)
<T> T
JdbcOperations.queryForObject
(String sql, Object[] args, RowMapper<T> rowMapper) Deprecated.as of 5.3, in favor ofJdbcOperations.queryForObject(String, RowMapper, Object...)
<T> T
JdbcOperations.queryForObject
(String sql, RowMapper<T> rowMapper) Execute a query given static SQL, mapping a single result row to a result object via a RowMapper.<T> T
JdbcOperations.queryForObject
(String sql, RowMapper<T> rowMapper, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping a single result row to a result object via a RowMapper.<T> T
JdbcTemplate.queryForObject
(String sql, Class<T> requiredType) <T> T
JdbcTemplate.queryForObject
(String sql, Object[] args, int[] argTypes, Class<T> requiredType) <T> T
JdbcTemplate.queryForObject
(String sql, Object[] args, int[] argTypes, RowMapper<T> rowMapper) <T> T
JdbcTemplate.queryForObject
(String sql, Object[] args, RowMapper<T> rowMapper) Deprecated.<T> T
JdbcTemplate.queryForObject
(String sql, RowMapper<T> rowMapper) <T> T
JdbcTemplate.queryForObject
(String sql, RowMapper<T> rowMapper, Object... args) Modifier and TypeMethodDescriptionstatic void
StatementCreatorUtils.cleanupParameters
(Object... paramValues) Clean up all resources held by parameter values which were passed to an execute method.static void
StatementCreatorUtils.cleanupParameters
(Collection<?> paramValues) Clean up all resources held by parameter values which were passed to an execute method.JdbcTemplate.extractReturnedResults
(CallableStatement cs, List<SqlParameter> updateCountParameters, List<SqlParameter> resultSetParameters, int updateCount) Extract returned ResultSets from the completed stored procedure.JdbcTemplate.extractReturnedResults
(CallableStatement cs, List<SqlParameter> updateCountParameters, List<SqlParameter> resultSetParameters, int updateCount) Extract returned ResultSets from the completed stored procedure.protected Object
SingleColumnRowMapper.getColumnValue
(ResultSet rs, int index, Class<?> requiredType) Retrieve a JDBC object value for the specified column.SqlReturnType.getTypeValue
(CallableStatement cs, int paramIndex, int sqlType, String typeName) Get the type value from the specific object.protected void
JdbcTemplate.handleWarnings
(SQLWarning warning) Throw aSQLWarningException
if encountering an actual warning.static int
StatementCreatorUtils.javaTypeToSqlParameterType
(Class<?> javaType) Derive a default SQL type from the given Java type.protected PreparedStatementSetter
JdbcTemplate.newArgPreparedStatementSetter
(Object[] args) Create a new arg-based PreparedStatementSetter using the args passed in.CallableStatementCreatorFactory.newCallableStatementCreator
(Map<String, ?> params) Return a new CallableStatementCreator instance given these parameters.static <T> BeanPropertyRowMapper<T>
BeanPropertyRowMapper.newInstance
(Class<T> mappedClass, ConversionService conversionService) Static factory method to create a newBeanPropertyRowMapper
.static <T> DataClassRowMapper<T>
DataClassRowMapper.newInstance
(Class<T> mappedClass, ConversionService conversionService) Static factory method to create a newDataClassRowMapper
.static <T> SingleColumnRowMapper<T>
SingleColumnRowMapper.newInstance
(Class<T> requiredType, ConversionService conversionService) Static factory method to create a newSingleColumnRowMapper
.PreparedStatementCreatorFactory.newPreparedStatementCreator
(Object[] params) Return a new PreparedStatementCreator for the given parameters.PreparedStatementCreatorFactory.newPreparedStatementCreator
(String sqlToUse, Object[] params) Return a new PreparedStatementCreator for the given parameters.PreparedStatementCreatorFactory.newPreparedStatementCreator
(List<?> params) Return a new PreparedStatementCreator for the given parameters.PreparedStatementCreatorFactory.newPreparedStatementSetter
(Object[] params) Return a new PreparedStatementSetter for the given parameters.PreparedStatementCreatorFactory.newPreparedStatementSetter
(List<?> params) Return a new PreparedStatementSetter for the given parameters.JdbcTemplate.processResultSet
(ResultSet rs, ResultSetSupportingSqlParameter param) Process the given ResultSet from a stored procedure.<T> T
JdbcOperations.query
(String sql, Object[] args, ResultSetExtractor<T> rse) Deprecated.as of 5.3, in favor ofJdbcOperations.query(String, ResultSetExtractor, Object...)
void
JdbcOperations.query
(String sql, Object[] args, RowCallbackHandler rch) Deprecated.as of 5.3, in favor ofJdbcOperations.query(String, RowCallbackHandler, Object...)
<T> List<T>
Deprecated.as of 5.3, in favor ofJdbcOperations.query(String, RowMapper, Object...)
<T> T
JdbcOperations.query
(String sql, PreparedStatementSetter pss, ResultSetExtractor<T> rse) Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.void
JdbcOperations.query
(String sql, PreparedStatementSetter pss, RowCallbackHandler rch) Query given SQL to create a prepared statement from SQL and a PreparedStatementSetter implementation that knows how to bind values to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler.<T> List<T>
JdbcOperations.query
(String sql, PreparedStatementSetter pss, RowMapper<T> rowMapper) Query given SQL to create a prepared statement from SQL and a PreparedStatementSetter implementation that knows how to bind values to the query, mapping each row to a result object via a RowMapper.<T> T
JdbcOperations.query
(String sql, ResultSetExtractor<T> rse, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor.void
JdbcOperations.query
(String sql, RowCallbackHandler rch, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler.<T> List<T>
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping each row to a result object via a RowMapper.<T> T
JdbcTemplate.query
(String sql, Object[] args, ResultSetExtractor<T> rse) Deprecated.void
JdbcTemplate.query
(String sql, Object[] args, RowCallbackHandler rch) Deprecated.<T> List<T>
Deprecated.<T> T
JdbcTemplate.query
(String sql, PreparedStatementSetter pss, ResultSetExtractor<T> rse) void
JdbcTemplate.query
(String sql, PreparedStatementSetter pss, RowCallbackHandler rch) <T> List<T>
JdbcTemplate.query
(String sql, PreparedStatementSetter pss, RowMapper<T> rowMapper) <T> T
JdbcTemplate.query
(String sql, ResultSetExtractor<T> rse, Object... args) void
JdbcTemplate.query
(String sql, RowCallbackHandler rch, Object... args) <T> List<T>
<T> T
JdbcTemplate.query
(PreparedStatementCreator psc, PreparedStatementSetter pss, ResultSetExtractor<T> rse) Query using a prepared statement, allowing for a PreparedStatementCreator and a PreparedStatementSetter.<T> List<T>
JdbcOperations.queryForList
(String sql, Class<T> elementType, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list.JdbcOperations.queryForList
(String sql, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list.<T> List<T>
JdbcOperations.queryForList
(String sql, Object[] args, Class<T> elementType) Deprecated.as of 5.3, in favor ofJdbcOperations.queryForList(String, Class, Object...)
<T> List<T>
JdbcTemplate.queryForList
(String sql, Class<T> elementType, Object... args) JdbcTemplate.queryForList
(String sql, Object... args) <T> List<T>
JdbcTemplate.queryForList
(String sql, Object[] args, Class<T> elementType) Deprecated.JdbcOperations.queryForMap
(String sql, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result map.JdbcTemplate.queryForMap
(String sql, Object... args) <T> T
JdbcOperations.queryForObject
(String sql, Class<T> requiredType, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object.<T> T
JdbcOperations.queryForObject
(String sql, Object[] args, Class<T> requiredType) Deprecated.as of 5.3, in favor ofJdbcOperations.queryForObject(String, Class, Object...)
<T> T
JdbcOperations.queryForObject
(String sql, Object[] args, RowMapper<T> rowMapper) Deprecated.as of 5.3, in favor ofJdbcOperations.queryForObject(String, RowMapper, Object...)
<T> T
JdbcOperations.queryForObject
(String sql, RowMapper<T> rowMapper, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping a single result row to a result object via a RowMapper.<T> T
JdbcTemplate.queryForObject
(String sql, Class<T> requiredType, Object... args) <T> T
JdbcTemplate.queryForObject
(String sql, Object[] args, Class<T> requiredType) Deprecated.<T> T
JdbcTemplate.queryForObject
(String sql, Object[] args, RowMapper<T> rowMapper) Deprecated.<T> T
JdbcTemplate.queryForObject
(String sql, RowMapper<T> rowMapper, Object... args) JdbcOperations.queryForRowSet
(String sql, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting an SqlRowSet.JdbcTemplate.queryForRowSet
(String sql, Object... args) <T> Stream<T>
JdbcOperations.queryForStream
(String sql, PreparedStatementSetter pss, RowMapper<T> rowMapper) Query given SQL to create a prepared statement from SQL and a PreparedStatementSetter implementation that knows how to bind values to the query, mapping each row to a result object via a RowMapper, and turning it into an iterable and closeable Stream.<T> Stream<T>
JdbcOperations.queryForStream
(String sql, RowMapper<T> rowMapper, Object... args) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping each row to a result object via a RowMapper, and turning it into an iterable and closeable Stream.<T> Stream<T>
JdbcTemplate.queryForStream
(String sql, PreparedStatementSetter pss, RowMapper<T> rowMapper) <T> Stream<T>
JdbcTemplate.queryForStream
(String sql, RowMapper<T> rowMapper, Object... args) <T> Stream<T>
JdbcTemplate.queryForStream
(PreparedStatementCreator psc, PreparedStatementSetter pss, RowMapper<T> rowMapper) Query using a prepared statement, allowing for a PreparedStatementCreator and a PreparedStatementSetter.void
BeanPropertyRowMapper.setConversionService
(ConversionService conversionService) Set aConversionService
for binding JDBC values to bean properties, ornull
for none.void
SingleColumnRowMapper.setConversionService
(ConversionService conversionService) Set aConversionService
for converting a fetched value.static void
StatementCreatorUtils.setParameterValue
(PreparedStatement ps, int paramIndex, int sqlType, Object inValue) Set the value for a parameter.static void
StatementCreatorUtils.setParameterValue
(PreparedStatement ps, int paramIndex, int sqlType, String typeName, Object inValue) Set the value for a parameter.static void
StatementCreatorUtils.setParameterValue
(PreparedStatement ps, int paramIndex, SqlParameter param, Object inValue) Set the value for a parameter.void
SqlTypeValue.setTypeValue
(PreparedStatement ps, int paramIndex, int sqlType, String typeName) Set the type value on the given PreparedStatement.static List<SqlParameter>
SqlParameter.sqlTypesToAnonymousParameterList
(int... types) Convert a list of JDBC types, as defined injava.sql.Types
, to a List of SqlParameter objects as used in this package.protected DataAccessException
JdbcTemplate.translateException
(String task, String sql, SQLException ex) Translate the givenSQLException
into a genericDataAccessException
.int
Issue a single SQL update operation (such as an insert, update or delete statement) via a prepared statement, binding the given arguments.int
JdbcOperations.update
(String sql, PreparedStatementSetter pss) Issue an update statement using a PreparedStatementSetter to set bind parameters, with given SQL.int
int
JdbcTemplate.update
(String sql, PreparedStatementSetter pss) protected int
JdbcTemplate.update
(PreparedStatementCreator psc, PreparedStatementSetter pss) ModifierConstructorDescriptionCreate a new ArgPreparedStatementSetter for the given arguments.ArgumentTypePreparedStatementSetter
(Object[] args, int[] argTypes) Create a new ArgTypePreparedStatementSetter for the given arguments.ArgumentTypePreparedStatementSetter
(Object[] args, int[] argTypes) Create a new ArgTypePreparedStatementSetter for the given arguments.ResultSetSupportingSqlParameter
(String name, int sqlType, String typeName) Create a new ResultSetSupportingSqlParameter.SqlOutParameter
(String name, int sqlType, String typeName) Create a new SqlOutParameter.SqlOutParameter
(String name, int sqlType, String typeName, SqlReturnType sqlReturnType) Create a new SqlOutParameter.SqlOutParameter
(String name, int sqlType, String typeName, SqlReturnType sqlReturnType) Create a new SqlOutParameter.SqlParameter
(int sqlType, String typeName) Create a new anonymous SqlParameter, supplying the SQL type.SqlParameter
(String name, int sqlType, String typeName) Create a new SqlParameter, supplying name and SQL type.SqlParameterValue
(int sqlType, int scale, Object value) Create a new SqlParameterValue, supplying the SQL type.SqlParameterValue
(int sqlType, Object value) Create a new SqlParameterValue, supplying the SQL type.SqlParameterValue
(int sqlType, String typeName, Object value) Create a new SqlParameterValue, supplying the SQL type.SqlParameterValue
(int sqlType, String typeName, Object value) Create a new SqlParameterValue, supplying the SQL type.SqlParameterValue
(SqlParameter declaredParam, Object value) Create a new SqlParameterValue based on the given SqlParameter declaration. -
Uses of Nullable in org.springframework.jdbc.core.metadata
Modifier and TypeMethodDescriptionCallMetaDataProvider.catalogNameToUse
(String catalogName) Provide any modification of the catalog name passed in to match the meta-data currently used.GenericCallMetaDataProvider.catalogNameToUse
(String catalogName) GenericTableMetaDataProvider.catalogNameToUse
(String catalogName) TableMetaDataProvider.catalogNameToUse
(String catalogName) Get the catalog name formatted based on meta-data information.CallMetaDataContext.getCatalogName()
Get the name of the catalog.TableMetaDataContext.getCatalogName()
Get the name of the catalog for this context.protected String
GenericTableMetaDataProvider.getDatabaseVersion()
Provide access to version info for subclasses.protected String
GenericTableMetaDataProvider.getDefaultSchema()
Provide access to default schema for subclasses.protected String
OracleTableMetaDataProvider.getDefaultSchema()
CallParameterMetaData.getParameterName()
Return the parameter name.CallMetaDataContext.getProcedureName()
Get the name of the procedure.CallMetaDataContext.getScalarOutParameterName()
Get the name of the single out parameter for this call.CallMetaDataContext.getSchemaName()
Get the name of the schema.TableMetaDataContext.getSchemaName()
Get the name of the schema for this context.GenericTableMetaDataProvider.getSimpleQueryForGetGeneratedKey
(String tableName, String keyColumnName) TableMetaDataContext.getSimpleQueryForGetGeneratedKey
(String tableName, String keyColumnName) Does this database support a simple query to retrieve generated keys when the JDBC 3.0 feature is not supported:DatabaseMetaData.supportsGetGeneratedKeys()
?TableMetaDataProvider.getSimpleQueryForGetGeneratedKey
(String tableName, String keyColumnName) Get the simple query to retrieve a generated key.TableMetaDataContext.getTableName()
Get the name of the table for this context.CallParameterMetaData.getTypeName()
Return the parameter type name.CallMetaDataProvider.getUserName()
Get the name of the current user.CallMetaDataProvider.metaDataCatalogNameToUse
(String catalogName) Provide any modification of the catalog name passed in to match the meta-data currently used.GenericCallMetaDataProvider.metaDataCatalogNameToUse
(String catalogName) GenericTableMetaDataProvider.metaDataCatalogNameToUse
(String catalogName) OracleCallMetaDataProvider.metaDataCatalogNameToUse
(String catalogName) TableMetaDataProvider.metaDataCatalogNameToUse
(String catalogName) Provide any modification of the catalog name passed in to match the meta-data currently used.CallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) Provide any modification of the schema name passed in to match the meta-data currently used.Db2CallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) DerbyCallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) GenericCallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) GenericTableMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) OracleCallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) PostgresCallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) TableMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) Provide any modification of the schema name passed in to match the meta-data currently used.CallMetaDataProvider.parameterNameToUse
(String parameterName) Provide any modification of the column name passed in to match the meta-data currently used.GenericCallMetaDataProvider.parameterNameToUse
(String parameterName) SqlServerCallMetaDataProvider.parameterNameToUse
(String parameterName) SybaseCallMetaDataProvider.parameterNameToUse
(String parameterName) CallMetaDataProvider.procedureNameToUse
(String procedureName) Provide any modification of the procedure name passed in to match the meta-data currently used.GenericCallMetaDataProvider.procedureNameToUse
(String procedureName) CallMetaDataProvider.schemaNameToUse
(String schemaName) Provide any modification of the schema name passed in to match the meta-data currently used.GenericCallMetaDataProvider.schemaNameToUse
(String schemaName) GenericTableMetaDataProvider.schemaNameToUse
(String schemaName) TableMetaDataProvider.schemaNameToUse
(String schemaName) Get the schema name formatted based on meta-data information.GenericTableMetaDataProvider.tableNameToUse
(String tableName) TableMetaDataProvider.tableNameToUse
(String tableName) Get the table name formatted based on meta-data information.Modifier and TypeMethodDescriptionCallMetaDataProvider.catalogNameToUse
(String catalogName) Provide any modification of the catalog name passed in to match the meta-data currently used.GenericCallMetaDataProvider.catalogNameToUse
(String catalogName) GenericTableMetaDataProvider.catalogNameToUse
(String catalogName) TableMetaDataProvider.catalogNameToUse
(String catalogName) Get the catalog name formatted based on meta-data information.void
CallMetaDataProvider.initializeWithProcedureColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String procedureName) Initialize the database specific management of procedure column meta-data.void
CallMetaDataProvider.initializeWithProcedureColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String procedureName) Initialize the database specific management of procedure column meta-data.void
CallMetaDataProvider.initializeWithProcedureColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String procedureName) Initialize the database specific management of procedure column meta-data.void
GenericCallMetaDataProvider.initializeWithProcedureColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String procedureName) void
GenericCallMetaDataProvider.initializeWithProcedureColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String procedureName) void
GenericCallMetaDataProvider.initializeWithProcedureColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String procedureName) void
GenericTableMetaDataProvider.initializeWithTableColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) void
GenericTableMetaDataProvider.initializeWithTableColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) void
GenericTableMetaDataProvider.initializeWithTableColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) void
OracleTableMetaDataProvider.initializeWithTableColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) void
OracleTableMetaDataProvider.initializeWithTableColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) void
OracleTableMetaDataProvider.initializeWithTableColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) void
TableMetaDataProvider.initializeWithTableColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) Initialize using provided database meta-data, table and column information.void
TableMetaDataProvider.initializeWithTableColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) Initialize using provided database meta-data, table and column information.void
TableMetaDataProvider.initializeWithTableColumnMetaData
(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) Initialize using provided database meta-data, table and column information.CallMetaDataProvider.metaDataCatalogNameToUse
(String catalogName) Provide any modification of the catalog name passed in to match the meta-data currently used.GenericCallMetaDataProvider.metaDataCatalogNameToUse
(String catalogName) GenericTableMetaDataProvider.metaDataCatalogNameToUse
(String catalogName) OracleCallMetaDataProvider.metaDataCatalogNameToUse
(String catalogName) TableMetaDataProvider.metaDataCatalogNameToUse
(String catalogName) Provide any modification of the catalog name passed in to match the meta-data currently used.CallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) Provide any modification of the schema name passed in to match the meta-data currently used.Db2CallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) DerbyCallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) GenericCallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) GenericTableMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) OracleCallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) PostgresCallMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) TableMetaDataProvider.metaDataSchemaNameToUse
(String schemaName) Provide any modification of the schema name passed in to match the meta-data currently used.CallMetaDataProvider.parameterNameToUse
(String parameterName) Provide any modification of the column name passed in to match the meta-data currently used.GenericCallMetaDataProvider.parameterNameToUse
(String parameterName) SqlServerCallMetaDataProvider.parameterNameToUse
(String parameterName) SybaseCallMetaDataProvider.parameterNameToUse
(String parameterName) CallMetaDataProvider.procedureNameToUse
(String procedureName) Provide any modification of the procedure name passed in to match the meta-data currently used.GenericCallMetaDataProvider.procedureNameToUse
(String procedureName) CallMetaDataProvider.schemaNameToUse
(String schemaName) Provide any modification of the schema name passed in to match the meta-data currently used.GenericCallMetaDataProvider.schemaNameToUse
(String schemaName) GenericTableMetaDataProvider.schemaNameToUse
(String schemaName) TableMetaDataProvider.schemaNameToUse
(String schemaName) Get the schema name formatted based on meta-data information.void
CallMetaDataContext.setCatalogName
(String catalogName) Specify the name of the catalog.void
TableMetaDataContext.setCatalogName
(String catalogName) Set the name of the catalog for this context.void
CallMetaDataContext.setProcedureName
(String procedureName) Specify the name of the procedure.void
CallMetaDataContext.setSchemaName
(String schemaName) Specify the name of the schema.void
TableMetaDataContext.setSchemaName
(String schemaName) Set the name of the schema for this context.void
TableMetaDataContext.setTableName
(String tableName) Set the name of the table for this context.GenericTableMetaDataProvider.tableNameToUse
(String tableName) TableMetaDataProvider.tableNameToUse
(String tableName) Get the table name formatted based on meta-data information.ModifierConstructorDescriptionCallParameterMetaData
(boolean function, String columnName, int columnType, int sqlType, String typeName, boolean nullable) Constructor taking all the properties including the function marker.CallParameterMetaData
(boolean function, String columnName, int columnType, int sqlType, String typeName, boolean nullable) Constructor taking all the properties including the function marker. -
Uses of Nullable in org.springframework.jdbc.core.namedparam
Modifier and TypeMethodDescription<T> T
NamedParameterJdbcOperations.execute
(String sql, Map<String, ?> paramMap, PreparedStatementCallback<T> action) Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement.<T> T
NamedParameterJdbcOperations.execute
(String sql, SqlParameterSource paramSource, PreparedStatementCallback<T> action) Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement.<T> T
NamedParameterJdbcOperations.execute
(String sql, PreparedStatementCallback<T> action) Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement.<T> T
NamedParameterJdbcTemplate.execute
(String sql, Map<String, ?> paramMap, PreparedStatementCallback<T> action) <T> T
NamedParameterJdbcTemplate.execute
(String sql, SqlParameterSource paramSource, PreparedStatementCallback<T> action) <T> T
NamedParameterJdbcTemplate.execute
(String sql, PreparedStatementCallback<T> action) NamedParameterJdbcDaoSupport.getNamedParameterJdbcTemplate()
Return a NamedParameterJdbcTemplate wrapping the configured JdbcTemplate.String[]
EmptySqlParameterSource.getParameterNames()
default String[]
SqlParameterSource.getParameterNames()
Enumerate all available parameter names if possible.static Object
SqlParameterSourceUtils.getTypedValue
(SqlParameterSource source, String parameterName) Create a wrapped value if parameter has type information, plain object if not.AbstractSqlParameterSource.getTypeName
(String paramName) Return the type name for the given parameter, if registered.EmptySqlParameterSource.getTypeName
(String paramName) default String
SqlParameterSource.getTypeName
(String paramName) Determine the type name for the specified named parameter.Return the parameter value for the requested named parameter.<T> T
NamedParameterJdbcOperations.query
(String sql, Map<String, ?> paramMap, ResultSetExtractor<T> rse) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor.<T> T
NamedParameterJdbcOperations.query
(String sql, SqlParameterSource paramSource, ResultSetExtractor<T> rse) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor.<T> T
NamedParameterJdbcOperations.query
(String sql, ResultSetExtractor<T> rse) Query given SQL to create a prepared statement from SQL, reading the ResultSet with a ResultSetExtractor.<T> T
NamedParameterJdbcTemplate.query
(String sql, Map<String, ?> paramMap, ResultSetExtractor<T> rse) <T> T
NamedParameterJdbcTemplate.query
(String sql, SqlParameterSource paramSource, ResultSetExtractor<T> rse) <T> T
NamedParameterJdbcTemplate.query
(String sql, ResultSetExtractor<T> rse) <T> T
NamedParameterJdbcOperations.queryForObject
(String sql, Map<String, ?> paramMap, Class<T> requiredType) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object.<T> T
NamedParameterJdbcOperations.queryForObject
(String sql, Map<String, ?> paramMap, RowMapper<T> rowMapper) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping a single result row to a Java object via a RowMapper.<T> T
NamedParameterJdbcOperations.queryForObject
(String sql, SqlParameterSource paramSource, Class<T> requiredType) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object.<T> T
NamedParameterJdbcOperations.queryForObject
(String sql, SqlParameterSource paramSource, RowMapper<T> rowMapper) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping a single result row to a Java object via a RowMapper.<T> T
NamedParameterJdbcTemplate.queryForObject
(String sql, Map<String, ?> paramMap, Class<T> requiredType) <T> T
NamedParameterJdbcTemplate.queryForObject
(String sql, Map<String, ?> paramMap, RowMapper<T> rowMapper) <T> T
NamedParameterJdbcTemplate.queryForObject
(String sql, SqlParameterSource paramSource, Class<T> requiredType) <T> T
NamedParameterJdbcTemplate.queryForObject
(String sql, SqlParameterSource paramSource, RowMapper<T> rowMapper) Modifier and TypeMethodDescriptionAdd a parameter to this parameter source.Add a parameter to this parameter source.Add a parameter to this parameter source.Add a Map of parameters to this parameter source.static Object[]
NamedParameterUtils.buildValueArray
(ParsedSql parsedSql, SqlParameterSource paramSource, List<SqlParameter> declaredParams) Convert a Map of named parameter values to a corresponding array.protected PreparedStatementCreator
NamedParameterJdbcTemplate.getPreparedStatementCreator
(String sql, SqlParameterSource paramSource, Consumer<PreparedStatementCreatorFactory> customizer) Build aPreparedStatementCreator
based on the given SQL and named parameters.static String
NamedParameterUtils.substituteNamedParameters
(ParsedSql parsedSql, SqlParameterSource paramSource) Parse the SQL statement and locate any placeholders or named parameters.int
NamedParameterJdbcTemplate.update
(String sql, SqlParameterSource paramSource, KeyHolder generatedKeyHolder, String[] keyColumnNames) ModifierConstructorDescriptionMapSqlParameterSource
(String paramName, Object value) Create a new MapSqlParameterSource, with one value comprised of the supplied arguments.MapSqlParameterSource
(Map<String, ?> values) Create a new MapSqlParameterSource based on a Map. -
Uses of Nullable in org.springframework.jdbc.core.simple
Modifier and TypeMethodDescriptionAbstractJdbcCall.getCallString()
Get the call string that should be used based on parameters and meta-data.AbstractJdbcCall.getCatalogName()
Get the catalog name used.AbstractJdbcInsert.getCatalogName()
Get the name of the catalog for this insert.AbstractJdbcCall.getProcedureName()
Get the name of the stored procedure.protected String
AbstractJdbcCall.getScalarOutParameterName()
Get the name of a single out parameter or return value.AbstractJdbcCall.getSchemaName()
Get the schema name used.AbstractJdbcInsert.getSchemaName()
Get the name of the schema for this insert.AbstractJdbcInsert.getTableName()
Get the name of the table for this insert.Modifier and TypeMethodDescriptionvoid
AbstractJdbcCall.setCatalogName
(String catalogName) Set the catalog name to use.void
AbstractJdbcInsert.setCatalogName
(String catalogName) Set the name of the catalog for this insert.void
AbstractJdbcCall.setProcedureName
(String procedureName) Set the name of the stored procedure.void
AbstractJdbcCall.setSchemaName
(String schemaName) Set the schema name to use.void
AbstractJdbcInsert.setSchemaName
(String schemaName) Set the name of the schema for this insert.void
AbstractJdbcInsert.setTableName
(String tableName) Set the name of the table for this insert. -
Uses of Nullable in org.springframework.jdbc.core.support
Modifier and TypeMethodDescriptionfinal T
AbstractLobStreamingResultSetExtractor.extractData
(ResultSet rs) Delegates to handleNoRowFound, handleMultipleRowsFound and streamData, according to the ResultSet state.final DataSource
JdbcDaoSupport.getDataSource()
Return the JDBC DataSource used by this DAO.final JdbcTemplate
JdbcDaoSupport.getJdbcTemplate()
Return the JdbcTemplate for this DAO, pre-initialized with the DataSource or set explicitly.Modifier and TypeMethodDescriptionprotected abstract Object
AbstractSqlTypeValue.createTypeValue
(Connection con, int sqlType, String typeName) Create the type value to be passed intoPreparedStatement.setObject
.final void
JdbcDaoSupport.setJdbcTemplate
(JdbcTemplate jdbcTemplate) Set the JdbcTemplate for this DAO explicitly, as an alternative to specifying a DataSource.final void
AbstractSqlTypeValue.setTypeValue
(PreparedStatement ps, int paramIndex, int sqlType, String typeName) void
SqlLobValue.setTypeValue
(PreparedStatement ps, int paramIndex, int sqlType, String typeName) Set the specified content via the LobCreator.ModifierConstructorDescriptionSqlLobValue
(byte[] bytes) Create a new BLOB value with the given byte array, using a DefaultLobHandler.SqlLobValue
(byte[] bytes, LobHandler lobHandler) Create a new BLOB value with the given byte array.SqlLobValue
(String content) Create a new CLOB value with the given content string, using a DefaultLobHandler.SqlLobValue
(String content, LobHandler lobHandler) Create a new CLOB value with the given content string. -
Uses of Nullable in org.springframework.jdbc.datasource
Modifier and TypeMethodDescriptionprotected Boolean
LazyConnectionDataSourceProxy.defaultAutoCommit()
Expose the default auto-commit value.protected Integer
LazyConnectionDataSourceProxy.defaultTransactionIsolation()
Expose the default transaction isolation value.protected Boolean
SingleConnectionDataSource.getAutoCommitValue()
Return whether the returned Connection's "autoCommit" setting should be overridden.AbstractDriverBasedDataSource.getCatalog()
Return the database catalog to be applied to each Connection, if any.ConnectionHolder.getConnectionHandle()
Return the ConnectionHandle held by this ConnectionHolder.AbstractDriverBasedDataSource.getConnectionProperties()
Return the connection properties to be passed to the Driver, if any.protected Integer
IsolationLevelDataSourceAdapter.getCurrentIsolationLevel()
Determine the current isolation level: either the transaction's isolation level or a statically defined isolation level.protected Boolean
IsolationLevelDataSourceAdapter.getCurrentReadOnlyFlag()
Determine the current read-only flag: by default, the transaction's read-only hint.DataSourceTransactionManager.getDataSource()
Return the JDBCDataSource
that this instance manages transactions for.SimpleDriverDataSource.getDriver()
Return the JDBC Driver instance to use.protected Integer
IsolationLevelDataSourceAdapter.getIsolationLevel()
Return the statically specified isolation level, ornull
if none.AbstractDriverBasedDataSource.getPassword()
Return the JDBC password to use for connecting through the Driver.JdbcTransactionObjectSupport.getPreviousIsolationLevel()
Return the retained previous isolation level, if any.AbstractDriverBasedDataSource.getSchema()
Return the database schema to be applied to each Connection, if any.DelegatingDataSource.getTargetDataSource()
Return the target DataSource that this DataSource should delegate to.AbstractDriverBasedDataSource.getUrl()
Return the JDBC URL to use for connecting through the Driver.AbstractDriverBasedDataSource.getUsername()
Return the JDBC username to use for connecting through the Driver.static Integer
DataSourceUtils.prepareConnectionForTransaction
(Connection con, TransactionDefinition definition) Prepare the given Connection with the given transaction semantics.Modifier and TypeMethodDescriptionstatic void
DataSourceUtils.applyTimeout
(Statement stmt, DataSource dataSource, int timeout) Apply the specified timeout - overridden by the current transaction timeout, if any - to the given JDBC Statement object.static void
DataSourceUtils.applyTransactionTimeout
(Statement stmt, DataSource dataSource) Apply the current transaction timeout, if any, to the given JDBC Statement object.static void
DataSourceUtils.doCloseConnection
(Connection con, DataSource dataSource) Close the Connection, unless aSmartDataSource
doesn't want us to.protected Connection
IsolationLevelDataSourceAdapter.doGetConnection
(String username, String password) Applies the current isolation level value and read-only flag to the returned Connection.protected Connection
IsolationLevelDataSourceAdapter.doGetConnection
(String username, String password) Applies the current isolation level value and read-only flag to the returned Connection.protected Connection
UserCredentialsDataSourceAdapter.doGetConnection
(String username, String password) This implementation delegates to thegetConnection(username, password)
method of the target DataSource, passing in the specified user credentials.protected Connection
UserCredentialsDataSourceAdapter.doGetConnection
(String username, String password) This implementation delegates to thegetConnection(username, password)
method of the target DataSource, passing in the specified user credentials.static void
DataSourceUtils.doReleaseConnection
(Connection con, DataSource dataSource) Actually close the given Connection, obtained from the given DataSource.static void
DataSourceUtils.doReleaseConnection
(Connection con, DataSource dataSource) Actually close the given Connection, obtained from the given DataSource.protected void
protected Connection
AbstractDriverBasedDataSource.getConnectionFromDriver
(String username, String password) Build properties for the Driver, including the given username and password (if any), and obtain a corresponding Connection.protected Connection
AbstractDriverBasedDataSource.getConnectionFromDriver
(String username, String password) Build properties for the Driver, including the given username and password (if any), and obtain a corresponding Connection.static boolean
DataSourceUtils.isConnectionTransactional
(Connection con, DataSource dataSource) Determine whether the given JDBC Connection is transactional, that is, bound to the current thread by Spring's transaction facilities.static Integer
DataSourceUtils.prepareConnectionForTransaction
(Connection con, TransactionDefinition definition) Prepare the given Connection with the given transaction semantics.static void
DataSourceUtils.releaseConnection
(Connection con, DataSource dataSource) Close the given Connection, obtained from the given DataSource, if it is not managed externally (that is, not bound to the thread).static void
DataSourceUtils.releaseConnection
(Connection con, DataSource dataSource) Close the given Connection, obtained from the given DataSource, if it is not managed externally (that is, not bound to the thread).static void
DataSourceUtils.resetConnectionAfterTransaction
(Connection con, Integer previousIsolationLevel) Deprecated.as of 5.1.11, in favor ofDataSourceUtils.resetConnectionAfterTransaction(Connection, Integer, boolean)
static void
DataSourceUtils.resetConnectionAfterTransaction
(Connection con, Integer previousIsolationLevel, boolean resetReadOnly) Reset the given Connection after a transaction, regarding read-only flag and isolation level.void
AbstractDriverBasedDataSource.setCatalog
(String catalog) Specify a database catalog to be applied to each Connection.protected void
ConnectionHolder.setConnection
(Connection connection) Override the existing Connection handle with the given Connection.void
JdbcTransactionObjectSupport.setConnectionHolder
(ConnectionHolder connectionHolder) Set the ConnectionHolder for this transaction object.void
AbstractDriverBasedDataSource.setConnectionProperties
(Properties connectionProperties) Specify arbitrary connection properties as key/value pairs, to be passed to the Driver.void
DataSourceTransactionManager.setDataSource
(DataSource dataSource) Set the JDBCDataSource
that this instance should manage transactions for.void
Specify the JDBC Driver instance to use.void
AbstractDriverBasedDataSource.setPassword
(String password) Set the JDBC password to use for connecting through the Driver.void
JdbcTransactionObjectSupport.setPreviousIsolationLevel
(Integer previousIsolationLevel) Set the previous isolation level to retain, if any.void
Specify a database schema to be applied to each Connection.void
DelegatingDataSource.setTargetDataSource
(DataSource targetDataSource) Set the target DataSource that this DataSource should delegate to.void
Set the JDBC URL to use for connecting through the Driver.void
AbstractDriverBasedDataSource.setUsername
(String username) Set the JDBC username to use for connecting through the Driver. -
Uses of Nullable in org.springframework.jdbc.datasource.embedded
Modifier and TypeMethodDescriptionprotected final DataSource
EmbeddedDatabaseFactory.getDataSource()
Hook that gets theDataSource
that provides the connectivity to the embedded database.EmbeddedDatabaseFactoryBean.getObject()
-
Uses of Nullable in org.springframework.jdbc.datasource.init
Modifier and TypeMethodDescriptionstatic void
ScriptUtils.executeSqlScript
(Connection connection, EncodedResource resource, boolean continueOnError, boolean ignoreFailedDrops, String[] commentPrefixes, String separator, String blockCommentStartDelimiter, String blockCommentEndDelimiter) Execute the given SQL script.static void
ScriptUtils.executeSqlScript
(Connection connection, EncodedResource resource, boolean continueOnError, boolean ignoreFailedDrops, String commentPrefix, String separator, String blockCommentStartDelimiter, String blockCommentEndDelimiter) Execute the given SQL script.void
ResourceDatabasePopulator.setSqlScriptEncoding
(String sqlScriptEncoding) Specify the encoding for the configured SQL scripts, if different from the platform encoding.ModifierConstructorDescriptionResourceDatabasePopulator
(boolean continueOnError, boolean ignoreFailedDrops, String sqlScriptEncoding, Resource... scripts) Construct a newResourceDatabasePopulator
with the supplied values.ScriptException
(String message, Throwable cause) Create a newScriptException
.ScriptParseException
(String message, EncodedResource resource) Create a newScriptParseException
.ScriptParseException
(String message, EncodedResource resource, Throwable cause) Create a newScriptParseException
.ScriptParseException
(String message, EncodedResource resource, Throwable cause) Create a newScriptParseException
. -
Uses of Nullable in org.springframework.jdbc.datasource.lookup
Modifier and TypeMethodDescriptionprotected abstract Object
AbstractRoutingDataSource.determineCurrentLookupKey()
Determine the current lookup key.protected Object
IsolationLevelDataSourceRouter.determineCurrentLookupKey()
AbstractRoutingDataSource.getResolvedDefaultDataSource()
Return the resolved default target DataSource, if any.Modifier and TypeMethodDescriptionvoid
AbstractRoutingDataSource.setDataSourceLookup
(DataSourceLookup dataSourceLookup) Set the DataSourceLookup implementation to use for resolving data source name Strings in thetargetDataSources
map.void
MapDataSourceLookup.setDataSources
(Map<String, DataSource> dataSources) -
Uses of Nullable in org.springframework.jdbc.object
Modifier and TypeMethodDescriptionSqlQuery.findObject
(int p1) Convenient method to find a single object given a single int parameter.SqlQuery.findObject
(int p1, int p2) Convenient method to find a single object given two int parameters.SqlQuery.findObject
(int p1, int p2, Map<?, ?> context) Convenient method to find a single object given two int parameters and a context.SqlQuery.findObject
(int p1, Map<?, ?> context) Convenient method to find a single object given a single int parameter and a context.SqlQuery.findObject
(long p1) Convenient method to find a single object given a single long parameter.SqlQuery.findObject
(long p1, Map<?, ?> context) Convenient method to find a single object given a single long parameter and a context.SqlQuery.findObject
(Object... params) Convenient method to find a single object without context.SqlQuery.findObject
(Object[] params, Map<?, ?> context) Generic object finder method, used by all otherfindObject
methods.SqlQuery.findObject
(String p1) Convenient method to find a single object given a single String parameter.SqlQuery.findObject
(String p1, Map<?, ?> context) Convenient method to find a single object given a single String parameter and a context.SqlQuery.findObjectByNamedParam
(Map<String, ?> paramMap) Convenient method to execute without context.SqlQuery.findObjectByNamedParam
(Map<String, ?> paramMap, Map<?, ?> context) Generic object finder method for named parameters.SqlCall.getCallString()
Get the call string.String[]
RdbmsOperation.getGeneratedKeysColumnNames()
Return the column names of the auto generated keys.RdbmsOperation.getSql()
Subclasses can override this to supply dynamic SQL if they wish, but SQL is normally set by calling theRdbmsOperation.setSql(java.lang.String)
method or in a subclass constructor.protected abstract T
Subclasses must implement this method to convert each row of the ResultSet into an object of the result type.protected final T
This method is implemented to invoke the simpler mapRow template method, ignoring parameters.protected abstract T
MappingSqlQueryWithParameters.mapRow
(ResultSet rs, int rowNum, Object[] parameters, Map<?, ?> context) Subclasses must implement this method to convert each row of the ResultSet into an object of the result type.protected T
This implementation of this method extracts a single value from the single row returned by the function.SqlFunction.runGeneric()
Convenient method to run the function without arguments, returning the value as an object.SqlFunction.runGeneric
(int parameter) Convenient method to run the function with a single int argument.SqlFunction.runGeneric
(Object[] parameters) Analogous to theSqlQuery.findObject(Object[])
method.Modifier and TypeMethodDescriptionConvenient method to execute with two int parameters and context.Convenient method to execute with a single int parameter and context.Convenient method to execute with a single long parameter and context.Central execution method.Central execution method.Convenient method to execute with a single String parameter and context.SqlQuery.executeByNamedParam
(Map<String, ?> paramMap, Map<?, ?> context) Central execution method.SqlQuery.findObject
(int p1, int p2, Map<?, ?> context) Convenient method to find a single object given two int parameters and a context.SqlQuery.findObject
(int p1, Map<?, ?> context) Convenient method to find a single object given a single int parameter and a context.SqlQuery.findObject
(long p1, Map<?, ?> context) Convenient method to find a single object given a single long parameter and a context.SqlQuery.findObject
(Object[] params, Map<?, ?> context) Generic object finder method, used by all otherfindObject
methods.SqlQuery.findObject
(Object[] params, Map<?, ?> context) Generic object finder method, used by all otherfindObject
methods.SqlQuery.findObject
(String p1, Map<?, ?> context) Convenient method to find a single object given a single String parameter and a context.SqlQuery.findObjectByNamedParam
(Map<String, ?> paramMap, Map<?, ?> context) Generic object finder method for named parameters.protected final T
This method is implemented to invoke the simpler mapRow template method, ignoring parameters.protected final T
This method is implemented to invoke the simpler mapRow template method, ignoring parameters.protected abstract T
MappingSqlQueryWithParameters.mapRow
(ResultSet rs, int rowNum, Object[] parameters, Map<?, ?> context) Subclasses must implement this method to convert each row of the ResultSet into an object of the result type.protected abstract T
MappingSqlQueryWithParameters.mapRow
(ResultSet rs, int rowNum, Object[] parameters, Map<?, ?> context) Subclasses must implement this method to convert each row of the ResultSet into an object of the result type.protected CallableStatementCreator
SqlCall.newCallableStatementCreator
(Map<String, ?> inParams) Return a CallableStatementCreator to perform an operation with these parameters.protected final PreparedStatementCreator
SqlOperation.newPreparedStatementCreator
(Object[] params) Return a PreparedStatementCreator to perform an operation with the given parameters.protected final PreparedStatementCreator
SqlOperation.newPreparedStatementCreator
(String sqlToUse, Object[] params) Return a PreparedStatementCreator to perform an operation with the given parameters.protected final PreparedStatementSetter
SqlOperation.newPreparedStatementSetter
(Object[] params) Return a PreparedStatementSetter to perform an operation with the given parameters.GenericSqlQuery.newRowMapper
(Object[] parameters, Map<?, ?> context) GenericSqlQuery.newRowMapper
(Object[] parameters, Map<?, ?> context) MappingSqlQueryWithParameters.newRowMapper
(Object[] parameters, Map<?, ?> context) Implementation of protected abstract method.MappingSqlQueryWithParameters.newRowMapper
(Object[] parameters, Map<?, ?> context) Implementation of protected abstract method.SqlQuery.newRowMapper
(Object[] parameters, Map<?, ?> context) Subclasses must implement this method to extract an object per row, to be returned by theexecute
method as an aggregatedList
.SqlQuery.newRowMapper
(Object[] parameters, Map<?, ?> context) Subclasses must implement this method to extract an object per row, to be returned by theexecute
method as an aggregatedList
.UpdatableSqlQuery.newRowMapper
(Object[] parameters, Map<?, ?> context) Implementation of the superclass template method.UpdatableSqlQuery.newRowMapper
(Object[] parameters, Map<?, ?> context) Implementation of the superclass template method.void
RdbmsOperation.setGeneratedKeysColumnNames
(String... names) Set the column names of the auto-generated keys.void
Set the SQL executed by this operation.void
RdbmsOperation.setTypes
(int[] types) Add anonymous parameters, specifying only their SQL types as defined in thejava.sql.Types
class.protected abstract T
Subclasses must implement this method to update each row of the ResultSet and optionally create object of the result type.protected void
RdbmsOperation.validateNamedParameters
(Map<String, ?> parameters) Validate the named parameters passed to an execute method based on declared parameters.protected void
RdbmsOperation.validateParameters
(Object[] parameters) Validate the parameters passed to an execute method based on declared parameters.ModifierConstructorDescriptionRowMapperImpl
(Object[] parameters, Map<?, ?> context) Use an array results.RowMapperImpl
(Object[] parameters, Map<?, ?> context) Use an array results.RowMapperImpl
(Map<?, ?> context) -
Uses of Nullable in org.springframework.jdbc.support
Modifier and TypeMethodDescriptionstatic String
JdbcUtils.commonDatabaseName
(String source) Extract a common name for the target database in use even if various drivers/platforms provide varying names at runtime.protected DataAccessException
SQLErrorCodeSQLExceptionTranslator.createCustomException
(String task, String sql, SQLException sqlEx, Class<?> exceptionClass) Create a customDataAccessException
, based on a given exception class from aCustomSQLErrorCodesTranslation
definition.protected DataAccessException
SQLErrorCodeSQLExceptionTranslator.customTranslate
(String task, String sql, SQLException sqlEx) Deprecated.protected abstract DataAccessException
AbstractFallbackSQLExceptionTranslator.doTranslate
(String task, String sql, SQLException ex) Template method for actually translating the given exception.protected DataAccessException
SQLErrorCodeSQLExceptionTranslator.doTranslate
(String task, String sql, SQLException ex) protected DataAccessException
SQLExceptionSubclassTranslator.doTranslate
(String task, String sql, SQLException ex) protected DataAccessException
SQLStateSQLExceptionTranslator.doTranslate
(String task, String sql, SQLException ex) CustomSQLExceptionTranslatorRegistry.findTranslatorForDatabase
(String dbName) Find a custom translator for the specified database.SQLErrorCodes.getCustomSqlExceptionTranslator()
SQLErrorCodes.getCustomTranslations()
AbstractFallbackSQLExceptionTranslator.getCustomTranslator()
Return a custom exception translator, if any.SQLErrorCodes.getDatabaseProductName()
String[]
SQLErrorCodes.getDatabaseProductNames()
JdbcAccessor.getDataSource()
Return the DataSource used by this template.Class<?>
CustomSQLErrorCodesTranslation.getExceptionClass()
Return the exception class for the specified error codes.AbstractFallbackSQLExceptionTranslator.getFallbackTranslator()
Return the fallback exception translator, if any.GeneratedKeyHolder.getKey()
KeyHolder.getKey()
Retrieve the first item from the first map, assuming that there is just one item and just one map, and that the item is a number.<T> T
<T> T
Retrieve the first item from the first map, assuming that there is just one item and just one map, and that the item is an instance of specified type.GeneratedKeyHolder.getKeys()
KeyHolder.getKeys()
Retrieve the first map of keys.static Object
JdbcUtils.getResultSetValue
(ResultSet rs, int index) Retrieve a JDBC column value from a ResultSet, using the most appropriate value type.static Object
JdbcUtils.getResultSetValue
(ResultSet rs, int index, Class<?> requiredType) Retrieve a JDBC column value from a ResultSet, using the specified value type.SQLErrorCodeSQLExceptionTranslator.getSqlErrorCodes()
Return the error codes used by this translator.protected Resource
SQLErrorCodesFactory.loadResource
(String path) Load the given resource from the class path.SQLErrorCodesFactory.resolveErrorCodes
(DataSource dataSource) ReturnSQLErrorCodes
for the givenDataSource
, evaluating "databaseProductName" from theDatabaseMetaData
, ornull
if case of a JDBC meta-data access problem.static String
JdbcUtils.resolveTypeName
(int sqlType) Resolve the standard type name for the given SQL type, if possible.AbstractFallbackSQLExceptionTranslator.translate
(String task, String sql, SQLException ex) Pre-checks the arguments, callsAbstractFallbackSQLExceptionTranslator.doTranslate(java.lang.String, java.lang.String, java.sql.SQLException)
, and invokes thefallback translator
if necessary.SQLExceptionTranslator.translate
(String task, String sql, SQLException ex) Translate the givenSQLException
into a genericDataAccessException
.SQLErrorCodesFactory.unregisterDatabase
(DataSource dataSource) Clear the cache for the specifiedDataSource
, if registered.Modifier and TypeMethodDescriptionprotected String
AbstractFallbackSQLExceptionTranslator.buildMessage
(String task, String sql, SQLException ex) Build a messageString
for the givenSQLException
.static void
JdbcUtils.closeConnection
(Connection con) Close the given JDBC Connection and ignore any thrown exception.static void
JdbcUtils.closeResultSet
(ResultSet rs) Close the given JDBC ResultSet and ignore any thrown exception.static void
JdbcUtils.closeStatement
(Statement stmt) Close the given JDBC Statement and ignore any thrown exception.static String
JdbcUtils.commonDatabaseName
(String source) Extract a common name for the target database in use even if various drivers/platforms provide varying names at runtime.static String
JdbcUtils.convertPropertyNameToUnderscoreName
(String name) Convert a property name using "camelCase" to a corresponding column name with underscores.static String
JdbcUtils.convertUnderscoreNameToPropertyName
(String name) Convert a column name with underscores to the corresponding property name using "camelCase".protected DataAccessException
SQLErrorCodeSQLExceptionTranslator.createCustomException
(String task, String sql, SQLException sqlEx, Class<?> exceptionClass) Create a customDataAccessException
, based on a given exception class from aCustomSQLErrorCodesTranslation
definition.protected DataAccessException
SQLErrorCodeSQLExceptionTranslator.customTranslate
(String task, String sql, SQLException sqlEx) Deprecated.protected abstract DataAccessException
AbstractFallbackSQLExceptionTranslator.doTranslate
(String task, String sql, SQLException ex) Template method for actually translating the given exception.protected DataAccessException
SQLErrorCodeSQLExceptionTranslator.doTranslate
(String task, String sql, SQLException ex) protected DataAccessException
SQLExceptionSubclassTranslator.doTranslate
(String task, String sql, SQLException ex) protected DataAccessException
SQLStateSQLExceptionTranslator.doTranslate
(String task, String sql, SQLException ex) static Object
JdbcUtils.getResultSetValue
(ResultSet rs, int index, Class<?> requiredType) Retrieve a JDBC column value from a ResultSet, using the specified value type.void
SQLErrorCodes.setCustomSqlExceptionTranslator
(SQLExceptionTranslator customSqlExceptionTranslator) void
SQLErrorCodes.setCustomSqlExceptionTranslatorClass
(Class<? extends SQLExceptionTranslator> customTranslatorClass) void
AbstractFallbackSQLExceptionTranslator.setCustomTranslator
(SQLExceptionTranslator customTranslator) Set a custom exception translator to override any match that this translator would find.void
SQLErrorCodes.setDatabaseProductName
(String databaseProductName) Set this property if the database name contains spaces, in which case we can not use the bean name for lookup.void
SQLErrorCodes.setDatabaseProductNames
(String... databaseProductNames) Set this property to specify multiple database names that contains spaces, in which case we can not use bean names for lookup.void
JdbcAccessor.setDataSource
(DataSource dataSource) Set the JDBC DataSource to obtain connections from.void
CustomSQLErrorCodesTranslation.setExceptionClass
(Class<?> exceptionClass) Set the exception class for the specified error codes.void
AbstractFallbackSQLExceptionTranslator.setFallbackTranslator
(SQLExceptionTranslator fallback) Set the fallback translator to use when this translator cannot find a specific match itself.void
SQLErrorCodeSQLExceptionTranslator.setSqlErrorCodes
(SQLErrorCodes sec) Set custom error codes to be used for translation.AbstractFallbackSQLExceptionTranslator.translate
(String task, String sql, SQLException ex) Pre-checks the arguments, callsAbstractFallbackSQLExceptionTranslator.doTranslate(java.lang.String, java.lang.String, java.sql.SQLException)
, and invokes thefallback translator
if necessary.SQLExceptionTranslator.translate
(String task, String sql, SQLException ex) Translate the givenSQLException
into a genericDataAccessException
. -
Uses of Nullable in org.springframework.jdbc.support.lob
Modifier and TypeMethodDescriptionAbstractLobHandler.getBlobAsBinaryStream
(ResultSet rs, String columnName) DefaultLobHandler.getBlobAsBinaryStream
(ResultSet rs, int columnIndex) LobHandler.getBlobAsBinaryStream
(ResultSet rs, int columnIndex) Retrieve the given column as binary stream from the given ResultSet.LobHandler.getBlobAsBinaryStream
(ResultSet rs, String columnName) Retrieve the given column as binary stream from the given ResultSet.byte[]
AbstractLobHandler.getBlobAsBytes
(ResultSet rs, String columnName) byte[]
DefaultLobHandler.getBlobAsBytes
(ResultSet rs, int columnIndex) byte[]
LobHandler.getBlobAsBytes
(ResultSet rs, int columnIndex) Retrieve the given column as bytes from the given ResultSet.byte[]
LobHandler.getBlobAsBytes
(ResultSet rs, String columnName) Retrieve the given column as bytes from the given ResultSet.AbstractLobHandler.getClobAsAsciiStream
(ResultSet rs, String columnName) LobHandler.getClobAsAsciiStream
(ResultSet rs, int columnIndex) Retrieve the given column as ASCII stream from the given ResultSet.LobHandler.getClobAsAsciiStream
(ResultSet rs, String columnName) Retrieve the given column as ASCII stream from the given ResultSet.AbstractLobHandler.getClobAsString
(ResultSet rs, String columnName) DefaultLobHandler.getClobAsString
(ResultSet rs, int columnIndex) LobHandler.getClobAsString
(ResultSet rs, int columnIndex) Retrieve the given column as String from the given ResultSet.LobHandler.getClobAsString
(ResultSet rs, String columnName) Retrieve the given column as String from the given ResultSet.Modifier and TypeMethodDescriptionvoid
DefaultLobHandler.DefaultLobCreator.setBlobAsBinaryStream
(PreparedStatement ps, int paramIndex, InputStream binaryStream, int contentLength) void
LobCreator.setBlobAsBinaryStream
(PreparedStatement ps, int paramIndex, InputStream contentStream, int contentLength) Set the given content as binary stream on the given statement, using the given parameter index.void
TemporaryLobCreator.setBlobAsBinaryStream
(PreparedStatement ps, int paramIndex, InputStream binaryStream, int contentLength) void
DefaultLobHandler.DefaultLobCreator.setBlobAsBytes
(PreparedStatement ps, int paramIndex, byte[] content) void
LobCreator.setBlobAsBytes
(PreparedStatement ps, int paramIndex, byte[] content) Set the given content as bytes on the given statement, using the given parameter index.void
TemporaryLobCreator.setBlobAsBytes
(PreparedStatement ps, int paramIndex, byte[] content) void
DefaultLobHandler.DefaultLobCreator.setClobAsAsciiStream
(PreparedStatement ps, int paramIndex, InputStream asciiStream, int contentLength) void
LobCreator.setClobAsAsciiStream
(PreparedStatement ps, int paramIndex, InputStream asciiStream, int contentLength) Set the given content as ASCII stream on the given statement, using the given parameter index.void
TemporaryLobCreator.setClobAsAsciiStream
(PreparedStatement ps, int paramIndex, InputStream asciiStream, int contentLength) void
DefaultLobHandler.DefaultLobCreator.setClobAsCharacterStream
(PreparedStatement ps, int paramIndex, Reader characterStream, int contentLength) void
LobCreator.setClobAsCharacterStream
(PreparedStatement ps, int paramIndex, Reader characterStream, int contentLength) Set the given content as character stream on the given statement, using the given parameter index.void
TemporaryLobCreator.setClobAsCharacterStream
(PreparedStatement ps, int paramIndex, Reader characterStream, int contentLength) void
DefaultLobHandler.DefaultLobCreator.setClobAsString
(PreparedStatement ps, int paramIndex, String content) void
LobCreator.setClobAsString
(PreparedStatement ps, int paramIndex, String content) Set the given content as String on the given statement, using the given parameter index.void
TemporaryLobCreator.setClobAsString
(PreparedStatement ps, int paramIndex, String content) -
Uses of Nullable in org.springframework.jdbc.support.rowset
Modifier and TypeMethodDescriptionResultSetWrappingSqlRowSet.getBigDecimal
(int columnIndex) ResultSetWrappingSqlRowSet.getBigDecimal
(String columnLabel) SqlRowSet.getBigDecimal
(int columnIndex) Retrieve the value of the indicated column in the current row as a BigDecimal object.SqlRowSet.getBigDecimal
(String columnLabel) Retrieve the value of the indicated column in the current row as a BigDecimal object.ResultSetWrappingSqlRowSet.getDate
(int columnIndex) SqlRowSet.getDate
(int columnIndex) Retrieve the value of the indicated column in the current row as a Date object.Retrieve the value of the indicated column in the current row as a Date object.Retrieve the value of the indicated column in the current row as a Date object.Retrieve the value of the indicated column in the current row as a Date object.ResultSetWrappingSqlRowSet.getNString
(int columnIndex) ResultSetWrappingSqlRowSet.getNString
(String columnLabel) SqlRowSet.getNString
(int columnIndex) Retrieve the value of the indicated column in the current row as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns).SqlRowSet.getNString
(String columnLabel) Retrieve the value of the indicated column in the current row as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns).ResultSetWrappingSqlRowSet.getObject
(int columnIndex) <T> T
<T> T
SqlRowSet.getObject
(int columnIndex) Retrieve the value of the indicated column in the current row as an Object.<T> T
Retrieve the value of the indicated column in the current row as an Object.Retrieve the value of the indicated column in the current row as an Object.Retrieve the value of the indicated column in the current row as an Object.<T> T
Retrieve the value of the indicated column in the current row as an Object.Retrieve the value of the indicated column in the current row as an Object.ResultSetWrappingSqlRowSet.getString
(int columnIndex) SqlRowSet.getString
(int columnIndex) Retrieve the value of the indicated column in the current row as a String.Retrieve the value of the indicated column in the current row as a String.ResultSetWrappingSqlRowSet.getTime
(int columnIndex) SqlRowSet.getTime
(int columnIndex) Retrieve the value of the indicated column in the current row as a Time object.Retrieve the value of the indicated column in the current row as a Time object.Retrieve the value of the indicated column in the current row as a Time object.Retrieve the value of the indicated column in the current row as a Time object.ResultSetWrappingSqlRowSet.getTimestamp
(int columnIndex) ResultSetWrappingSqlRowSet.getTimestamp
(int columnIndex, Calendar cal) ResultSetWrappingSqlRowSet.getTimestamp
(String columnLabel) ResultSetWrappingSqlRowSet.getTimestamp
(String columnLabel, Calendar cal) SqlRowSet.getTimestamp
(int columnIndex) Retrieve the value of the indicated column in the current row as a Timestamp object.SqlRowSet.getTimestamp
(int columnIndex, Calendar cal) Retrieve the value of the indicated column in the current row as a Timestamp object.SqlRowSet.getTimestamp
(String columnLabel) Retrieve the value of the indicated column in the current row as a Timestamp object.SqlRowSet.getTimestamp
(String columnLabel, Calendar cal) Retrieve the value of the indicated column in the current row as a Timestamp object. -
Uses of Nullable in org.springframework.jdbc.support.xml
Modifier and TypeMethodDescriptionJdbc4SqlXmlHandler.getXmlAsBinaryStream
(ResultSet rs, int columnIndex) Jdbc4SqlXmlHandler.getXmlAsBinaryStream
(ResultSet rs, String columnName) SqlXmlHandler.getXmlAsBinaryStream
(ResultSet rs, int columnIndex) Retrieve the given column as binary stream from the given ResultSet.SqlXmlHandler.getXmlAsBinaryStream
(ResultSet rs, String columnName) Retrieve the given column as binary stream from the given ResultSet.Jdbc4SqlXmlHandler.getXmlAsCharacterStream
(ResultSet rs, int columnIndex) Jdbc4SqlXmlHandler.getXmlAsCharacterStream
(ResultSet rs, String columnName) SqlXmlHandler.getXmlAsCharacterStream
(ResultSet rs, int columnIndex) Retrieve the given column as character stream from the given ResultSet.SqlXmlHandler.getXmlAsCharacterStream
(ResultSet rs, String columnName) Retrieve the given column as character stream from the given ResultSet.Jdbc4SqlXmlHandler.getXmlAsSource
(ResultSet rs, int columnIndex, Class<? extends Source> sourceClass) Jdbc4SqlXmlHandler.getXmlAsSource
(ResultSet rs, String columnName, Class<? extends Source> sourceClass) SqlXmlHandler.getXmlAsSource
(ResultSet rs, int columnIndex, Class<? extends Source> sourceClass) Retrieve the given column as Source implemented using the specified source class from the given ResultSet.SqlXmlHandler.getXmlAsSource
(ResultSet rs, String columnName, Class<? extends Source> sourceClass) Retrieve the given column as Source implemented using the specified source class from the given ResultSet.Jdbc4SqlXmlHandler.getXmlAsString
(ResultSet rs, int columnIndex) Jdbc4SqlXmlHandler.getXmlAsString
(ResultSet rs, String columnName) SqlXmlHandler.getXmlAsString
(ResultSet rs, int columnIndex) Retrieve the given column as String from the given ResultSet.SqlXmlHandler.getXmlAsString
(ResultSet rs, String columnName) Retrieve the given column as String from the given ResultSet.Modifier and TypeMethodDescriptionJdbc4SqlXmlHandler.getXmlAsSource
(ResultSet rs, int columnIndex, Class<? extends Source> sourceClass) Jdbc4SqlXmlHandler.getXmlAsSource
(ResultSet rs, String columnName, Class<? extends Source> sourceClass) SqlXmlHandler.getXmlAsSource
(ResultSet rs, int columnIndex, Class<? extends Source> sourceClass) Retrieve the given column as Source implemented using the specified source class from the given ResultSet.SqlXmlHandler.getXmlAsSource
(ResultSet rs, String columnName, Class<? extends Source> sourceClass) Retrieve the given column as Source implemented using the specified source class from the given ResultSet. -
Uses of Nullable in org.springframework.jms
Modifier and TypeMethodDescriptionJmsException.getErrorCode()
Convenience method to get the vendor specific error code if the root cause was an instance of JMSException.JmsException.getMessage()
Return the detail message, including the message from the linked exception if there is one.ModifierConstructorDescriptionJmsException
(String msg, Throwable cause) Constructor that takes a message and a root cause.JmsException
(Throwable cause) Constructor that takes a plain root cause, intended for subclasses mirroring correspondingjakarta.jms
exceptions. -
Uses of Nullable in org.springframework.jms.config
Modifier and TypeMethodDescriptionMethodJmsListenerEndpoint.getBean()
AbstractJmsListenerEndpoint.getConcurrency()
Return the concurrency for the listener, if any.protected String
MethodJmsListenerEndpoint.getDefaultResponseDestination()
Return the default response destination, if any.AbstractJmsListenerEndpoint.getDestination()
Return the name of the destination for this endpoint.JmsListenerEndpointRegistrar.getEndpointRegistry()
Return theJmsListenerEndpointRegistry
instance for this registrar, may benull
.JmsListenerEndpointRegistry.getListenerContainer
(String id) Return theMessageListenerContainer
with the specified id ornull
if no such container exists.JmsListenerEndpointRegistrar.getMessageHandlerMethodFactory()
Return the customMessageHandlerMethodFactory
to use, if any.SimpleJmsListenerEndpoint.getMessageListener()
Return theMessageListener
to invoke when a message matching the endpoint is received.MethodJmsListenerEndpoint.getMethod()
MethodJmsListenerEndpoint.getMostSpecificMethod()
AbstractJmsListenerEndpoint.getSelector()
Return the JMS message selector expression, if any.AbstractJmsListenerEndpoint.getSubscription()
Return the name for the durable subscription, if any.Modifier and TypeMethodDescriptionvoid
JmsListenerEndpointRegistrar.registerEndpoint
(JmsListenerEndpoint endpoint, JmsListenerContainerFactory<?> factory) Register a newJmsListenerEndpoint
alongside theJmsListenerContainerFactory
to use to create the underlying container.void
DefaultJmsListenerContainerFactory.setBackOff
(BackOff backOff) void
Set the actual bean instance to invoke this endpoint method on.void
MethodJmsListenerEndpoint.setBeanFactory
(BeanFactory beanFactory) Set theBeanFactory
to use to resolve expressions (may benull
).void
DefaultJmsListenerContainerFactory.setCacheLevel
(Integer cacheLevel) void
DefaultJmsListenerContainerFactory.setCacheLevelName
(String cacheLevelName) void
AbstractJmsListenerEndpoint.setConcurrency
(String concurrency) Set a concurrency for the listener, if any.void
DefaultJmsListenerContainerFactory.setConcurrency
(String concurrency) void
AbstractJmsListenerEndpoint.setDestination
(String destination) Set the name of the destination for this endpoint.void
MethodJmsListenerEndpoint.setEmbeddedValueResolver
(StringValueResolver embeddedValueResolver) Set a value resolver for embedded placeholders and expressions.void
JmsListenerEndpointRegistrar.setEndpointRegistry
(JmsListenerEndpointRegistry endpointRegistry) Set theJmsListenerEndpointRegistry
instance to use.void
DefaultJmsListenerContainerFactory.setMaxMessagesPerTask
(Integer maxMessagesPerTask) void
JmsListenerEndpointRegistrar.setMessageHandlerMethodFactory
(MessageHandlerMethodFactory messageHandlerMethodFactory) Set theMessageHandlerMethodFactory
to use to configure the message listener responsible to serve an endpoint detected by this processor.void
SimpleJmsListenerEndpoint.setMessageListener
(MessageListener messageListener) Set theMessageListener
to invoke when a message matching the endpoint is received.void
Set the method to invoke for processing a message managed by this endpoint.void
MethodJmsListenerEndpoint.setMostSpecificMethod
(Method mostSpecificMethod) Set the most specific method known for this endpoint's declaration.void
DefaultJmsListenerContainerFactory.setReceiveTimeout
(Long receiveTimeout) void
DefaultJmsListenerContainerFactory.setRecoveryInterval
(Long recoveryInterval) void
AbstractJmsListenerEndpoint.setSelector
(String selector) Set the JMS message selector expression.void
AbstractJmsListenerEndpoint.setSubscription
(String subscription) Set the name for the durable subscription.void
DefaultJmsListenerContainerFactory.setTaskExecutor
(Executor taskExecutor) void
DefaultJmsListenerContainerFactory.setTransactionManager
(PlatformTransactionManager transactionManager) -
Uses of Nullable in org.springframework.jms.connection
Modifier and TypeMethodDescriptionstatic Session
ConnectionFactoryUtils.doGetTransactionalSession
(ConnectionFactory connectionFactory, ConnectionFactoryUtils.ResourceFactory resourceFactory) Obtain a JMS Session that is synchronized with the current transaction, if any.static Session
ConnectionFactoryUtils.doGetTransactionalSession
(ConnectionFactory connectionFactory, ConnectionFactoryUtils.ResourceFactory resourceFactory, boolean startConnection) Obtain a JMS Session that is synchronized with the current transaction, if any.protected String
SingleConnectionFactory.getClientId()
Return a JMS client ID for the single Connection created and exposed by this ConnectionFactory, if any.ConnectionFactoryUtils.ResourceFactory.getConnection
(JmsResourceHolder holder) Fetch an appropriate Connection from the given JmsResourceHolder.JmsResourceHolder.getConnection()
Return this resource holder's default Connection, ornull
if none.<C extends Connection>
CJmsResourceHolder.getConnection
(Class<C> connectionType) Return this resource holder's Connection of the given type, ornull
if none.JmsTransactionManager.getConnectionFactory()
Return the JMS ConnectionFactory that this instance should manage transactions for.protected ExceptionListener
SingleConnectionFactory.getExceptionListener()
Return the JMS ExceptionListener implementation that should be registered with the single Connection created by this factory, if any.ConnectionFactoryUtils.ResourceFactory.getSession
(JmsResourceHolder holder) Fetch an appropriate Session from the given JmsResourceHolder.JmsResourceHolder.getSession()
Return this resource holder's default Session, ornull
if none.<S extends Session>
SJmsResourceHolder.getSession
(Class<S> sessionType) Return this resource holder's Session of the given type, ornull
if none.<S extends Session>
SJmsResourceHolder.getSession
(Class<S> sessionType, Connection connection) Return this resource holder's Session of the given type for the given connection, ornull
if none.protected Session
SingleConnectionFactory.getSession
(Connection con, Integer mode) Template method for obtaining a (potentially cached) Session.DelegatingConnectionFactory.getTargetConnectionFactory()
Return the target ConnectionFactory that this ConnectionFactory delegates to.SingleConnectionFactory.getTargetConnectionFactory()
Return the target ConnectionFactory which will be used to lazily create a single Connection, if any.static QueueSession
ConnectionFactoryUtils.getTransactionalQueueSession
(QueueConnectionFactory cf, QueueConnection existingCon, boolean synchedLocalTransactionAllowed) Obtain a JMS QueueSession that is synchronized with the current transaction, if any.static Session
ConnectionFactoryUtils.getTransactionalSession
(ConnectionFactory cf, Connection existingCon, boolean synchedLocalTransactionAllowed) Obtain a JMS Session that is synchronized with the current transaction, if any.static TopicSession
ConnectionFactoryUtils.getTransactionalTopicSession
(TopicConnectionFactory cf, TopicConnection existingCon, boolean synchedLocalTransactionAllowed) Obtain a JMS TopicSession that is synchronized with the current transaction, if any.Modifier and TypeMethodDescriptionfinal void
JmsResourceHolder.addSession
(Session session, Connection connection) Add the given Session to this resource holder, registered for a specific Connection.protected Connection
UserCredentialsConnectionFactoryAdapter.doCreateConnection
(String username, String password) This implementation delegates to thecreateConnection(username, password)
method of the target ConnectionFactory, passing in the specified user credentials.protected Connection
UserCredentialsConnectionFactoryAdapter.doCreateConnection
(String username, String password) This implementation delegates to thecreateConnection(username, password)
method of the target ConnectionFactory, passing in the specified user credentials.protected QueueConnection
UserCredentialsConnectionFactoryAdapter.doCreateQueueConnection
(String username, String password) This implementation delegates to thecreateQueueConnection(username, password)
method of the target QueueConnectionFactory, passing in the specified user credentials.protected QueueConnection
UserCredentialsConnectionFactoryAdapter.doCreateQueueConnection
(String username, String password) This implementation delegates to thecreateQueueConnection(username, password)
method of the target QueueConnectionFactory, passing in the specified user credentials.protected TopicConnection
UserCredentialsConnectionFactoryAdapter.doCreateTopicConnection
(String username, String password) This implementation delegates to thecreateTopicConnection(username, password)
method of the target TopicConnectionFactory, passing in the specified user credentials.protected TopicConnection
UserCredentialsConnectionFactoryAdapter.doCreateTopicConnection
(String username, String password) This implementation delegates to thecreateTopicConnection(username, password)
method of the target TopicConnectionFactory, passing in the specified user credentials.protected void
<S extends Session>
SJmsResourceHolder.getSession
(Class<S> sessionType, Connection connection) Return this resource holder's Session of the given type for the given connection, ornull
if none.static QueueSession
ConnectionFactoryUtils.getTransactionalQueueSession
(QueueConnectionFactory cf, QueueConnection existingCon, boolean synchedLocalTransactionAllowed) Obtain a JMS QueueSession that is synchronized with the current transaction, if any.static Session
ConnectionFactoryUtils.getTransactionalSession
(ConnectionFactory cf, Connection existingCon, boolean synchedLocalTransactionAllowed) Obtain a JMS Session that is synchronized with the current transaction, if any.static TopicSession
ConnectionFactoryUtils.getTransactionalTopicSession
(TopicConnectionFactory cf, TopicConnection existingCon, boolean synchedLocalTransactionAllowed) Obtain a JMS TopicSession that is synchronized with the current transaction, if any.static boolean
ConnectionFactoryUtils.isSessionTransactional
(Session session, ConnectionFactory cf) Determine whether the given JMS Session is transactional, that is, bound to the current thread by Spring's transaction facilities.static boolean
ConnectionFactoryUtils.isSessionTransactional
(Session session, ConnectionFactory cf) Determine whether the given JMS Session is transactional, that is, bound to the current thread by Spring's transaction facilities.static void
ConnectionFactoryUtils.releaseConnection
(Connection con, ConnectionFactory cf, boolean started) Release the given Connection, stopping it (if necessary) and eventually closing it.static void
ConnectionFactoryUtils.releaseConnection
(Connection con, ConnectionFactory cf, boolean started) Release the given Connection, stopping it (if necessary) and eventually closing it.void
SingleConnectionFactory.setClientId
(String clientId) Specify a JMS client ID for the single Connection created and exposed by this ConnectionFactory.void
JmsTransactionManager.setConnectionFactory
(ConnectionFactory cf) Set the JMS ConnectionFactory that this instance should manage transactions for.void
SingleConnectionFactory.setExceptionListener
(ExceptionListener exceptionListener) Specify an JMS ExceptionListener implementation that should be registered with the single Connection created by this factory.void
DelegatingConnectionFactory.setTargetConnectionFactory
(ConnectionFactory targetConnectionFactory) Set the target ConnectionFactory that this ConnectionFactory should delegate to.void
SingleConnectionFactory.setTargetConnectionFactory
(ConnectionFactory targetConnectionFactory) Set the target ConnectionFactory which will be used to lazily create a single Connection.ModifierConstructorDescriptionJmsResourceHolder
(ConnectionFactory connectionFactory) Create a new JmsResourceHolder that is open for resources to be added.JmsResourceHolder
(ConnectionFactory connectionFactory, Connection connection, Session session) Create a new JmsResourceHolder for the given JMS resources. -
Uses of Nullable in org.springframework.jms.core
Modifier and TypeMethodDescription<T> T
JmsOperations.browse
(Queue queue, BrowserCallback<T> action) Browse messages in a JMS queue.<T> T
JmsOperations.browse
(String queueName, BrowserCallback<T> action) Browse messages in a JMS queue.<T> T
JmsOperations.browse
(BrowserCallback<T> action) Browse messages in the default JMS queue.<T> T
JmsTemplate.browse
(Queue queue, BrowserCallback<T> action) <T> T
JmsTemplate.browse
(String queueName, BrowserCallback<T> action) <T> T
JmsTemplate.browse
(BrowserCallback<T> action) <T> T
JmsOperations.browseSelected
(Queue queue, String messageSelector, BrowserCallback<T> action) Browse selected messages in a JMS queue.<T> T
JmsOperations.browseSelected
(String queueName, String messageSelector, BrowserCallback<T> action) Browse selected messages in a JMS queue.<T> T
JmsOperations.browseSelected
(String messageSelector, BrowserCallback<T> action) Browse selected messages in a JMS queue.<T> T
JmsTemplate.browseSelected
(Queue queue, String messageSelector, BrowserCallback<T> action) <T> T
JmsTemplate.browseSelected
(String queueName, String messageSelector, BrowserCallback<T> action) <T> T
JmsTemplate.browseSelected
(String messageSelector, BrowserCallback<T> action) protected Message<?>
JmsMessagingTemplate.convertJmsMessage
(Message message) <T> T
JmsMessageOperations.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass) Convert the given request Object to serialized form, possibly using aMessageConverter
, send it as aMessage
to the given destination, receive the reply and convert its body of the specified target class.<T> T
JmsMessageOperations.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Convert the given request Object to serialized form, possibly using aMessageConverter
, apply the given post processor and send the resultingMessage
to the given destination, receive the reply and convert its body of the given target class.<T> T
JmsMessageOperations.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass) Convert the given request Object to serialized form, possibly using aMessageConverter
, send it as aMessage
with the given headers, to the specified destination, receive the reply and convert its body of the specified target class.<T> T
JmsMessageOperations.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Convert the given request Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post processor and send the resultingMessage
to the specified destination, receive the reply and convert its body of the given target class.<T> T
JmsMessagingTemplate.convertSendAndReceive
(Object request, Class<T> targetClass) <T> T
JmsMessagingTemplate.convertSendAndReceive
(Object request, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
JmsMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass) <T> T
JmsMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass, MessagePostProcessor requestPostProcessor) <T> T
JmsMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass) <T> T
JmsMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor postProcessor) protected Object
JmsTemplate.doConvertFromMessage
(Message message) Extract the content from the given JMS message.BrowserCallback.doInJms
(Session session, QueueBrowser browser) Perform operations on the givenSession
andQueueBrowser
.ProducerCallback.doInJms
(Session session, MessageProducer producer) Perform operations on the givenSession
andMessageProducer
.Execute any number of operations against the supplied JMSSession
, possibly returning a result.protected Message<?>
JmsMessagingTemplate.doReceive
(Destination destination) protected Message<?>
protected Message
JmsTemplate.doReceive
(Session session, Destination destination, String messageSelector) Receive a JMS message.protected Message
JmsTemplate.doReceive
(Session session, MessageConsumer consumer) Actually receive a JMS message.protected Message<?>
JmsMessagingTemplate.doSendAndReceive
(Destination destination, Message<?> requestMessage) protected Message<?>
JmsMessagingTemplate.doSendAndReceive
(String destinationName, Message<?> requestMessage) protected Message
JmsTemplate.doSendAndReceive
(Session session, Destination destination, MessageCreator messageCreator) Send a request message to the givenDestination
and block until a reply has been received on a temporary queue created on-the-fly.<T> T
JmsOperations.execute
(Destination destination, ProducerCallback<T> action) Send messages to a JMS destination.<T> T
JmsOperations.execute
(String destinationName, ProducerCallback<T> action) Send messages to a JMS destination.<T> T
JmsOperations.execute
(ProducerCallback<T> action) Send messages to the default JMS destination (or one specified for each send operation).<T> T
JmsOperations.execute
(SessionCallback<T> action) Execute the action specified by the given action object within a JMS Session.<T> T
JmsTemplate.execute
(Destination destination, ProducerCallback<T> action) <T> T
JmsTemplate.execute
(String destinationName, ProducerCallback<T> action) <T> T
JmsTemplate.execute
(ProducerCallback<T> action) <T> T
JmsTemplate.execute
(SessionCallback<T> action) <T> T
JmsTemplate.execute
(SessionCallback<T> action, boolean startConnection) Execute the action specified by the given action object within a JMS Session.protected Connection
JmsTemplate.getConnection
(JmsResourceHolder holder) Fetch an appropriate Connection from the given JmsResourceHolder.JmsMessagingTemplate.getConnectionFactory()
Return the ConnectionFactory that the underlyingJmsTemplate
uses.JmsTemplate.getDefaultDestination()
Return the destination to be used on send/receive operations that do not have a destination parameter.JmsMessagingTemplate.getDefaultDestinationName()
Return the configured default destination name.JmsTemplate.getDefaultDestinationName()
Return the destination name to be used on send/receive operations that do not have a destination parameter.JmsMessagingTemplate.getJmsTemplate()
Return the configuredJmsTemplate
.JmsTemplate.getMessageConverter()
Return the message converter for this template.protected Session
JmsTemplate.getSession
(JmsResourceHolder holder) Fetch an appropriate Session from the given JmsResourceHolder.Message<?>
Receive a message from the given destination.Message<?>
JmsMessagingTemplate.receive()
Message<?>
JmsOperations.receive()
Receive a message synchronously from the default destination, but only wait up to a specified time for delivery.JmsOperations.receive
(Destination destination) Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.JmsTemplate.receive()
JmsTemplate.receive
(Destination destination) <T> T
JmsMessageOperations.receiveAndConvert
(String destinationName, Class<T> targetClass) Receive a message from the given destination and convert its payload to the specified target class.<T> T
JmsMessagingTemplate.receiveAndConvert
(Class<T> targetClass) <T> T
JmsMessagingTemplate.receiveAndConvert
(String destinationName, Class<T> targetClass) JmsOperations.receiveAndConvert()
Receive a message synchronously from the default destination, but only wait up to a specified time for delivery.JmsOperations.receiveAndConvert
(Destination destination) Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.JmsOperations.receiveAndConvert
(String destinationName) Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.JmsTemplate.receiveAndConvert()
JmsTemplate.receiveAndConvert
(Destination destination) JmsTemplate.receiveAndConvert
(String destinationName) JmsOperations.receiveSelected
(Destination destination, String messageSelector) Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.JmsOperations.receiveSelected
(String messageSelector) Receive a message synchronously from the default destination, but only wait up to a specified time for delivery.JmsOperations.receiveSelected
(String destinationName, String messageSelector) Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.JmsTemplate.receiveSelected
(Destination destination, String messageSelector) JmsTemplate.receiveSelected
(String messageSelector) JmsTemplate.receiveSelected
(String destinationName, String messageSelector) JmsOperations.receiveSelectedAndConvert
(Destination destination, String messageSelector) Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.JmsOperations.receiveSelectedAndConvert
(String messageSelector) Receive a message synchronously from the default destination, but only wait up to a specified time for delivery.JmsOperations.receiveSelectedAndConvert
(String destinationName, String messageSelector) Receive a message synchronously from the specified destination, but only wait up to a specified time for delivery.JmsTemplate.receiveSelectedAndConvert
(Destination destination, String messageSelector) JmsTemplate.receiveSelectedAndConvert
(String messageSelector) JmsTemplate.receiveSelectedAndConvert
(String destinationName, String messageSelector) Message<?>
JmsMessageOperations.sendAndReceive
(String destinationName, Message<?> requestMessage) Send a request message and receive the reply from the given destination.Message<?>
JmsMessagingTemplate.sendAndReceive
(String destinationName, Message<?> requestMessage) Message<?>
JmsMessagingTemplate.sendAndReceive
(Message<?> requestMessage) JmsOperations.sendAndReceive
(Destination destination, MessageCreator messageCreator) Send a message and receive the reply from the specified destination.JmsOperations.sendAndReceive
(String destinationName, MessageCreator messageCreator) Send a message and receive the reply from the specified destination.JmsOperations.sendAndReceive
(MessageCreator messageCreator) Send a request message and receive the reply from a default destination.JmsTemplate.sendAndReceive
(Destination destination, MessageCreator messageCreator) JmsTemplate.sendAndReceive
(String destinationName, MessageCreator messageCreator) JmsTemplate.sendAndReceive
(MessageCreator messageCreator) Modifier and TypeMethodDescription<T> T
JmsTemplate.browseSelected
(Queue queue, String messageSelector, BrowserCallback<T> action) <T> T
JmsTemplate.browseSelected
(String queueName, String messageSelector, BrowserCallback<T> action) void
JmsMessageOperations.convertAndSend
(String destinationName, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) Convert the given Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to the given destination.void
JmsMessageOperations.convertAndSend
(String destinationName, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) Convert the given Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to the given destination.void
JmsMessagingTemplate.convertAndSend
(Object payload, MessagePostProcessor postProcessor) void
JmsMessagingTemplate.convertAndSend
(String destinationName, Object payload, Map<String, Object> headers) void
JmsMessagingTemplate.convertAndSend
(String destinationName, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) void
JmsMessagingTemplate.convertAndSend
(String destinationName, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) void
JmsMessagingTemplate.convertAndSend
(String destinationName, Object payload, MessagePostProcessor postProcessor) protected Message<?>
JmsMessagingTemplate.convertJmsMessage
(Message message) <T> T
JmsMessageOperations.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass) Convert the given request Object to serialized form, possibly using aMessageConverter
, send it as aMessage
with the given headers, to the specified destination, receive the reply and convert its body of the specified target class.<T> T
JmsMessagingTemplate.convertSendAndReceive
(Object request, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
JmsMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass, MessagePostProcessor requestPostProcessor) <T> T
JmsMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass) <T> T
JmsMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
JmsMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor postProcessor) protected QueueBrowser
JmsTemplate.createBrowser
(Session session, Queue queue, String messageSelector) Create a JMS MessageProducer for the given Session and Destination, configuring it to disable message ids and/or timestamps (if necessary).protected MessageConsumer
JmsTemplate.createConsumer
(Session session, Destination destination, String messageSelector) Create a JMS MessageConsumer for the given Session and Destination.protected MessageProducer
JmsTemplate.createProducer
(Session session, Destination destination) Create a JMS MessageProducer for the given Session and Destination, configuring it to disable message ids and/or timestamps (if necessary).protected Object
JmsTemplate.doConvertFromMessage
(Message message) Extract the content from the given JMS message.protected MessageProducer
JmsTemplate.doCreateProducer
(Session session, Destination destination) Create a raw JMS MessageProducer for the given Session and Destination.protected Message
JmsTemplate.doReceive
(Session session, Destination destination, String messageSelector) Receive a JMS message.<T> T
JmsTemplate.execute
(Destination destination, ProducerCallback<T> action) JmsTemplate.receiveSelected
(Destination destination, String messageSelector) JmsTemplate.receiveSelected
(String destinationName, String messageSelector) void
JmsTemplate.setDefaultDestination
(Destination destination) Set the destination to be used on send/receive operations that do not have a destination parameter.void
JmsMessagingTemplate.setDefaultDestinationName
(String defaultDestinationName) Configure the default destination name to use in send methods that don't have a destination argument.void
JmsTemplate.setDefaultDestinationName
(String destinationName) Set the destination name to be used on send/receive operations that do not have a destination parameter.void
JmsMessagingTemplate.setJmsTemplate
(JmsTemplate jmsTemplate) Set theJmsTemplate
to use.void
JmsTemplate.setMessageConverter
(MessageConverter messageConverter) Set the message converter for this template. -
Uses of Nullable in org.springframework.jms.core.support
Modifier and TypeMethodDescriptionfinal ConnectionFactory
JmsGatewaySupport.getConnectionFactory()
Return the JMS ConnectionFactory used by the gateway.final JmsTemplate
JmsGatewaySupport.getJmsTemplate()
Return the JmsTemplate for the gateway.Modifier and TypeMethodDescriptionfinal void
JmsGatewaySupport.setJmsTemplate
(JmsTemplate jmsTemplate) Set the JmsTemplate for the gateway. -
Uses of Nullable in org.springframework.jms.listener
Modifier and TypeMethodDescriptionprotected final String
AbstractJmsListeningContainer.getBeanName()
Return the bean name that this listener container has been assigned in its containing bean factory, if any.AbstractJmsListeningContainer.getClientId()
Return the JMS client ID for the shared Connection created and used by this container, if any.protected Connection
AbstractPollingMessageListenerContainer.getConnection
(JmsResourceHolder holder) Fetch an appropriate Connection from the given JmsResourceHolder.AbstractMessageListenerContainer.getDestination()
Return the destination to receive messages from.AbstractMessageListenerContainer.getDestinationName()
Return the name of the destination to receive messages from.MessageListenerContainer.getDestinationResolver()
Return theDestinationResolver
to use to resolve destinations by names.AbstractMessageListenerContainer.getDurableSubscriptionName()
Return the name of a durable subscription to create, if any.AbstractMessageListenerContainer.getErrorHandler()
Return theErrorHandler
to be invoked in case of any uncaught exceptions thrown while processing aMessage
.AbstractMessageListenerContainer.getExceptionListener()
Return the JMS ExceptionListener to notify in case of a JMSException thrown by the registered message listener or the invocation infrastructure, if any.AbstractMessageListenerContainer.getMessageConverter()
MessageListenerContainer.getMessageConverter()
Return theMessageConverter
that can be used to convertMessage
, if any.AbstractMessageListenerContainer.getMessageListener()
Return the message listener object to register.AbstractMessageListenerContainer.getMessageSelector()
Return the JMS message selector expression (ornull
if none).io.micrometer.observation.ObservationRegistry
AbstractMessageListenerContainer.getObservationRegistry()
Return theObservationRegistry
used for recordingJMS message processing observations
.AbstractMessageListenerContainer.getReplyQosSettings()
MessageListenerContainer.getReplyQosSettings()
Return theQosSettings
to use when sending a reply, ornull
if the broker's defaults should be used.protected Session
AbstractPollingMessageListenerContainer.getSession
(JmsResourceHolder holder) Fetch an appropriate Session from the given JmsResourceHolder.AbstractMessageListenerContainer.getSubscriptionName()
Return the name of a subscription to create, if any.protected final PlatformTransactionManager
AbstractPollingMessageListenerContainer.getTransactionManager()
Return the Spring PlatformTransactionManager to use for transactional wrapping of message reception plus listener execution.protected Message
AbstractPollingMessageListenerContainer.receiveMessage
(MessageConsumer consumer) Receive a message from the given consumer.Modifier and TypeMethodDescriptionprotected void
AbstractMessageListenerContainer.checkMessageListener
(Object messageListener) Check the given message listener, throwing an exception if it does not correspond to a supported listener type.protected void
AbstractMessageListenerContainer.commitIfNecessary
(Session session, Message message) Perform a commit or message acknowledgement, as appropriate.protected boolean
AbstractPollingMessageListenerContainer.doReceiveAndExecute
(Object invoker, Session session, MessageConsumer consumer, TransactionStatus status) Actually execute the listener for a message received from the given consumer, fetching all requires resources and invoking the listener.protected boolean
AbstractPollingMessageListenerContainer.doReceiveAndExecute
(Object invoker, Session session, MessageConsumer consumer, TransactionStatus status) Actually execute the listener for a message received from the given consumer, fetching all requires resources and invoking the listener.protected boolean
AbstractPollingMessageListenerContainer.doReceiveAndExecute
(Object invoker, Session session, MessageConsumer consumer, TransactionStatus status) Actually execute the listener for a message received from the given consumer, fetching all requires resources and invoking the listener.protected boolean
AbstractPollingMessageListenerContainer.receiveAndExecute
(Object invoker, Session session, MessageConsumer consumer) Execute the listener for a message received from the given consumer, wrapping the entire operation in an external transaction if demanded.protected boolean
AbstractPollingMessageListenerContainer.receiveAndExecute
(Object invoker, Session session, MessageConsumer consumer) Execute the listener for a message received from the given consumer, wrapping the entire operation in an external transaction if demanded.void
AbstractJmsListeningContainer.setBeanName
(String beanName) void
AbstractJmsListeningContainer.setClientId
(String clientId) Specify the JMS client ID for a shared Connection created and used by this container.void
AbstractMessageListenerContainer.setDestination
(Destination destination) Set the destination to receive messages from.void
AbstractMessageListenerContainer.setDestinationName
(String destinationName) Set the name of the destination to receive messages from.void
AbstractMessageListenerContainer.setDurableSubscriptionName
(String durableSubscriptionName) Set the name of a durable subscription to create.void
AbstractMessageListenerContainer.setErrorHandler
(ErrorHandler errorHandler) Set theErrorHandler
to be invoked in case of any uncaught exceptions thrown while processing aMessage
.void
AbstractMessageListenerContainer.setExceptionListener
(ExceptionListener exceptionListener) Set the JMS ExceptionListener to notify in case of a JMSException thrown by the registered message listener or the invocation infrastructure.void
AbstractMessageListenerContainer.setMessageConverter
(MessageConverter messageConverter) Set theMessageConverter
strategy for converting JMS Messages.void
AbstractMessageListenerContainer.setMessageListener
(Object messageListener) Set the message listener implementation to register.void
AbstractMessageListenerContainer.setMessageSelector
(String messageSelector) Set the JMS message selector expression (ornull
if none).void
AbstractMessageListenerContainer.setObservationRegistry
(io.micrometer.observation.ObservationRegistry observationRegistry) Set theObservationRegistry
to be used for recordingJMS message processing observations
.void
AbstractMessageListenerContainer.setReplyQosSettings
(QosSettings replyQosSettings) Configure theQosSettings
to use when sending a reply.void
AbstractMessageListenerContainer.setSubscriptionName
(String subscriptionName) Set the name of a subscription to create.void
AbstractPollingMessageListenerContainer.setTransactionManager
(PlatformTransactionManager transactionManager) Specify the SpringPlatformTransactionManager
to use for transactional wrapping of message reception plus listener execution. -
Uses of Nullable in org.springframework.jms.listener.adapter
Modifier and TypeMethodDescriptionprotected MessageConverter
AbstractAdaptableMessageListener.getMessageConverter()
Return the converter that will convert incoming JMS messages to listener method arguments, and objects returned from listener methods back to JMS messages.protected QosSettings
AbstractAdaptableMessageListener.getResponseQosSettings()
Return theQosSettings
to use when sending a response, ornull
if the defaults should be used.protected Object
MessageListenerAdapter.invokeListenerMethod
(String methodName, Object[] arguments) Invoke the specified listener method.protected Destination
AbstractAdaptableMessageListener.resolveDefaultResponseDestination
(Session session) Resolve the default response destination into a JMSDestination
, using this accessor'sDestinationResolver
in case of a destination name.JmsResponse.resolveDestination
(DestinationResolver destinationResolver, Session session) Resolve theDestination
to use for this instance.Modifier and TypeMethodDescriptionprotected void
AbstractAdaptableMessageListener.handleResult
(Object result, Message request, Session session) Handle the given result object returned from the listener method, sending a response message back.abstract void
void
SpringSessionAwareMessageListener
entry point.void
void
AbstractAdaptableMessageListener.setMessageConverter
(MessageConverter messageConverter) Set the converter that will convert incoming JMS messages to listener method arguments, and objects returned from listener methods back to JMS messages.void
AbstractAdaptableMessageListener.setResponseQosSettings
(QosSettings responseQosSettings) Set theQosSettings
to use when sending a response. -
Uses of Nullable in org.springframework.jms.listener.endpoint
Modifier and TypeMethodDescriptionprotected Class<?>
StandardJmsActivationSpecFactory.determineActivationSpecClass
(ResourceAdapter adapter) Determine the ActivationSpec class for the given ResourceAdapter, if possible.JmsMessageEndpointManager.getActivationSpecConfig()
Return theJmsActivationSpecConfig
object that this endpoint manager should use for activating its listener.JmsActivationSpecConfig.getClientId()
JmsActivationSpecConfig.getDestinationName()
JmsMessageEndpointManager.getDestinationResolver()
StandardJmsActivationSpecFactory.getDestinationResolver()
Return theDestinationResolver
to use for resolving destinations names.JmsActivationSpecConfig.getDurableSubscriptionName()
JmsActivationSpecConfig.getMessageConverter()
Return theMessageConverter
to use, if any.JmsMessageEndpointManager.getMessageConverter()
JmsActivationSpecConfig.getMessageSelector()
JmsActivationSpecConfig.getReplyQosSettings()
JmsMessageEndpointManager.getReplyQosSettings()
JmsActivationSpecConfig.getSubscriptionName()
Modifier and TypeMethodDescriptionvoid
JmsMessageEndpointManager.setActivationSpecConfig
(JmsActivationSpecConfig activationSpecConfig) Specify theJmsActivationSpecConfig
object that this endpoint manager should use for activating its listener.void
JmsMessageEndpointManager.setActivationSpecFactory
(JmsActivationSpecFactory activationSpecFactory) Set the factory for concrete JCA 1.5 ActivationSpec objects, creating JCA ActivationSpecs based onJmsActivationSpecConfig
objects.void
JmsActivationSpecConfig.setClientId
(String clientId) void
JmsActivationSpecConfig.setDestinationName
(String destinationName) void
StandardJmsActivationSpecFactory.setDestinationResolver
(DestinationResolver destinationResolver) Set the DestinationResolver to use for resolving destination names into the JCA 1.5 ActivationSpec "destination" property.void
JmsActivationSpecConfig.setDurableSubscriptionName
(String durableSubscriptionName) void
JmsActivationSpecConfig.setMessageConverter
(MessageConverter messageConverter) Set theMessageConverter
strategy for converting JMS Messages.void
JmsActivationSpecConfig.setMessageSelector
(String messageSelector) void
JmsActivationSpecConfig.setReplyQosSettings
(QosSettings replyQosSettings) void
JmsActivationSpecConfig.setSubscriptionName
(String subscriptionName) -
Uses of Nullable in org.springframework.jms.support
Modifier and TypeMethodDescriptionJmsAccessor.getConnectionFactory()
Return the ConnectionFactory that this accessor uses for obtaining JMSConnections
.JmsMessageHeaderAccessor.getCorrelationId()
Return thecorrelationId
.JmsMessageHeaderAccessor.getDeliveryMode()
Return thedelivery mode
.JmsMessageHeaderAccessor.getDestination()
Return thedestination
.JmsMessageHeaderAccessor.getExpiration()
Return the messageexpiration
.JmsMessageHeaderAccessor.getMessageId()
Return themessage id
.JmsMessageHeaderAccessor.getPriority()
Return thepriority
.JmsMessageHeaderAccessor.getRedelivered()
Return theredelivered
flag.JmsMessageHeaderAccessor.getReplyTo()
Return thereply to
.JmsMessageHeaderAccessor.getTimestamp()
Return thetimestamp
.JmsMessageHeaderAccessor.getType()
Return thetype
.Modifier and TypeMethodDescriptionstatic void
JmsUtils.closeConnection
(Connection con) Close the given JMS Connection and ignore any thrown exception.static void
JmsUtils.closeConnection
(Connection con, boolean stop) Close the given JMS Connection and ignore any thrown exception.static void
JmsUtils.closeMessageConsumer
(MessageConsumer consumer) Close the given JMS MessageConsumer and ignore any thrown exception.static void
JmsUtils.closeMessageProducer
(MessageProducer producer) Close the given JMS MessageProducer and ignore any thrown exception.static void
JmsUtils.closeQueueBrowser
(QueueBrowser browser) Close the given JMS QueueBrowser and ignore any thrown exception.static void
JmsUtils.closeQueueRequestor
(QueueRequestor requestor) Close the given JMS QueueRequestor and ignore any thrown exception.static void
JmsUtils.closeSession
(Session session) Close the given JMS Session and ignore any thrown exception.boolean
void
JmsAccessor.setConnectionFactory
(ConnectionFactory connectionFactory) Set the ConnectionFactory to use for obtaining JMSConnections
. -
Uses of Nullable in org.springframework.jms.support.converter
Modifier and TypeMethodDescriptionprotected Class<?>
MappingJackson2MessageConverter.getSerializationView
(Object conversionHint) Determine a Jackson serialization view based on the given conversion hint.Modifier and TypeMethodDescriptionprotected Message
MessagingMessageConverter.createMessageForPayload
(Object payload, Session session, Object conversionHint) Create a JMS message for the specified payload and conversionHint.protected Class<?>
MappingJackson2MessageConverter.getSerializationView
(Object conversionHint) Determine a Jackson serialization view based on the given conversion hint.Convert a Java object to a JMS Message using the specified json view and the supplied session to create the message object.A variant ofMessageConverter.toMessage(Object, Session)
which takes an extra conversion context as an argument, allowing to take e.g.ModifierConstructorDescriptionMessageConversionException
(String msg, Throwable cause) Create a new MessageConversionException. -
Uses of Nullable in org.springframework.jms.support.destination
Modifier and TypeMethodDescriptionprotected Message
JmsDestinationAccessor.receiveFromConsumer
(MessageConsumer consumer, long timeout) Actually receive a message from the given consumer.Modifier and TypeMethodDescriptionBeanFactoryDestinationResolver.resolveDestinationName
(Session session, String destinationName, boolean pubSubDomain) DestinationResolver.resolveDestinationName
(Session session, String destinationName, boolean pubSubDomain) Resolve the given destination name, either as located resource or as dynamic destination.DynamicDestinationResolver.resolveDestinationName
(Session session, String destinationName, boolean pubSubDomain) Resolve the specified destination name as a dynamic destination.JndiDestinationResolver.resolveDestinationName
(Session session, String destinationName, boolean pubSubDomain) ModifierConstructorDescriptionDestinationResolutionException
(String msg, Throwable cause) Create a new DestinationResolutionException. -
Uses of Nullable in org.springframework.jmx.access
Modifier and TypeMethodDescriptionprotected Object
MBeanClientInterceptor.convertResultValueIfNecessary
(Object result, MethodParameter parameter) Convert the given result object (from attribute access or operation invocation) to the specified target class for returning from the proxy method.protected Object
MBeanClientInterceptor.doInvoke
(MethodInvocation invocation) Route the invocation to the configured managed resource.MBeanClientInterceptor.getEnvironment()
AllowMap
access to the environment to be set for the connector, with the option to add or override specific entries.NotificationListenerRegistrar.getEnvironment()
AllowMap
access to the environment to be set for the connector, with the option to add or override specific entries.protected final Class<?>
MBeanClientInterceptor.getManagementInterface()
Return the management interface of the target MBean, ornull
if none specified.MBeanProxyFactoryBean.getObject()
protected Object
MBeanClientInterceptor.handleConnectFailure
(MethodInvocation invocation, Exception ex) Refresh the connection and retry the MBean invocation if possible.MBeanClientInterceptor.invoke
(MethodInvocation invocation) Route the invocation to the configured managed resource..Modifier and TypeMethodDescriptionprotected Object
MBeanClientInterceptor.convertResultValueIfNecessary
(Object result, MethodParameter parameter) Convert the given result object (from attribute access or operation invocation) to the specified target class for returning from the proxy method.void
MBeanClientInterceptor.setEnvironment
(Map<String, ?> environment) Specify the environment for the JMX connector.void
NotificationListenerRegistrar.setEnvironment
(Map<String, ?> environment) Specify the environment for the JMX connector.void
MBeanClientInterceptor.setManagementInterface
(Class<?> managementInterface) Set the management interface of the target MBean, exposing bean property setters and getters for MBean attributes and conventional Java methods for MBean operations. -
Uses of Nullable in org.springframework.jmx.export
Modifier and TypeMethodDescriptionprotected DynamicMBean
MBeanExporter.adaptMBeanIfPossible
(Object bean) Build an adapted MBean for the given bean instance, if possible.Modifier and TypeMethodDescriptionprotected ObjectName
MBeanExporter.getObjectName
(Object bean, String beanKey) Retrieve theObjectName
for a bean.protected boolean
Determine whether the given bean class qualifies as an MBean as-is. -
Uses of Nullable in org.springframework.jmx.export.annotation
Modifier and TypeMethodDescriptionAnnotationJmxAttributeSource.getManagedAttribute
(Method method) AnnotationJmxAttributeSource.getManagedMetric
(Method method) AnnotationJmxAttributeSource.getManagedOperation
(Method method) AnnotationJmxAttributeSource.getManagedResource
(Class<?> beanClass) -
Uses of Nullable in org.springframework.jmx.export.assembler
Modifier and TypeMethodDescriptionprotected Integer
AbstractReflectiveMBeanInfoAssembler.getDefaultCurrencyTimeLimit()
Return default value for the JMX field "currencyTimeLimit", if any.protected ParameterNameDiscoverer
AbstractReflectiveMBeanInfoAssembler.getParameterNameDiscoverer()
Return the ParameterNameDiscoverer to use for resolving method parameter names if needed (may benull
in order to skip parameter detection).Modifier and TypeMethodDescriptionprotected void
AbstractReflectiveMBeanInfoAssembler.populateAttributeDescriptor
(Descriptor desc, Method getter, Method setter, String beanKey) Allows subclasses to add extra fields to theDescriptor
for a particular attribute.protected void
AbstractReflectiveMBeanInfoAssembler.populateAttributeDescriptor
(Descriptor desc, Method getter, Method setter, String beanKey) Allows subclasses to add extra fields to theDescriptor
for a particular attribute.protected void
MetadataMBeanInfoAssembler.populateAttributeDescriptor
(Descriptor desc, Method getter, Method setter, String beanKey) Adds descriptor fields from theManagedAttribute
attribute or theManagedMetric
attribute to the attribute descriptor.protected void
MetadataMBeanInfoAssembler.populateAttributeDescriptor
(Descriptor desc, Method getter, Method setter, String beanKey) Adds descriptor fields from theManagedAttribute
attribute or theManagedMetric
attribute to the attribute descriptor.void
InterfaceBasedMBeanInfoAssembler.setBeanClassLoader
(ClassLoader beanClassLoader) void
AbstractReflectiveMBeanInfoAssembler.setDefaultCurrencyTimeLimit
(Integer defaultCurrencyTimeLimit) Set the default for the JMX field "currencyTimeLimit".void
InterfaceBasedMBeanInfoAssembler.setInterfaceMappings
(Properties mappings) Set the mappings of bean keys to a comma-separated list of interface names.void
InterfaceBasedMBeanInfoAssembler.setManagedInterfaces
(Class<?>... managedInterfaces) Set the array of interfaces to use for creating the management info.void
AbstractReflectiveMBeanInfoAssembler.setParameterNameDiscoverer
(ParameterNameDiscoverer parameterNameDiscoverer) Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (e.g. -
Uses of Nullable in org.springframework.jmx.export.metadata
Modifier and TypeMethodDescriptionManagedMetric.getCategory()
The category of this metric (ex.ManagedAttribute.getDefaultValue()
Return the default value of this attribute.ManagedNotification.getDescription()
Return a description for this notification.ManagedMetric.getDisplayName()
A display name for this metric.ManagedResource.getLogFile()
JmxAttributeSource.getManagedAttribute
(Method method) Implementations should return an instance ofManagedAttribute
if the suppliedMethod
has the corresponding metadata.JmxAttributeSource.getManagedMetric
(Method method) Implementations should return an instance ofManagedMetric
if the suppliedMethod
has the corresponding metadata.JmxAttributeSource.getManagedOperation
(Method method) Implementations should return an instance ofManagedOperation
if the suppliedMethod
has the corresponding metadata.JmxAttributeSource.getManagedResource
(Class<?> clazz) Implementations should return an instance ofManagedResource
if the suppliedClass
has the appropriate metadata.ManagedNotification.getName()
Return the name of this notification.String[]
ManagedNotification.getNotificationTypes()
Return the list of notification types.ManagedResource.getObjectName()
Return the JMX ObjectName of this managed resource.ManagedResource.getPersistLocation()
ManagedResource.getPersistName()
ManagedAttribute.getPersistPolicy()
ManagedMetric.getPersistPolicy()
The persist policy for this metric.ManagedResource.getPersistPolicy()
ManagedMetric.getUnit()
The expected unit of measurement values.Modifier and TypeMethodDescriptionvoid
ManagedMetric.setCategory
(String category) The category of this metric (ex.void
ManagedAttribute.setDefaultValue
(Object defaultValue) Set the default value of this attribute.void
ManagedNotification.setDescription
(String description) Set a description for this notification.void
ManagedMetric.setDisplayName
(String displayName) A display name for this metric.void
ManagedResource.setLogFile
(String logFile) void
Set the name of this notification.void
ManagedNotification.setNotificationTypes
(String... notificationTypes) Set a list of notification types.void
ManagedResource.setObjectName
(String objectName) Set the JMX ObjectName of this managed resource.void
ManagedResource.setPersistLocation
(String persistLocation) void
ManagedResource.setPersistName
(String persistName) void
ManagedAttribute.setPersistPolicy
(String persistPolicy) void
ManagedMetric.setPersistPolicy
(String persistPolicy) The persist policy for this metric.void
ManagedResource.setPersistPolicy
(String persistPolicy) void
The expected unit of measurement values. -
Uses of Nullable in org.springframework.jmx.export.naming
Modifier and TypeMethodDescriptionIdentityNamingStrategy.getObjectName
(Object managedBean, String beanKey) Returns an instance ofObjectName
based on the identity of the managed resource.KeyNamingStrategy.getObjectName
(Object managedBean, String beanKey) Attempts to retrieve theObjectName
via the given key, trying to find a mapped value in the mappings first.MetadataNamingStrategy.getObjectName
(Object managedBean, String beanKey) Reads theObjectName
from the source-level metadata associated with the managed resource'sClass
.ObjectNamingStrategy.getObjectName
(Object managedBean, String beanKey) Obtain anObjectName
for the supplied bean. -
Uses of Nullable in org.springframework.jmx.support
Modifier and TypeFieldDescriptionNotificationListenerHolder.mappedObjectNames
protected MBeanServer
MBeanRegistrationSupport.server
TheMBeanServer
instance being used to register beans.Modifier and TypeMethodDescriptionNotificationListenerHolder.getHandback()
Return the (arbitrary) object that will be 'handed back' as-is by anNotificationBroadcaster
when notifying anyNotificationListener
.static Class<?>
JmxUtils.getMBeanInterface
(Class<?> clazz) Return the Standard MBean interface for the given class, if any (that is, an interface whose name matches the class name of the given class but with suffix "MBean").static Class<?>
JmxUtils.getMXBeanInterface
(Class<?> clazz) Return the Java MXBean interface for the given class, if any (that is, an interface whose name ends with "MXBean" and/or carries an appropriate MXBean annotation).NotificationListenerHolder.getNotificationFilter()
Return theNotificationFilter
associated with the encapsulatedNotificationListener
.NotificationListenerHolder.getNotificationListener()
Get theNotificationListener
.ConnectorServerFactoryBean.getObject()
MBeanServerConnectionFactoryBean.getObject()
MBeanServerFactoryBean.getObject()
NotificationListenerHolder.getResolvedObjectNames()
Return the list ofObjectName
String representations for which the encapsulatedNotificationFilter
will be registered as a listener forNotifications
.final MBeanServer
MBeanRegistrationSupport.getServer()
Return theMBeanServer
that the beans will be registered with.static Class<?>[]
JmxUtils.parameterInfoToTypes
(MBeanParameterInfo[] paramInfo) Convert an array ofMBeanParameterInfo
into an array ofClass
instances corresponding to the parameters.static Class<?>[]
JmxUtils.parameterInfoToTypes
(MBeanParameterInfo[] paramInfo, ClassLoader classLoader) Convert an array ofMBeanParameterInfo
into an array ofClass
instances corresponding to the parameters.Modifier and TypeMethodDescriptionprotected MBeanServer
MBeanServerFactoryBean.createMBeanServer
(String defaultDomain, boolean registerWithFactory) Create a newMBeanServer
instance and register it with theMBeanServerFactory
, if desired.boolean
static Class<?>
JmxUtils.getMBeanInterface
(Class<?> clazz) Return the Standard MBean interface for the given class, if any (that is, an interface whose name matches the class name of the given class but with suffix "MBean").static Class<?>
JmxUtils.getMXBeanInterface
(Class<?> clazz) Return the Java MXBean interface for the given class, if any (that is, an interface whose name ends with "MXBean" and/or carries an appropriate MXBean annotation).static boolean
Determine whether the given bean class qualifies as an MBean as-is.static MBeanServer
JmxUtils.locateMBeanServer
(String agentId) Attempt to find a locally runningMBeanServer
.protected MBeanServer
MBeanServerFactoryBean.locateMBeanServer
(String agentId) Attempt to locate an existingMBeanServer
.static Class<?>[]
JmxUtils.parameterInfoToTypes
(MBeanParameterInfo[] paramInfo) Convert an array ofMBeanParameterInfo
into an array ofClass
instances corresponding to the parameters.static Class<?>[]
JmxUtils.parameterInfoToTypes
(MBeanParameterInfo[] paramInfo, ClassLoader classLoader) Convert an array ofMBeanParameterInfo
into an array ofClass
instances corresponding to the parameters.static Class<?>[]
JmxUtils.parameterInfoToTypes
(MBeanParameterInfo[] paramInfo, ClassLoader classLoader) Convert an array ofMBeanParameterInfo
into an array ofClass
instances corresponding to the parameters.void
ConnectorServerFactoryBean.setEnvironment
(Properties environment) Set the environment properties used to construct theJMXConnectorServer
asjava.util.Properties
(String key/value pairs).void
ConnectorServerFactoryBean.setEnvironmentMap
(Map<String, ?> environment) Set the environment properties used to construct theJMXConnector
as aMap
of String keys and arbitrary Object values.void
MBeanServerConnectionFactoryBean.setEnvironmentMap
(Map<String, ?> environment) Set the environment properties used to construct theJMXConnector
as aMap
of String keys and arbitrary Object values.void
NotificationListenerHolder.setHandback
(Object handback) Set the (arbitrary) object that will be 'handed back' as-is by anNotificationBroadcaster
when notifying anyNotificationListener
.void
NotificationListenerHolder.setMappedObjectName
(Object mappedObjectName) Set theObjectName
-style name of the single MBean that the encapsulatedNotificationFilter
will be registered with to listen forNotifications
.void
NotificationListenerHolder.setNotificationFilter
(NotificationFilter notificationFilter) Set theNotificationFilter
associated with the encapsulatedNotificationFilter
.void
NotificationListenerHolder.setNotificationListener
(NotificationListener notificationListener) Set theNotificationListener
.void
MBeanRegistrationSupport.setServer
(MBeanServer server) Specify theMBeanServer
instance with which all beans should be registered. -
Uses of Nullable in org.springframework.jndi
Modifier and TypeMethodDescriptionJndiCallback.doInContext
(Context ctx) Do something with the given JNDI context.<T> T
JndiTemplate.execute
(JndiCallback<T> contextCallback) Execute the given JNDI context callback implementation.JndiTemplate.getEnvironment()
Return the environment for the JNDI InitialContext, if any.Class<?>
JndiObjectLocator.getExpectedType()
Return the type that the located JNDI object is supposed to be assignable to, if any.JndiAccessor.getJndiEnvironment()
Return the JNDI environment to use for JNDI lookups.JndiObjectLocator.getJndiName()
Return the JNDI name to look up.JndiObjectFactoryBean.getObject()
Return the singleton JNDI object.JndiPropertySource.getProperty
(String name) This implementation looks up and returns the value associated with the given name from the underlyingJndiLocatorDelegate
.JndiObjectTargetSource.getTarget()
Class<?>
JndiObjectTargetSource.getTargetClass()
Modifier and TypeMethodDescription<T> T
protected <T> T
Perform an actual JNDI lookup for the given name via the JndiTemplate.<T> T
Look up the object with the given name in the current JNDI context.void
JndiTemplate.releaseContext
(Context ctx) Release a JNDI context as obtained fromJndiTemplate.getContext()
.void
void
JndiTemplate.setEnvironment
(Properties environment) Set the environment for the JNDI InitialContext.void
JndiObjectLocator.setExpectedType
(Class<?> expectedType) Specify the type that the located JNDI object is supposed to be assignable to, if any.void
JndiAccessor.setJndiEnvironment
(Properties jndiEnvironment) Set the JNDI environment to use for JNDI lookups.void
JndiObjectLocator.setJndiName
(String jndiName) Specify the JNDI name to look up.void
JndiAccessor.setJndiTemplate
(JndiTemplate jndiTemplate) Set the JNDI template to use for JNDI lookups.ModifierConstructorDescriptionJndiTemplate
(Properties environment) Create a new JndiTemplate instance, using the given environment. -
Uses of Nullable in org.springframework.jndi.support
-
Uses of Nullable in org.springframework.mail
Modifier and TypeMethodDescriptionString[]
SimpleMailMessage.getBcc()
String[]
SimpleMailMessage.getCc()
SimpleMailMessage.getFrom()
MailSendException.getMessage()
SimpleMailMessage.getReplyTo()
SimpleMailMessage.getSentDate()
SimpleMailMessage.getSubject()
SimpleMailMessage.getText()
String[]
SimpleMailMessage.getTo()
Modifier and TypeMethodDescriptionboolean
void
void
void
void
void
void
SimpleMailMessage.setReplyTo
(String replyTo) void
SimpleMailMessage.setSentDate
(Date sentDate) void
SimpleMailMessage.setSubject
(String subject) void
void
ModifierConstructorDescriptionMailException
(String msg, Throwable cause) Constructor for MailException.MailException
(String msg, Throwable cause) Constructor for MailException.MailSendException
(String msg, Throwable cause) Constructor for MailSendException.Constructor for registration of failed messages, with the messages that failed as keys, and the thrown exceptions as values.Constructor for registration of failed messages, with the messages that failed as keys, and the thrown exceptions as values. -
Uses of Nullable in org.springframework.mail.javamail
Modifier and TypeMethodDescriptionJavaMailSenderImpl.getDefaultEncoding()
Return the default encoding forMimeMessages
, ornull
if none.protected String
MimeMessageHelper.getDefaultEncoding
(MimeMessage mimeMessage) Determine the default encoding for the given MimeMessage.JavaMailSenderImpl.getDefaultFileTypeMap()
MimeMessageHelper.getEncoding()
Return the specific character encoding used for this message, if any.JavaMailSenderImpl.getHost()
Return the mail server host.JavaMailSenderImpl.getPassword()
Return the password for the account at the mail host.JavaMailSenderImpl.getProtocol()
Return the mail protocol.JavaMailSenderImpl.getUsername()
Return the username for the account at the mail host.Modifier and TypeMethodDescriptionprotected FileTypeMap
ConfigurableMimeFileTypeMap.createFileTypeMap
(Resource mappingLocation, String[] mappings) Compile aFileTypeMap
from the mappings in the given mapping file and the given mapping entries.protected FileTypeMap
ConfigurableMimeFileTypeMap.createFileTypeMap
(Resource mappingLocation, String[] mappings) Compile aFileTypeMap
from the mappings in the given mapping file and the given mapping entries.protected void
JavaMailSenderImpl.doSend
(MimeMessage[] mimeMessages, Object[] originalMessages) Actually send the given array of MimeMessages via JavaMail.void
JavaMailSenderImpl.setDefaultEncoding
(String defaultEncoding) Set the default encoding to use forMimeMessages
created by this instance.void
JavaMailSenderImpl.setDefaultFileTypeMap
(FileTypeMap defaultFileTypeMap) Set the default Java ActivationFileTypeMap
to use forMimeMessages
created by this instance.void
MimeMessageHelper.setFileTypeMap
(FileTypeMap fileTypeMap) Set the Java Activation FrameworkFileTypeMap
to use for determining the content type of inline content and attachments that get added to the message.void
Set the mail server host, typically an SMTP host.protected final void
MimeMessageHelper.setMimeMultiparts
(MimeMultipart root, MimeMultipart main) Set the given MimeMultipart objects for use by this MimeMessageHelper.protected final void
MimeMessageHelper.setMimeMultiparts
(MimeMultipart root, MimeMultipart main) Set the given MimeMultipart objects for use by this MimeMessageHelper.void
JavaMailSenderImpl.setPassword
(String password) Set the password for the account at the mail host, if any.void
JavaMailSenderImpl.setProtocol
(String protocol) Set the mail protocol.void
JavaMailSenderImpl.setUsername
(String username) Set the username for the account at the mail host, if any.ModifierConstructorDescriptionMimeMessageHelper
(MimeMessage mimeMessage, boolean multipart, String encoding) Create a new MimeMessageHelper for the given MimeMessage, in multipart mode (supporting alternative texts, inline elements and attachments) if requested.MimeMessageHelper
(MimeMessage mimeMessage, int multipartMode, String encoding) Create a new MimeMessageHelper for the given MimeMessage, in multipart mode (supporting alternative texts, inline elements and attachments) if requested.MimeMessageHelper
(MimeMessage mimeMessage, String encoding) Create a new MimeMessageHelper for the given MimeMessage, assuming a simple text message (no multipart content, i.e. -
Uses of Nullable in org.springframework.messaging
Modifier and TypeMethodDescription<T> T
MessageHeaders.getErrorChannel()
Message<?>
MessagingException.getFailedMessage()
MessageHeaders.getId()
MessageHeaders.getReplyChannel()
MessageHeaders.getTimestamp()
Message<?>
PollableChannel.receive()
Receive a message from this channel, blocking indefinitely if necessary.Message<?>
PollableChannel.receive
(long timeout) Receive a message from this channel, blocking until either a message is available or the specified timeout period elapses.ModifierConstructorDescriptionMessageHeaders
(Map<String, Object> headers) Construct aMessageHeaders
with the given headers.protected
Constructor providing control over the ID and TIMESTAMP header values.protected
Constructor providing control over the ID and TIMESTAMP header values.protected
Constructor providing control over the ID and TIMESTAMP header values.MessagingException
(String description, Throwable cause) MessagingException
(String description, Throwable cause) MessagingException
(Message<?> message, String description, Throwable cause) MessagingException
(Message<?> message, String description, Throwable cause) -
Uses of Nullable in org.springframework.messaging.converter
Modifier and TypeMethodDescriptionprotected Object
AbstractJsonMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
AbstractMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) Convert the message payload from serialized form to an Object.protected Object
ByteArrayMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
MappingJackson2MessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
MarshallingMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
AbstractJsonMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
AbstractMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) Convert the payload object to serialized form.protected Object
ByteArrayMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
MappingJackson2MessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
MarshallingMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
StringMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) final Object
AbstractMessageConverter.fromMessage
(Message<?> message, Class<?> targetClass) final Object
AbstractMessageConverter.fromMessage
(Message<?> message, Class<?> targetClass, Object conversionHint) CompositeMessageConverter.fromMessage
(Message<?> message, Class<?> targetClass) CompositeMessageConverter.fromMessage
(Message<?> message, Class<?> targetClass, Object conversionHint) GenericMessageConverter.fromMessage
(Message<?> message, Class<?> targetClass) MessageConverter.fromMessage
(Message<?> message, Class<?> targetClass) Convert the payload of aMessage
from a serialized form to a typed Object of the specified target class.SimpleMessageConverter.fromMessage
(Message<?> message, Class<?> targetClass) SmartMessageConverter.fromMessage
(Message<?> message, Class<?> targetClass, Object conversionHint) A variant ofMessageConverter.fromMessage(Message, Class)
which takes an extra conversion context as an argument, allowing to take e.g.AbstractMessageConverter.getContentTypeResolver()
Return theconfigured
ContentTypeResolver
.protected MimeType
AbstractMessageConverter.getDefaultContentType
(Object payload) Return the default content type for the payload.DefaultContentTypeResolver.getDefaultMimeType()
Return the default MIME type to use if noMessageHeaders.CONTENT_TYPE
header is present.MarshallingMessageConverter.getMarshaller()
Return the configured Marshaller.protected MimeType
AbstractMessageConverter.getMimeType
(MessageHeaders headers) protected Class<?>
MappingJackson2MessageConverter.getSerializationView
(Object conversionHint) Determine a Jackson serialization view based on the given conversion hint.MarshallingMessageConverter.getUnmarshaller()
Return the configured unmarshaller.ContentTypeResolver.resolve
(MessageHeaders headers) Determine theMimeType
of a message from the given MessageHeaders.DefaultContentTypeResolver.resolve
(MessageHeaders headers) final Message<?>
AbstractMessageConverter.toMessage
(Object payload, MessageHeaders headers) final Message<?>
AbstractMessageConverter.toMessage
(Object payload, MessageHeaders headers, Object conversionHint) Message<?>
CompositeMessageConverter.toMessage
(Object payload, MessageHeaders headers) Message<?>
CompositeMessageConverter.toMessage
(Object payload, MessageHeaders headers, Object conversionHint) Message<?>
MessageConverter.toMessage
(Object payload, MessageHeaders headers) Create aMessage
whose payload is the result of converting the given payload Object to serialized form.Message<?>
SmartMessageConverter.toMessage
(Object payload, MessageHeaders headers, Object conversionHint) A variant ofMessageConverter.toMessage(Object, MessageHeaders)
which takes an extra conversion context as an argument, allowing to take e.g.Modifier and TypeMethodDescriptionprotected boolean
MappingJackson2MessageConverter.canConvertFrom
(Message<?> message, Class<?> targetClass) protected boolean
AbstractMessageConverter.canConvertTo
(Object payload, MessageHeaders headers) protected boolean
MappingJackson2MessageConverter.canConvertTo
(Object payload, MessageHeaders headers) protected boolean
MarshallingMessageConverter.canConvertTo
(Object payload, MessageHeaders headers) protected boolean
ProtobufMessageConverter.canConvertTo
(Object payload, MessageHeaders headers) protected Object
AbstractJsonMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
AbstractMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) Convert the message payload from serialized form to an Object.protected Object
ByteArrayMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
ByteArrayMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
MappingJackson2MessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
MarshallingMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
ProtobufMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
StringMessageConverter.convertFromInternal
(Message<?> message, Class<?> targetClass, Object conversionHint) protected Object
AbstractJsonMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
AbstractJsonMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
AbstractMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) Convert the payload object to serialized form.protected Object
AbstractMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) Convert the payload object to serialized form.protected Object
ByteArrayMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
ByteArrayMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
MappingJackson2MessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
MappingJackson2MessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
MarshallingMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
MarshallingMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
ProtobufMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
ProtobufMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
StringMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) protected Object
StringMessageConverter.convertToInternal
(Object payload, MessageHeaders headers, Object conversionHint) final Object
AbstractMessageConverter.fromMessage
(Message<?> message, Class<?> targetClass, Object conversionHint) CompositeMessageConverter.fromMessage
(Message<?> message, Class<?> targetClass, Object conversionHint) SmartMessageConverter.fromMessage
(Message<?> message, Class<?> targetClass, Object conversionHint) A variant ofMessageConverter.fromMessage(Message, Class)
which takes an extra conversion context as an argument, allowing to take e.g.protected JsonEncoding
MappingJackson2MessageConverter.getJsonEncoding
(MimeType contentType) Determine the JSON encoding to use for the given content type.protected MimeType
AbstractMessageConverter.getMimeType
(MessageHeaders headers) protected Class<?>
MappingJackson2MessageConverter.getSerializationView
(Object conversionHint) Determine a Jackson serialization view based on the given conversion hint.protected void
MappingJackson2MessageConverter.logWarningIfNecessary
(Type type, Throwable cause) Determine whether to log the given exception coming from aObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType)
/ObjectMapper.canSerialize(java.lang.Class<?>)
check.ContentTypeResolver.resolve
(MessageHeaders headers) Determine theMimeType
of a message from the given MessageHeaders.DefaultContentTypeResolver.resolve
(MessageHeaders headers) void
AbstractMessageConverter.setContentTypeResolver
(ContentTypeResolver resolver) Configure aContentTypeResolver
for resolving the content type of input messages.void
DefaultContentTypeResolver.setDefaultMimeType
(MimeType defaultMimeType) Set the default MIME type to use when there is noMessageHeaders.CONTENT_TYPE
header present.void
MarshallingMessageConverter.setMarshaller
(Marshaller marshaller) Set theMarshaller
to be used by this message converter.void
MarshallingMessageConverter.setUnmarshaller
(Unmarshaller unmarshaller) Set theUnmarshaller
to be used by this message converter.protected boolean
AbstractMessageConverter.supportsMimeType
(MessageHeaders headers) final Message<?>
AbstractMessageConverter.toMessage
(Object payload, MessageHeaders headers) final Message<?>
AbstractMessageConverter.toMessage
(Object payload, MessageHeaders headers, Object conversionHint) final Message<?>
AbstractMessageConverter.toMessage
(Object payload, MessageHeaders headers, Object conversionHint) Message<?>
CompositeMessageConverter.toMessage
(Object payload, MessageHeaders headers) Message<?>
CompositeMessageConverter.toMessage
(Object payload, MessageHeaders headers, Object conversionHint) Message<?>
CompositeMessageConverter.toMessage
(Object payload, MessageHeaders headers, Object conversionHint) Message<?>
MessageConverter.toMessage
(Object payload, MessageHeaders headers) Create aMessage
whose payload is the result of converting the given payload Object to serialized form.Message<?>
SimpleMessageConverter.toMessage
(Object payload, MessageHeaders headers) Message<?>
SmartMessageConverter.toMessage
(Object payload, MessageHeaders headers, Object conversionHint) A variant ofMessageConverter.toMessage(Object, MessageHeaders)
which takes an extra conversion context as an argument, allowing to take e.g.Message<?>
SmartMessageConverter.toMessage
(Object payload, MessageHeaders headers, Object conversionHint) A variant ofMessageConverter.toMessage(Object, MessageHeaders)
which takes an extra conversion context as an argument, allowing to take e.g.ModifierConstructorDescriptionMessageConversionException
(String description, Throwable cause) MessageConversionException
(String description, Throwable cause) MessageConversionException
(Message<?> failedMessage, String description, Throwable cause) MessageConversionException
(Message<?> failedMessage, String description, Throwable cause) ProtobufJsonFormatMessageConverter
(com.google.protobuf.ExtensionRegistry extensionRegistry) Constructor with default instances ofJsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
.ProtobufJsonFormatMessageConverter
(com.google.protobuf.util.JsonFormat.Parser parser, com.google.protobuf.util.JsonFormat.Printer printer) Constructor with given instances ofJsonFormat.Parser
,JsonFormat.Printer
, and a default instance ofExtensionRegistry
.ProtobufJsonFormatMessageConverter
(com.google.protobuf.util.JsonFormat.Parser parser, com.google.protobuf.util.JsonFormat.Printer printer) Constructor with given instances ofJsonFormat.Parser
,JsonFormat.Printer
, and a default instance ofExtensionRegistry
.ProtobufJsonFormatMessageConverter
(com.google.protobuf.util.JsonFormat.Parser parser, com.google.protobuf.util.JsonFormat.Printer printer, com.google.protobuf.ExtensionRegistry extensionRegistry) Constructor with given instances ofJsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
.ProtobufJsonFormatMessageConverter
(com.google.protobuf.util.JsonFormat.Parser parser, com.google.protobuf.util.JsonFormat.Printer printer, com.google.protobuf.ExtensionRegistry extensionRegistry) Constructor with given instances ofJsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
.ProtobufJsonFormatMessageConverter
(com.google.protobuf.util.JsonFormat.Parser parser, com.google.protobuf.util.JsonFormat.Printer printer, com.google.protobuf.ExtensionRegistry extensionRegistry) Constructor with given instances ofJsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
. -
Uses of Nullable in org.springframework.messaging.core
Modifier and TypeMethodDescription<T> T
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass) <T> T
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass) <T> T
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(D destination, Object request, Class<T> targetClass) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(D destination, Object request, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(D destination, Object request, Map<String, Object> headers, Class<T> targetClass) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(D destination, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(Object request, Class<T> targetClass) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(Object request, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass) Resolve the given destination name, convert the payload request Object to serialized form, possibly using aMessageConverter
, wrap it as a message and send it to the resolved destination, receive a reply and convert its body to the specified target class.<T> T
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Resolve the given destination name, convert the payload request Object to serialized form, possibly using aMessageConverter
, wrap it as a message, apply the given post process, and send the resulting message to the resolved destination, then receive a reply and convert its body to the specified target class.<T> T
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass) Resolve the given destination name, convert the payload request Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers and send it to the resolved destination, receive a reply and convert its body to the specified target class.<T> T
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Resolve the given destination name, convert the payload request Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post process, and send the resulting message to the resolved destination, then receive a reply and convert its body to the specified target class.<T> T
MessageRequestReplyOperations.convertSendAndReceive
(D destination, Object request, Class<T> targetClass) Convert the given request Object to serialized form, possibly using aMessageConverter
, send it as aMessage
to the given destination, receive the reply and convert its body of the specified target class.<T> T
MessageRequestReplyOperations.convertSendAndReceive
(D destination, Object request, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Convert the given request Object to serialized form, possibly using aMessageConverter
, apply the given post processor and send the resultingMessage
to the given destination, receive the reply and convert its body of the given target class.<T> T
MessageRequestReplyOperations.convertSendAndReceive
(D destination, Object request, Map<String, Object> headers, Class<T> targetClass) Convert the given request Object to serialized form, possibly using aMessageConverter
, send it as aMessage
with the given headers, to the specified destination, receive the reply and convert its body of the specified target class.<T> T
MessageRequestReplyOperations.convertSendAndReceive
(D destination, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Convert the given request Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post processor and send the resultingMessage
to the specified destination, receive the reply and convert its body of the given target class.<T> T
MessageRequestReplyOperations.convertSendAndReceive
(Object request, Class<T> targetClass) Convert the given request Object to serialized form, possibly using aMessageConverter
, send it as aMessage
to a default destination, receive the reply and convert its body of the specified target class.<T> T
MessageRequestReplyOperations.convertSendAndReceive
(Object request, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Convert the given request Object to serialized form, possibly using aMessageConverter
, apply the given post processor and send the resultingMessage
to a default destination, receive the reply and convert its body of the given target class.protected <T> T
Convert from the given message to the given target class.protected abstract Message<?>
Actually receive a message from the given destination.protected final Message<?>
GenericMessagingTemplate.doReceive
(MessageChannel channel) protected final Message<?>
GenericMessagingTemplate.doReceive
(MessageChannel channel, long timeout) protected abstract Message<?>
AbstractMessagingTemplate.doSendAndReceive
(D destination, Message<?> requestMessage) protected final Message<?>
GenericMessagingTemplate.doSendAndReceive
(MessageChannel channel, Message<?> requestMessage) AbstractMessageSendingTemplate.getDefaultDestination()
Return the configured default destination.AbstractDestinationResolvingMessagingTemplate.getDestinationResolver()
Return the configured destination resolver.AbstractMessageSendingTemplate.processHeadersToSend
(Map<String, Object> headers) Provides access to the map of input headers before a send operation.Message<?>
Message<?>
AbstractMessageReceivingTemplate.receive()
Message<?>
Message<?>
Resolve the given destination name and receive a message from it.Message<?>
MessageReceivingOperations.receive()
Receive a message from a default destination.Message<?>
Receive a message from the given destination.<T> T
AbstractDestinationResolvingMessagingTemplate.receiveAndConvert
(String destinationName, Class<T> targetClass) <T> T
AbstractMessageReceivingTemplate.receiveAndConvert
(D destination, Class<T> targetClass) <T> T
AbstractMessageReceivingTemplate.receiveAndConvert
(Class<T> targetClass) <T> T
DestinationResolvingMessageReceivingOperations.receiveAndConvert
(String destinationName, Class<T> targetClass) Resolve the given destination name, receive a message from it, convert the payload to the specified target type.<T> T
MessageReceivingOperations.receiveAndConvert
(D destination, Class<T> targetClass) Receive a message from the given destination and convert its payload to the specified target class.<T> T
MessageReceivingOperations.receiveAndConvert
(Class<T> targetClass) Receive a message from a default destination and convert its payload to the specified target class.Message<?>
AbstractDestinationResolvingMessagingTemplate.sendAndReceive
(String destinationName, Message<?> requestMessage) Message<?>
AbstractMessagingTemplate.sendAndReceive
(D destination, Message<?> requestMessage) Message<?>
AbstractMessagingTemplate.sendAndReceive
(Message<?> requestMessage) Message<?>
DestinationResolvingMessageRequestReplyOperations.sendAndReceive
(String destinationName, Message<?> requestMessage) Resolve the given destination name to a destination and send the given message, receive a reply and return it.Message<?>
MessageRequestReplyOperations.sendAndReceive
(D destination, Message<?> requestMessage) Send a request message and receive the reply from the given destination.Message<?>
MessageRequestReplyOperations.sendAndReceive
(Message<?> requestMessage) Send a request message and receive the reply from a default destination.Modifier and TypeMethodDescription<T> void
AbstractDestinationResolvingMessagingTemplate.convertAndSend
(String destinationName, T payload, Map<String, Object> headers) <T> void
AbstractDestinationResolvingMessagingTemplate.convertAndSend
(String destinationName, T payload, Map<String, Object> headers, MessagePostProcessor postProcessor) <T> void
AbstractDestinationResolvingMessagingTemplate.convertAndSend
(String destinationName, T payload, Map<String, Object> headers, MessagePostProcessor postProcessor) <T> void
AbstractDestinationResolvingMessagingTemplate.convertAndSend
(String destinationName, T payload, MessagePostProcessor postProcessor) void
AbstractMessageSendingTemplate.convertAndSend
(D destination, Object payload, Map<String, Object> headers) void
AbstractMessageSendingTemplate.convertAndSend
(D destination, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) void
AbstractMessageSendingTemplate.convertAndSend
(D destination, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) void
AbstractMessageSendingTemplate.convertAndSend
(D destination, Object payload, MessagePostProcessor postProcessor) void
AbstractMessageSendingTemplate.convertAndSend
(Object payload, MessagePostProcessor postProcessor) <T> void
DestinationResolvingMessageSendingOperations.convertAndSend
(String destinationName, T payload, Map<String, Object> headers) Resolve the given destination name to a destination, convert the payload Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers and send it to the resolved destination.<T> void
DestinationResolvingMessageSendingOperations.convertAndSend
(String destinationName, T payload, Map<String, Object> headers, MessagePostProcessor postProcessor) Resolve the given destination name to a destination, convert the payload Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to the resolved destination.<T> void
DestinationResolvingMessageSendingOperations.convertAndSend
(String destinationName, T payload, Map<String, Object> headers, MessagePostProcessor postProcessor) Resolve the given destination name to a destination, convert the payload Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to the resolved destination.<T> void
DestinationResolvingMessageSendingOperations.convertAndSend
(String destinationName, T payload, MessagePostProcessor postProcessor) Resolve the given destination name to a destination, convert the payload Object to serialized form, possibly using aMessageConverter
, wrap it as a message, apply the given post processor, and send the resulting message to the resolved destination.void
MessageSendingOperations.convertAndSend
(D destination, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) Convert the given Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to the given destination.void
MessageSendingOperations.convertAndSend
(D destination, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) Convert the given Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to the given destination.void
MessageSendingOperations.convertAndSend
(Object payload, MessagePostProcessor postProcessor) Convert the given Object to serialized form, possibly using aMessageConverter
, wrap it as a message, apply the given post processor, and send the resulting message to a default destination.<T> T
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass) <T> T
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
AbstractDestinationResolvingMessagingTemplate.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(D destination, Object request, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(D destination, Object request, Map<String, Object> headers, Class<T> targetClass) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(D destination, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(D destination, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
AbstractMessagingTemplate.convertSendAndReceive
(Object request, Class<T> targetClass, MessagePostProcessor postProcessor) <T> T
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive
(String destinationName, Object request, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Resolve the given destination name, convert the payload request Object to serialized form, possibly using aMessageConverter
, wrap it as a message, apply the given post process, and send the resulting message to the resolved destination, then receive a reply and convert its body to the specified target class.<T> T
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass) Resolve the given destination name, convert the payload request Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers and send it to the resolved destination, receive a reply and convert its body to the specified target class.<T> T
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Resolve the given destination name, convert the payload request Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post process, and send the resulting message to the resolved destination, then receive a reply and convert its body to the specified target class.<T> T
DestinationResolvingMessageRequestReplyOperations.convertSendAndReceive
(String destinationName, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Resolve the given destination name, convert the payload request Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post process, and send the resulting message to the resolved destination, then receive a reply and convert its body to the specified target class.<T> T
MessageRequestReplyOperations.convertSendAndReceive
(D destination, Object request, Map<String, Object> headers, Class<T> targetClass) Convert the given request Object to serialized form, possibly using aMessageConverter
, send it as aMessage
with the given headers, to the specified destination, receive the reply and convert its body of the specified target class.<T> T
MessageRequestReplyOperations.convertSendAndReceive
(D destination, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Convert the given request Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post processor and send the resultingMessage
to the specified destination, receive the reply and convert its body of the given target class.<T> T
MessageRequestReplyOperations.convertSendAndReceive
(D destination, Object request, Map<String, Object> headers, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Convert the given request Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers, apply the given post processor and send the resultingMessage
to the specified destination, receive the reply and convert its body of the given target class.<T> T
MessageRequestReplyOperations.convertSendAndReceive
(Object request, Class<T> targetClass, MessagePostProcessor requestPostProcessor) Convert the given request Object to serialized form, possibly using aMessageConverter
, apply the given post processor and send the resultingMessage
to a default destination, receive the reply and convert its body of the given target class.protected Message<?>
AbstractMessageSendingTemplate.doConvert
(Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) Convert the given Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers and apply the given post processor.protected Message<?>
AbstractMessageSendingTemplate.doConvert
(Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) Convert the given Object to serialized form, possibly using aMessageConverter
, wrap it as a message with the given headers and apply the given post processor.AbstractMessageSendingTemplate.processHeadersToSend
(Map<String, Object> headers) Provides access to the map of input headers before a send operation.void
AbstractMessageSendingTemplate.setDefaultDestination
(D defaultDestination) Configure the default destination to use in send methods that don't have a destination argument.void
AbstractDestinationResolvingMessagingTemplate.setDestinationResolver
(DestinationResolver<D> destinationResolver) Configure theDestinationResolver
to use to resolve String destination names into actual destinations of type<D>
.ModifierConstructorDescriptionDestinationResolutionException
(String description, Throwable cause) DestinationResolutionException
(String description, Throwable cause) -
Uses of Nullable in org.springframework.messaging.handler
Modifier and TypeMethodDescriptionClass<?>
MessagingAdviceBean.getBeanType()
Return the type of the contained advice bean.DestinationPatternsMessageCondition.getMatchingCondition
(Message<?> message) Check if any of the patterns match the given Message destination and return an instance that is guaranteed to contain matching patterns, sorted viaPathMatcher.getPatternComparator(String)
.MessageCondition.getMatchingCondition
(Message<?> message) Check if this condition matches the given Message and returns a potentially new condition with content tailored to the current message.HandlerMethod.getResolvedFromHandlerMethod()
Return the HandlerMethod from which this HandlerMethod instance was resolved viaHandlerMethod.createWithResolvedBean()
.Modifier and TypeMethodDescriptionboolean
boolean
boolean
ModifierConstructorDescriptionDestinationPatternsMessageCondition
(String[] patterns, PathMatcher matcher) Constructor with patterns and aPathMatcher
instance. -
Uses of Nullable in org.springframework.messaging.handler.annotation
Modifier and TypeMethodDescriptionprotected Type
MessageMappingReflectiveProcessor.getMessageType
(MethodParameter parameter) -
Uses of Nullable in org.springframework.messaging.handler.annotation.reactive
Modifier and TypeMethodDescriptionprotected CompositeMessageCondition
MessageMappingMessageHandler.getCondition
(AnnotatedElement element) Determine the mapping condition for the given annotated element.protected MimeType
PayloadMethodArgumentResolver.getMimeType
(Message<?> message) Return the mime type for the content.MessageMappingMessageHandler.getRouteMatcher()
Return theRouteMatcher
used to map messages to handlers.MessageMappingMessageHandler.getValidator()
Return the configured Validator instance.PayloadMethodArgumentResolver.getValidator()
Return the configured validator, if any.protected abstract Object
AbstractNamedValueMethodArgumentResolver.resolveArgumentInternal
(MethodParameter parameter, Message<?> message, String name) Resolves the given parameter type and value name into an argument value.protected Object
DestinationVariableMethodArgumentResolver.resolveArgumentInternal
(MethodParameter parameter, Message<?> message, String name) protected Object
HeaderMethodArgumentResolver.resolveArgumentInternal
(MethodParameter parameter, Message<?> message, String name) HeadersMethodArgumentResolver.resolveArgumentValue
(MethodParameter parameter, Message<?> message) Modifier and TypeMethodDescriptionvoid
MessageMappingMessageHandler.setRouteMatcher
(RouteMatcher routeMatcher) Set theRouteMatcher
to use for mapping messages to handlers based on the route patterns they're configured with.void
MessageMappingMessageHandler.setValidator
(Validator validator) Set the Validator instance used for validating@Payload
arguments.ModifierConstructorDescriptionprotected
AbstractNamedValueMethodArgumentResolver
(ConversionService conversionService, ConfigurableBeanFactory beanFactory) Constructor with aConversionService
and aBeanFactory
.HeaderMethodArgumentResolver
(ConversionService conversionService, ConfigurableBeanFactory beanFactory) protected
NamedValueInfo
(String name, boolean required, String defaultValue) PayloadMethodArgumentResolver
(List<? extends Decoder<?>> decoders, Validator validator, ReactiveAdapterRegistry registry, boolean useDefaultResolution) PayloadMethodArgumentResolver
(List<? extends Decoder<?>> decoders, Validator validator, ReactiveAdapterRegistry registry, boolean useDefaultResolution) -
Uses of Nullable in org.springframework.messaging.handler.annotation.support
Modifier and TypeMethodDescriptionfinal BindingResult
MethodArgumentNotValidException.getBindingResult()
Return the BindingResult if the failure is validation-related, ornull
if none.HeadersMethodArgumentResolver.resolveArgument
(MethodParameter parameter, Message<?> message) PayloadMethodArgumentResolver.resolveArgument
(MethodParameter parameter, Message<?> message) protected abstract Object
AbstractNamedValueMethodArgumentResolver.resolveArgumentInternal
(MethodParameter parameter, Message<?> message, String name) Resolves the given parameter type and value name into an argument value.protected Object
DestinationVariableMethodArgumentResolver.resolveArgumentInternal
(MethodParameter parameter, Message<?> message, String name) protected Object
HeaderMethodArgumentResolver.resolveArgumentInternal
(MethodParameter parameter, Message<?> message, String name) Modifier and TypeMethodDescriptionprotected void
AbstractNamedValueMethodArgumentResolver.handleResolvedValue
(Object arg, String name, MethodParameter parameter, Message<?> message) Invoked after a value is resolved.protected boolean
MessageMethodArgumentResolver.isEmptyPayload
(Object payload) Check if the givenpayload
is empty.protected boolean
PayloadMethodArgumentResolver.isEmptyPayload
(Object payload) Specify if the givenpayload
is empty.void
DefaultMessageHandlerMethodFactory.setArgumentResolvers
(List<HandlerMethodArgumentResolver> argumentResolvers) Configure the complete list of supported argument types effectively overriding the ones configured by default.ModifierConstructorDescriptionprotected
AbstractNamedValueMethodArgumentResolver
(ConversionService conversionService, ConfigurableBeanFactory beanFactory) Constructor with aConversionService
and aBeanFactory
.HeaderMethodArgumentResolver
(ConversionService conversionService, ConfigurableBeanFactory beanFactory) MessageMethodArgumentResolver
(MessageConverter converter) Create a resolver instance with the givenMessageConverter
.protected
NamedValueInfo
(String name, boolean required, String defaultValue) PayloadMethodArgumentResolver
(MessageConverter messageConverter, Validator validator) PayloadMethodArgumentResolver
(MessageConverter messageConverter, Validator validator, boolean useDefaultResolution) -
Uses of Nullable in org.springframework.messaging.handler.invocation
Modifier and TypeMethodDescriptionprotected Object
Invoke the handler method with the given argument values.AbstractMethodMessageHandler.getApplicationContext()
protected abstract String
AbstractMethodMessageHandler.getDestination
(Message<?> message) protected InvocableHandlerMethod
AbstractMethodMessageHandler.getExceptionHandlerMethod
(HandlerMethod handlerMethod, Exception exception) Find an@MessageExceptionHandler
method for the given exception.protected Log
AbstractMethodMessageHandler.getHandlerMethodLogger()
Return a logger to set onInvocableHandlerMethod
.protected String
AbstractMethodMessageHandler.getLookupDestination
(String destination) Check whether the given destination (of an incoming message) matches to one of the configured destination prefixes and if so return the remaining portion of the destination after the matched prefix.protected abstract T
AbstractMethodMessageHandler.getMappingForMethod
(Method method, Class<?> handlerType) Provide the mapping for a handler method.protected abstract T
AbstractMethodMessageHandler.getMatchingMapping
(T mapping, Message<?> message) Check if a mapping matches the current message and return a possibly new mapping with conditions relevant to the current request.protected Log
AbstractMethodMessageHandler.getReturnValueHandlerLogger()
Return a logger to set onHandlerMethodReturnValueHandlerComposite
.Invoke the method after resolving its argument values in the context of the given message.HandlerMethodArgumentResolver.resolveArgument
(MethodParameter parameter, Message<?> message) Resolves a method parameter into an argument value from a given message.HandlerMethodArgumentResolverComposite.resolveArgument
(MethodParameter parameter, Message<?> message) Iterate over registeredHandlerMethodArgumentResolvers
and invoke the one that supports it.AbstractExceptionHandlerMethodResolver.resolveMethod
(Throwable exception) Find aMethod
to handle the given exception.AbstractExceptionHandlerMethodResolver.resolveMethodByExceptionType
(Class<? extends Throwable> exceptionType) Find aMethod
to handle the given exception type.AsyncHandlerMethodReturnValueHandler.toCompletableFuture
(Object returnValue, MethodParameter returnType) Adapt the asynchronous return value to aCompletableFuture
.HandlerMethodReturnValueHandlerComposite.toCompletableFuture
(Object returnValue, MethodParameter returnType) default ListenableFuture<?>
AsyncHandlerMethodReturnValueHandler.toListenableFuture
(Object returnValue, MethodParameter returnType) Deprecated.as of 6.0, in favor ofAsyncHandlerMethodReturnValueHandler.toCompletableFuture(Object, MethodParameter)
Modifier and TypeMethodDescriptionHandlerMethodReturnValueHandlerComposite.addHandlers
(List<? extends HandlerMethodReturnValueHandler> handlers) Add the givenHandlerMethodReturnValueHandlers
.HandlerMethodArgumentResolverComposite.addResolvers
(List<? extends HandlerMethodArgumentResolver> resolvers) Add the givenHandlerMethodArgumentResolvers
.HandlerMethodArgumentResolverComposite.addResolvers
(HandlerMethodArgumentResolver... resolvers) Add the givenHandlerMethodArgumentResolvers
.protected String
AbstractMethodMessageHandler.getLookupDestination
(String destination) Check whether the given destination (of an incoming message) matches to one of the configured destination prefixes and if so return the remaining portion of the destination after the matched prefix.void
AbstractAsyncReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, Message<?> message) void
HandlerMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, Message<?> message) Handle the given return value.void
HandlerMethodReturnValueHandlerComposite.handleReturnValue
(Object returnValue, MethodParameter returnType, Message<?> message) void
AbstractMethodMessageHandler.setApplicationContext
(ApplicationContext applicationContext) void
AbstractMethodMessageHandler.setArgumentResolvers
(List<HandlerMethodArgumentResolver> argumentResolvers) Configure the complete list of supported argument types, effectively overriding the ones configured by default.void
AbstractMethodMessageHandler.setCustomArgumentResolvers
(List<HandlerMethodArgumentResolver> customArgumentResolvers) Sets the list of customHandlerMethodArgumentResolver
s that will be used after resolvers for supported argument type.void
AbstractMethodMessageHandler.setCustomReturnValueHandlers
(List<HandlerMethodReturnValueHandler> customReturnValueHandlers) Set the list of customHandlerMethodReturnValueHandler
s that will be used after return value handlers for known types.void
AbstractMethodMessageHandler.setDestinationPrefixes
(Collection<String> prefixes) When this property is configured only messages to destinations matching one of the configured prefixes are eligible for handling.void
AbstractMethodMessageHandler.setReturnValueHandlers
(List<HandlerMethodReturnValueHandler> returnValueHandlers) Configure the complete list of supported return value types, effectively overriding the ones configured by default.ModifierConstructorDescriptionMethodArgumentResolutionException
(Message<?> message, MethodParameter parameter, String description, Throwable cause) Create a new instance providing the invalidMethodParameter
, prepared description, and a cause. -
Uses of Nullable in org.springframework.messaging.handler.invocation.reactive
Modifier and TypeMethodDescriptionAbstractMethodMessageHandler.getApplicationContext()
HandlerMethodArgumentResolverComposite.getArgumentResolver
(MethodParameter parameter) Find a registeredHandlerMethodArgumentResolver
that supports the given method parameter.protected abstract RouteMatcher.Route
AbstractMethodMessageHandler.getDestination
(Message<?> message) Extract the destination from the given message.AbstractMethodMessageHandler.getHandlerPredicate()
Return theconfigured
handler predicate.protected abstract T
AbstractMethodMessageHandler.getMappingForMethod
(Method method, Class<?> handlerType) Obtain the mapping for the given method, if any.protected abstract T
AbstractMethodMessageHandler.getMatchingMapping
(T mapping, Message<?> message) Check if a mapping matches the current message and return a possibly new mapping with conditions relevant to the current request.SyncHandlerMethodArgumentResolver.resolveArgumentValue
(MethodParameter parameter, Message<?> message) Resolve the value for the method parameter synchronously.Modifier and TypeMethodDescriptionHandlerMethodReturnValueHandlerComposite.addHandlers
(List<? extends HandlerMethodReturnValueHandler> handlers) Add the givenHandlerMethodReturnValueHandlers
.HandlerMethodArgumentResolverComposite.addResolvers
(List<? extends HandlerMethodArgumentResolver> resolvers) Add the givenHandlerMethodArgumentResolvers
.HandlerMethodArgumentResolverComposite.addResolvers
(HandlerMethodArgumentResolver... resolvers) Add the givenHandlerMethodArgumentResolvers
.protected void
AbstractMethodMessageHandler.handleNoMatch
(RouteMatcher.Route destination, Message<?> message) Invoked when no matching handler is found.reactor.core.publisher.Mono<Void>
AbstractEncoderMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, Message<?> message) reactor.core.publisher.Mono<Void>
HandlerMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, Message<?> message) Handle the given return value.reactor.core.publisher.Mono<Void>
HandlerMethodReturnValueHandlerComposite.handleReturnValue
(Object returnValue, MethodParameter returnType, Message<?> message) void
AbstractMethodMessageHandler.setApplicationContext
(ApplicationContext applicationContext) void
AbstractMethodMessageHandler.setHandlerPredicate
(Predicate<Class<?>> handlerPredicate) Configure a predicate for selecting which Spring beans to check for the presence of message handler methods. -
Uses of Nullable in org.springframework.messaging.rsocket
Modifier and TypeMethodDescriptionRSocketRequester.rsocket()
Return the underlyingRSocket
if the requester was created with a "live" RSocket viaRSocketRequester.wrap(RSocket, MimeType, MimeType, RSocketStrategies)
or via one of the (deprecated) connect methods on theRSocketRequester
builder, or otherwise returnnull
.Modifier and TypeMethodDescriptionRSocketStrategies.Builder.dataBufferFactory
(DataBufferFactory bufferFactory) Configure the DataBufferFactory to use for allocating buffers when preparing requests or creating responses.RSocketRequester.Builder.dataMimeType
(MimeType mimeType) Configure the payload data MimeType to specify on theSETUP
frame that applies to the whole connection.default <T> Decoder<T>
RSocketStrategies.decoder
(ResolvableType elementType, MimeType mimeType) Find a compatible Decoder for the given element type.default <T> Encoder<T>
RSocketStrategies.encoder
(ResolvableType elementType, MimeType mimeType) Find a compatible Encoder for the given element type.Begin to specify a new request with the given metadata value, which can be a concrete value or any producer of a single value that can be adapted to aPublisher
viaReactiveAdapterRegistry
.RSocketStrategies.Builder.metadataExtractor
(MetadataExtractor metadataExtractor) Configure aMetadataExtractor
to extract the route along with other metadata.default void
MetadataExtractorRegistry.metadataToExtract
(MimeType mimeType, Class<?> targetType, String name) Decode metadata entries with the givenMimeType
to the specified target class, and store the decoded value in the output map under the given name.default void
MetadataExtractorRegistry.metadataToExtract
(MimeType mimeType, ParameterizedTypeReference<?> targetType, String name) Variant ofMetadataExtractorRegistry.metadataToExtract(MimeType, Class, String)
that acceptsParameterizedTypeReference
instead ofClass
for specifying a target type with generic parameters.RSocketStrategies.Builder.reactiveAdapterStrategy
(ReactiveAdapterRegistry registry) Configure the registry for reactive type support.RSocketStrategies.Builder.routeMatcher
(RouteMatcher routeMatcher) Configure aRouteMatcher
for matching routes to message handlers based on route patterns.RSocketRequester.Builder.rsocketStrategies
(RSocketStrategies strategies) Provide theRSocketStrategies
to use.RSocketRequester.Builder.setupMetadata
(Object value, MimeType mimeType) Add metadata entry to the setup payload. -
Uses of Nullable in org.springframework.messaging.rsocket.annotation.support
Modifier and TypeMethodDescriptionprotected CompositeMessageCondition
RSocketMessageHandler.getCondition
(AnnotatedElement element) RSocketMessageHandler.getDefaultDataMimeType()
Return the configureddefaultDataMimeType
, ornull
.static FrameType
RSocketFrameTypeMessageCondition.getFrameType
(Message<?> message) Find the RSocket frame type in the message headers.Modifier and TypeMethodDescriptionprotected void
RSocketMessageHandler.handleNoMatch
(RouteMatcher.Route destination, Message<?> message) void
RSocketMessageHandler.setDefaultDataMimeType
(MimeType mimeType) Configure the default content type to use for data payloads if theSETUP
frame did not specify one.void
RSocketMessageHandler.setRouteMatcher
(RouteMatcher routeMatcher) Set theRouteMatcher
to use for mapping messages to handlers based on the route patterns they're configured with. -
Uses of Nullable in org.springframework.messaging.rsocket.service
Modifier and TypeMethodDescriptionPublisher<?>
RSocketRequestValues.getPayload()
Return the request payload as a Publisher.RSocketRequestValues.getPayloadElementType()
Return the element type for a Publisher payload.RSocketRequestValues.getPayloadValue()
Return the request payload as a value to be serialized, if set.RSocketRequestValues.getRoute()
Return the route value forroute
.Modifier and TypeMethodDescriptionRSocketServiceProxyFactory.Builder.blockTimeout
(Duration blockTimeout) Configure how long to block for the response of an RSocket service method with a synchronous (blocking) method signature.static RSocketRequestValues.Builder
boolean
DestinationVariableArgumentResolver.resolve
(Object argument, MethodParameter parameter, RSocketRequestValues.Builder requestValues) boolean
MetadataArgumentResolver.resolve
(Object argument, MethodParameter parameter, RSocketRequestValues.Builder requestValues) boolean
PayloadArgumentResolver.resolve
(Object argument, MethodParameter parameter, RSocketRequestValues.Builder requestValues) boolean
RSocketServiceArgumentResolver.resolve
(Object argument, MethodParameter parameter, RSocketRequestValues.Builder requestValues) Resolve the argument value.ModifierConstructorDescriptionRSocketRequestValues
(String route, List<Object> routeVariables, org.springframework.messaging.rsocket.service.RSocketRequestValues.MetadataHelper metadataHelper, Object payloadValue, Publisher<?> payload, ParameterizedTypeReference<?> payloadElementType) RSocketRequestValues
(String route, List<Object> routeVariables, org.springframework.messaging.rsocket.service.RSocketRequestValues.MetadataHelper metadataHelper, Object payloadValue, Publisher<?> payload, ParameterizedTypeReference<?> payloadElementType) RSocketRequestValues
(String route, List<Object> routeVariables, org.springframework.messaging.rsocket.service.RSocketRequestValues.MetadataHelper metadataHelper, Object payloadValue, Publisher<?> payload, ParameterizedTypeReference<?> payloadElementType) RSocketRequestValues
(String route, List<Object> routeVariables, org.springframework.messaging.rsocket.service.RSocketRequestValues.MetadataHelper metadataHelper, Object payloadValue, Publisher<?> payload, ParameterizedTypeReference<?> payloadElementType) RSocketRequestValues
(String route, List<Object> routeVariables, org.springframework.messaging.rsocket.service.RSocketRequestValues.MetadataHelper metadataHelper, Object payloadValue, Publisher<?> payload, ParameterizedTypeReference<?> payloadElementType) RSocketRequestValues
(String route, List<Object> routeVariables, org.springframework.messaging.rsocket.service.RSocketRequestValues.MetadataHelper metadataHelper, Object payloadValue, Publisher<?> payload, ParameterizedTypeReference<?> payloadElementType) -
Uses of Nullable in org.springframework.messaging.simp
Modifier and TypeMethodDescriptionSimpAttributes.getAttribute
(String name) Return the value for the attribute of the given name, if any.static SimpAttributes
SimpAttributesContextHolder.getAttributes()
Return the SimpAttributes currently bound to the thread.SimpMessageHeaderAccessor.getDestination()
static String
SimpMessageHeaderAccessor.getDestination
(Map<String, Object> headers) SimpMessagingTemplate.getHeaderInitializer()
Return the configured header initializer.static long[]
SimpMessageHeaderAccessor.getHeartbeat
(Map<String, Object> headers) SimpMessageMappingInfo.getMatchingCondition
(Message<?> message) SimpMessageTypeMessageCondition.getMatchingCondition
(Message<?> message) SimpMessageHeaderAccessor.getMessageType()
static SimpMessageType
SimpMessageHeaderAccessor.getMessageType
(Map<String, Object> headers) SimpMessageHeaderAccessor.getSessionAttributes()
Return the attributes associated with the current session.SimpMessageHeaderAccessor.getSessionAttributes
(Map<String, Object> headers) SimpMessageHeaderAccessor.getSessionId()
Return the id of the current session.static String
SimpMessageHeaderAccessor.getSessionId
(Map<String, Object> headers) SimpMessageHeaderAccessor.getSubscriptionId()
static String
SimpMessageHeaderAccessor.getSubscriptionId
(Map<String, Object> headers) SimpMessageHeaderAccessor.getUser()
Return the user associated with the current session.static Principal
SimpSessionScope.resolveContextualObject
(String key) Modifier and TypeMethodDescriptionvoid
SimpMessageSendingOperations.convertAndSendToUser
(String user, String destination, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) Send a message to the given user.void
SimpMessageSendingOperations.convertAndSendToUser
(String user, String destination, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) Send a message to the given user.void
SimpMessagingTemplate.convertAndSendToUser
(String user, String destination, Object payload, Map<String, Object> headers) void
SimpMessagingTemplate.convertAndSendToUser
(String user, String destination, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) void
SimpMessagingTemplate.convertAndSendToUser
(String user, String destination, Object payload, Map<String, Object> headers, MessagePostProcessor postProcessor) void
SimpMessagingTemplate.convertAndSendToUser
(String user, String destination, Object payload, MessagePostProcessor postProcessor) boolean
SimpMessageHeaderAccessor.getDetailedLogMessage
(Object payload) SimpMessagingTemplate.processHeadersToSend
(Map<String, Object> headers) Creates a new map and puts the given headers under the keyNATIVE_HEADERS NATIVE_HEADERS NATIVE_HEADERS
.static void
SimpAttributesContextHolder.setAttributes
(SimpAttributes attributes) Bind the given SimpAttributes to the current thread.void
SimpMessageHeaderAccessor.setDestination
(String destination) void
SimpMessagingTemplate.setHeaderInitializer
(MessageHeaderInitializer headerInitializer) Configure aMessageHeaderInitializer
to apply to the headers of all messages created through theSimpMessagingTemplate
.void
SimpMessageHeaderAccessor.setSessionAttributes
(Map<String, Object> attributes) A static alternative for access to the session attributes header.void
SimpMessageHeaderAccessor.setSessionId
(String sessionId) void
SimpMessageHeaderAccessor.setSubscriptionId
(String subscriptionId) void
ModifierConstructorDescriptionprotected
SimpMessageHeaderAccessor
(SimpMessageType messageType, Map<String, List<String>> externalSourceHeaders) A constructor for creating new message headers. -
Uses of Nullable in org.springframework.messaging.simp.annotation.support
Modifier and TypeMethodDescriptionprotected String
SimpAnnotationMethodMessageHandler.getDestination
(Message<?> message) SendToMethodReturnValueHandler.getHeaderInitializer()
Return the configured header initializer.SimpAnnotationMethodMessageHandler.getHeaderInitializer()
Return the configured header initializer.SubscriptionMethodReturnValueHandler.getHeaderInitializer()
Return the configured header initializer.protected SimpMessageMappingInfo
SimpAnnotationMethodMessageHandler.getMappingForMethod
(Method method, Class<?> handlerType) protected SimpMessageMappingInfo
SimpAnnotationMethodMessageHandler.getMatchingMapping
(SimpMessageMappingInfo mapping, Message<?> message) protected String
SendToMethodReturnValueHandler.getUserName
(Message<?> message, MessageHeaders headers) SimpAnnotationMethodMessageHandler.getValidator()
Return the configured Validator instance.Modifier and TypeMethodDescriptionprotected String
SimpAnnotationMethodMessageHandler.getLookupDestination
(String destination) protected String[]
SendToMethodReturnValueHandler.getTargetDestinations
(Annotation annotation, Message<?> message, String defaultPrefix) void
SendToMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, Message<?> message) void
SubscriptionMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, Message<?> message) void
SimpAnnotationMethodMessageHandler.setDestinationPrefixes
(Collection<String> prefixes) When this property is configured only messages to destinations matching one of the configured prefixes are eligible for handling.void
SendToMethodReturnValueHandler.setHeaderInitializer
(MessageHeaderInitializer headerInitializer) Configure aMessageHeaderInitializer
to apply to the headers of all messages sent to the client outbound channel.void
SimpAnnotationMethodMessageHandler.setHeaderInitializer
(MessageHeaderInitializer headerInitializer) Configure aMessageHeaderInitializer
to pass on toHandlerMethodReturnValueHandlers
that send messages from controller return values.void
SubscriptionMethodReturnValueHandler.setHeaderInitializer
(MessageHeaderInitializer headerInitializer) Configure aMessageHeaderInitializer
to apply to the headers of all messages sent to the client outbound channel.void
SimpAnnotationMethodMessageHandler.setValidator
(Validator validator) Set the Validator instance used for validating@Payload
arguments. -
Uses of Nullable in org.springframework.messaging.simp.broker
Modifier and TypeMethodDescriptionAbstractBrokerMessageHandler.getApplicationEventPublisher()
SimpleBrokerMessageHandler.getHeaderInitializer()
Return the configured header initializer.long[]
SimpleBrokerMessageHandler.getHeartbeatValue()
The configured value for the heart-beat settings.static Runnable
OrderedMessageChannelDecorator.getNextMessageTask
(Message<?> message) Obtain the task to release the next message, if found.DefaultSubscriptionRegistry.getSelectorHeaderName()
Return the name of the selector header.SimpleBrokerMessageHandler.getTaskScheduler()
Return the configured TaskScheduler.Modifier and TypeMethodDescriptionprotected boolean
AbstractBrokerMessageHandler.checkDestinationPrefix
(String destination) Whether a message with the given destination should be processed.protected void
SimpleBrokerMessageHandler.sendMessageToSubscribers
(String destination, Message<?> message) void
AbstractBrokerMessageHandler.setApplicationEventPublisher
(ApplicationEventPublisher publisher) void
SimpleBrokerMessageHandler.setCacheLimit
(Integer cacheLimit) When configured, the specified cache limit is passed down to the underlying SubscriptionRegistry, overriding any default there.void
SimpleBrokerMessageHandler.setHeaderInitializer
(MessageHeaderInitializer headerInitializer) Configure aMessageHeaderInitializer
to apply to the headers of all messages sent to the client outbound channel.void
SimpleBrokerMessageHandler.setHeartbeatValue
(long[] heartbeat) Configure the value for the heart-beat settings.void
SimpleBrokerMessageHandler.setPathMatcher
(PathMatcher pathMatcher) When configured, the given PathMatcher is passed down to the underlying SubscriptionRegistry to use for matching destination to subscriptions.void
DefaultSubscriptionRegistry.setSelectorHeaderName
(String selectorHeaderName) Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription.void
SimpleBrokerMessageHandler.setSelectorHeaderName
(String selectorHeaderName) Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription.void
SimpleBrokerMessageHandler.setTaskScheduler
(TaskScheduler taskScheduler) Configure theTaskScheduler
to use for providing heartbeat support.void
AbstractBrokerMessageHandler.setUserDestinationPredicate
(Predicate<String> predicate) Configure a Predicate to identify messages with a user destination.ModifierConstructorDescriptionAbstractBrokerMessageHandler
(SubscribableChannel inboundChannel, MessageChannel outboundChannel, SubscribableChannel brokerChannel, Collection<String> destinationPrefixes) Constructor with destination prefixes to match to destinations of messages. -
Uses of Nullable in org.springframework.messaging.simp.config
Modifier and TypeMethodDescriptionAbstractMessageBrokerConfiguration.getApplicationContext()
protected Collection<String>
MessageBrokerRegistry.getApplicationDestinationPrefixes()
final PathMatcher
AbstractMessageBrokerConfiguration.getPathMatcher
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) Provide access to the configured PatchMatcher for access from other configuration classes.protected PathMatcher
MessageBrokerRegistry.getPathMatcher()
protected SimpleBrokerMessageHandler
MessageBrokerRegistry.getSimpleBroker
(SubscribableChannel brokerChannel) protected StompBrokerRelayMessageHandler
MessageBrokerRegistry.getStompBrokerRelay
(SubscribableChannel brokerChannel) protected String
MessageBrokerRegistry.getUserDestinationBroadcast()
protected String
StompBrokerRelayRegistration.getUserDestinationBroadcast()
protected String
MessageBrokerRegistry.getUserDestinationPrefix()
protected String
MessageBrokerRegistry.getUserRegistryBroadcast()
protected String
StompBrokerRelayRegistration.getUserRegistryBroadcast()
protected Integer
MessageBrokerRegistry.getUserRegistryOrder()
AbstractMessageBrokerConfiguration.getValidator()
Override this method to provide a customValidator
.AbstractMessageBrokerConfiguration.simpleBrokerMessageHandler
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver) AbstractMessageBrokerConfiguration.stompBrokerRelayMessageHandler
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationMessageHandler userDestinationMessageHandler, MessageHandler userRegistryMessageHandler, UserDestinationResolver userDestinationResolver) AbstractMessageBrokerConfiguration.userRegistryMessageHandler
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpUserRegistry userRegistry, SimpMessagingTemplate brokerMessagingTemplate, TaskScheduler scheduler) Modifier and TypeMethodDescriptionprotected abstract SimpUserRegistry
AbstractMessageBrokerConfiguration.createLocalUserRegistry
(Integer order) Create the user registry that provides access to local users.void
AbstractMessageBrokerConfiguration.setApplicationContext
(ApplicationContext applicationContext) void
SimpleBrokerRegistration.setSelectorHeaderName
(String selectorHeaderName) Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription.StompBrokerRelayRegistration.setTaskScheduler
(TaskScheduler taskScheduler) Some STOMP clients (e.g.AbstractMessageBrokerConfiguration.stompBrokerRelayMessageHandler
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationMessageHandler userDestinationMessageHandler, MessageHandler userRegistryMessageHandler, UserDestinationResolver userDestinationResolver) ChannelRegistration.taskExecutor
(ThreadPoolTaskExecutor taskExecutor) Configure the thread pool backing this message channel using a custom ThreadPoolTaskExecutor.ModifierConstructorDescriptionAbstractBrokerRegistration
(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, String[] destinationPrefixes) Create a new broker registration. -
Uses of Nullable in org.springframework.messaging.simp.stomp
Modifier and TypeMethodDescriptionString[]
StompHeaders.getAcceptVersion()
Get the accept-version header.StompHeaderAccessor.getAck()
StompHeaders.getAck()
Get the ack header.StompHeaderAccessor.getCommand()
Return the STOMP command, ornull
if not yet set.static StompCommand
StompHeaderAccessor.getCommand
(Map<String, Object> headers) Return the STOMP command from the given headers, ornull
if not set.StompHeaderAccessor.getContentLength()
static Integer
StompHeaderAccessor.getContentLength
(Map<String, List<String>> nativeHeaders) StompHeaders.getContentType()
Return the content-type header value.StompHeaders.getDestination()
Get the destination header.BufferingStompDecoder.getExpectedContentLength()
Get the expected content length of the currently buffered, incomplete STOMP frame.Return the first header value for the given header name, if any.StompBrokerRelayMessageHandler.getHeaderInitializer()
Return the configured header initializer.StompDecoder.getHeaderInitializer()
Return the configuredMessageHeaderInitializer
, if any.long[]
StompHeaders.getHeartbeat()
Get the heartbeat header.StompHeaderAccessor.getHost()
StompHeaders.getHost()
Get the host header.StompHeaders.getId()
Get the id header.StompHeaderAccessor.getLogin()
StompHeaders.getLogin()
Get the login header.StompHeaderAccessor.getMessage()
StompHeaderAccessor.getMessageId()
StompHeaders.getMessageId()
Get the message-id header.StompHeaderAccessor.getNack()
StompHeaderAccessor.getNativeHeaders()
StompHeaderAccessor.getPasscode()
Return the passcode header value, ornull
if not set.static String
StompHeaderAccessor.getPasscode
(Map<String, Object> headers) Return the passcode header value, ornull
if not set.StompHeaders.getPasscode()
Get the passcode header.StompHeaderAccessor.getReceipt()
StompHeaders.getReceipt()
Get the receipt header.StompHeaderAccessor.getReceiptId()
StompHeaders.getReceiptId()
Get the receipt header.StompSession.Receiptable.getReceiptId()
Return the receipt id, ornull
if the STOMP frame for which the handle was returned did not have a "receipt" header.StompHeaders.getServer()
Get the server header.StompHeaders.getSession()
Get the session header.StompHeaders.getSubscription()
Get the subscription header.StompSession.Subscription.getSubscriptionId()
Return the id for the subscription.DefaultStompSession.getTaskScheduler()
Return the configured TaskScheduler to use for receipt tracking.StompBrokerRelayMessageHandler.getTaskScheduler()
StompClientSupport.getTaskScheduler()
The configured TaskScheduler.TcpOperations<byte[]>
StompBrokerRelayMessageHandler.getTcpClient()
Get the configured TCP client (nevernull
unless not configured invoked and this method is invoked before the handler is started and hence a default implementation initialized).StompHeaderAccessor.getVersion()
StompBrokerRelayMessageHandler.getVirtualHost()
Return the configured virtual host value.Modifier and TypeMethodDescriptionvoid
Add the given, single header value under the given name.ReactorNettyTcpStompClient.connect
(StompHeaders connectHeaders, StompSessionHandler handler) Deprecated.as of 6.0, in favor ofReactorNettyTcpStompClient.connectAsync(StompHeaders, StompSessionHandler)
ReactorNettyTcpStompClient.connectAsync
(StompHeaders connectHeaders, StompSessionHandler handler) An overloaded version ofReactorNettyTcpStompClient.connectAsync(StompSessionHandler)
that accepts headers to use for the STOMP CONNECT frame.protected ConnectionHandlingStompSession
StompClientSupport.createSession
(StompHeaders connectHeaders, StompSessionHandler handler) Factory method for create and configure a new session.StompDecoder.decode
(ByteBuffer byteBuffer, MultiValueMap<String, String> partialMessageHeaders) Decodes one or more STOMP frames from the givenbuffer
and returns a list ofMessages
.void
DefaultStompSession.disconnect
(StompHeaders headers) boolean
StompHeaderAccessor.getDetailedLogMessage
(Object payload) void
StompSessionHandler.handleException
(StompSession session, StompCommand command, StompHeaders headers, byte[] payload, Throwable exception) Handle any exception arising while processing a STOMP frame such as a failure to convert the payload or an unhandled exception in the applicationStompFrameHandler
.void
StompSessionHandlerAdapter.handleException
(StompSession session, StompCommand command, StompHeaders headers, byte[] payload, Throwable exception) This implementation is empty.void
StompFrameHandler.handleFrame
(StompHeaders headers, Object payload) Handle a STOMP frame with the payload converted to the target type returned fromStompFrameHandler.getPayloadType(StompHeaders)
.void
StompSessionHandlerAdapter.handleFrame
(StompHeaders headers, Object payload) This implementation is empty.protected StompHeaders
StompClientSupport.processConnectHeaders
(StompHeaders connectHeaders) Further initialize the StompHeaders, for example setting the heart-beat header if necessary.static StompHeaders
StompHeaders.readOnlyStompHeaders
(Map<String, List<String>> headers) Return aStompHeaders
object that can only be read, not written to.void
Set the given, single header value under the given name.void
StompHeaders.setAcceptVersion
(String... acceptVersions) Set the accept-version header.void
void
Set the ack header to one of "auto", "client", or "client-individual".void
StompHeaders.setContentType
(MimeType mimeType) Set the content-type header.void
StompHeaderAccessor.setDestination
(String destination) void
StompHeaders.setDestination
(String destination) Set the destination header.void
StompBrokerRelayMessageHandler.setHeaderInitializer
(MessageHeaderInitializer headerInitializer) Configure aMessageHeaderInitializer
to apply to the headers of all messages created through theStompBrokerRelayMessageHandler
that are sent to the client outbound message channel.void
StompDecoder.setHeaderInitializer
(MessageHeaderInitializer headerInitializer) Configure aMessageHeaderInitializer
to apply to the headers ofMessages
from decoded STOMP frames.void
StompHeaders.setHeartbeat
(long[] heartbeat) Set the heartbeat header.void
void
Set the host header.void
Set the id header.void
void
Set the login header.void
StompHeaderAccessor.setMessage
(String content) void
StompHeaderAccessor.setMessageId
(String id) void
StompHeaders.setMessageId
(String messageId) Set the message-id header.void
void
StompHeaderAccessor.setPasscode
(String passcode) void
StompHeaders.setPasscode
(String passcode) Set the passcode header.void
StompHeaderAccessor.setReceipt
(String receiptId) void
StompHeaders.setReceipt
(String receipt) Set the receipt header.void
StompHeaderAccessor.setReceiptId
(String receiptId) void
StompHeaders.setReceiptId
(String receiptId) Set the receipt-id header.void
Set the server header.void
StompHeaders.setSession
(String session) Set the session header.void
StompHeaders.setSubscription
(String subscription) Set the login header.void
StompHeaderAccessor.setSubscriptionId
(String subscriptionId) void
StompBrokerRelayMessageHandler.setSystemSubscriptions
(Map<String, MessageHandler> subscriptions) Configure one more destinations to subscribe to on the shared "system" connection along with MessageHandler's to handle received messages.void
DefaultStompSession.setTaskScheduler
(TaskScheduler taskScheduler) Configure the TaskScheduler to use for receipt tracking.void
StompBrokerRelayMessageHandler.setTaskScheduler
(TaskScheduler taskScheduler) Configure theTaskScheduler
to use to reset client-to-broker message count in the current heartbeat period.void
StompClientSupport.setTaskScheduler
(TaskScheduler taskScheduler) Configure a scheduler to use for heartbeats and for receipt tracking.void
StompBrokerRelayMessageHandler.setTcpClient
(TcpOperations<byte[]> tcpClient) Configure a TCP client for managing TCP connections to the STOMP broker.void
StompHeaderAccessor.setVersion
(String version) void
StompBrokerRelayMessageHandler.setVirtualHost
(String virtualHost) Set the value of the "host" header to use in STOMP CONNECT frames.void
StompSession.Subscription.unsubscribe
(StompHeaders headers) Alternative toStompSession.Subscription.unsubscribe()
with additional custom headers to send to the server. -
Uses of Nullable in org.springframework.messaging.simp.user
Modifier and TypeMethodDescriptionUserDestinationMessageHandler.getBroadcastDestination()
Return the configured destination for unresolved messages.UserDestinationMessageHandler.getHeaderInitializer()
Return the configured header initializer.SimpUser.getPrincipal()
Return the user associated with the session, if available.SimpUser.getSession
(String sessionId) Look up the session for the given id.protected String
DefaultUserDestinationResolver.getTargetDestination
(String sourceDestination, String actualDestination, String sessionId, String user) This method determines how to translate the source "user" destination to an actual target destination for the given active user session.Get the user for the given name.UserDestinationResult.getUser()
The user for this user destination.DefaultUserDestinationResolver.resolveDestination
(Message<?> message) UserDestinationResolver.resolveDestination
(Message<?> message) Resolve the given message with a user destination to one or more messages with actual destinations, one for each active user session.Modifier and TypeMethodDescriptionprotected String
DefaultUserDestinationResolver.getTargetDestination
(String sourceDestination, String actualDestination, String sessionId, String user) This method determines how to translate the source "user" destination to an actual target destination for the given active user session.void
UserDestinationMessageHandler.setBroadcastDestination
(String destination) Set a destination to broadcast messages to that remain unresolved because the user is not connected.void
UserDestinationMessageHandler.setHeaderInitializer
(MessageHeaderInitializer headerInitializer) Configure a customMessageHeaderInitializer
to initialize the headers of resolved target messages.boolean
MultiServerUserRegistry.supportsSourceType
(Class<?> sourceType) -
Uses of Nullable in org.springframework.messaging.support
Modifier and TypeMethodDescriptionMessage<?>
AbstractMessageChannel.ChannelInterceptorChain.applyPostReceive
(Message<?> message, MessageChannel channel) Message<?>
AbstractMessageChannel.ChannelInterceptorChain.applyPreSend
(Message<?> message, MessageChannel channel) default Message<?>
ExecutorChannelInterceptor.beforeHandle
(Message<?> message, MessageChannel channel, MessageHandler handler) Invoked inside theRunnable
submitted to the Executor just before calling the target MessageHandler to handle the message.static MessageHeaderAccessor
MessageHeaderAccessor.getAccessor
(Message<?> message) Return the originalMessageHeaderAccessor
used to create the headers of the givenMessage
, ornull
if that's not available or if its type does not match the required type.static <T extends MessageHeaderAccessor>
TMessageHeaderAccessor.getAccessor
(Message<?> message, Class<T> requiredType) Return the originalMessageHeaderAccessor
used to create the headers of the givenMessage
, ornull
if that's not available or if its type does not match the required type.static <T extends MessageHeaderAccessor>
TMessageHeaderAccessor.getAccessor
(MessageHeaders messageHeaders, Class<T> requiredType) A variation ofMessageHeaderAccessor.getAccessor(org.springframework.messaging.Message, Class)
with aMessageHeaders
instance instead of aMessage
.MessageHeaderAccessor.getContentType()
MessageHeaderAccessor.getErrorChannel()
ExecutorSubscribableChannel.getExecutor()
NativeMessageHeaderAccessor.getFirstNativeHeader
(String headerName) Return the first value for the specified native header, if present.static String
NativeMessageHeaderAccessor.getFirstNativeHeader
(String headerName, Map<String, Object> headers) Return the first value for the specified native header, ornull
if none.Retrieve the value for the header with the given name.protected <V> V
Return the header value, ornull
if it does not exist or does not match the requestedtype
.MessageHeaderAccessor.getId()
IdTimestampMessageHeaderInitializer.getIdGenerator()
Return the configuredIdGenerator
, if any.NativeMessageHeaderAccessor.getNativeHeader
(String headerName) Return all values for the specified native header, if present.NativeMessageHeaderAccessor.getNativeHeaders()
Subclasses can use this method to access the "native" headers sub-map.Message<?>
ErrorMessage.getOriginalMessage()
Return the original message (if available) at the point in the stack where the ErrorMessage was created.MessageHeaderAccessor.getReplyChannel()
MessageHeaderAccessor.getTimestamp()
default Message<?>
ChannelInterceptor.postReceive
(Message<?> message, MessageChannel channel) Invoked immediately after a Message has been retrieved but before it is returned to the caller.default Message<?>
ChannelInterceptor.preSend
(Message<?> message, MessageChannel channel) Invoked before the Message is actually sent to the channel.NativeMessageHeaderAccessor.removeNativeHeader
(String headerName) Remove the specified native header value replacing existing values.Modifier and TypeMethodDescriptionvoid
NativeMessageHeaderAccessor.addNativeHeader
(String name, String value) Add the specified native header value to existing values.void
NativeMessageHeaderAccessor.addNativeHeaders
(MultiValueMap<String, String> headers) Add the specified native headers to existing values.default void
ExecutorChannelInterceptor.afterMessageHandled
(Message<?> message, MessageChannel channel, MessageHandler handler, Exception ex) Invoked inside theRunnable
submitted to the Executor after calling the target MessageHandler regardless of the outcome (i.e.default void
ChannelInterceptor.afterReceiveCompletion
(Message<?> message, MessageChannel channel, Exception ex) Invoked after the completion of a receive regardless of any exception that have been raised thus allowing for proper resource cleanup.default void
ChannelInterceptor.afterReceiveCompletion
(Message<?> message, MessageChannel channel, Exception ex) Invoked after the completion of a receive regardless of any exception that have been raised thus allowing for proper resource cleanup.default void
ChannelInterceptor.afterSendCompletion
(Message<?> message, MessageChannel channel, boolean sent, Exception ex) Invoked after the completion of a send regardless of any exception that have been raised thus allowing for proper resource cleanup.MessageBuilder.copyHeaders
(Map<String, ?> headersToCopy) Copy the name-value pairs from the provided Map.void
MessageHeaderAccessor.copyHeaders
(Map<String, ?> headersToCopy) Copy the name-value pairs from the provided Map.void
NativeMessageHeaderAccessor.copyHeaders
(Map<String, ?> headersToCopy) MessageBuilder.copyHeadersIfAbsent
(Map<String, ?> headersToCopy) Copy the name-value pairs from the provided Map.void
MessageHeaderAccessor.copyHeadersIfAbsent
(Map<String, ?> headersToCopy) Copy the name-value pairs from the provided Map.void
NativeMessageHeaderAccessor.copyHeadersIfAbsent
(Map<String, ?> headersToCopy) static <T> Message<T>
MessageBuilder.createMessage
(T payload, MessageHeaders messageHeaders) A shortcut factory method for creating a message with the given payload andMessageHeaders
.boolean
static <T extends MessageHeaderAccessor>
TMessageHeaderAccessor.getAccessor
(Message<?> message, Class<T> requiredType) Return the originalMessageHeaderAccessor
used to create the headers of the givenMessage
, ornull
if that's not available or if its type does not match the required type.static <T extends MessageHeaderAccessor>
TMessageHeaderAccessor.getAccessor
(MessageHeaders messageHeaders, Class<T> requiredType) A variation ofMessageHeaderAccessor.getAccessor(org.springframework.messaging.Message, Class)
with aMessageHeaders
instance instead of aMessage
.MessageHeaderAccessor.getDetailedLogMessage
(Object payload) Return a more detailed message for logging purposes.protected String
MessageHeaderAccessor.getDetailedPayloadLogMessage
(Object payload) Set the value for the given header name.void
Set the value for the given header name.void
IdTimestampMessageHeaderInitializer.setIdGenerator
(IdGenerator idGenerator) Configure the IdGenerator strategy to initializeMessageHeaderAccessor
instances with.void
AbstractHeaderMapper.setInboundPrefix
(String inboundPrefix) Specify a prefix to be appended to the message header name for any user-defined property that is being mapped into the MessageHeaders.void
NativeMessageHeaderAccessor.setNativeHeader
(String name, String value) Set the specified native header value replacing existing values.void
NativeMessageHeaderAccessor.setNativeHeaderValues
(String name, List<String> values) Variant ofNativeMessageHeaderAccessor.addNativeHeader(String, String)
for all values.void
AbstractHeaderMapper.setOutboundPrefix
(String outboundPrefix) Specify a prefix to be appended to the protocol property name for any user-defined message header that is being mapped into the protocol-specific Message.void
AbstractMessageChannel.ChannelInterceptorChain.triggerAfterReceiveCompletion
(Message<?> message, MessageChannel channel, Exception ex) void
AbstractMessageChannel.ChannelInterceptorChain.triggerAfterReceiveCompletion
(Message<?> message, MessageChannel channel, Exception ex) void
AbstractMessageChannel.ChannelInterceptorChain.triggerAfterSendCompletion
(Message<?> message, MessageChannel channel, boolean sent, Exception ex) protected void
MessageHeaderAccessor.verifyType
(String headerName, Object headerValue) protected void
MessageHeaderAccessor.verifyType
(String headerName, Object headerValue) ModifierConstructorDescriptionExecutorSubscribableChannel
(Executor executor) Create a newExecutorSubscribableChannel
instance where messages will be sent via the specified executor.MessageHeaderAccessor
(Message<?> message) A constructor accepting the headers of an existing message to copy.protected
NativeMessageHeaderAccessor
(Map<String, List<String>> nativeHeaders) Protected constructor to create an instance with the given native headers.protected
NativeMessageHeaderAccessor
(Message<?> message) Protected constructor that copies headers from another message. -
Uses of Nullable in org.springframework.messaging.tcp
Modifier and TypeMethodDescriptionReconnectStrategy.getTimeToNextAttempt
(int attemptCount) Return the time to the next attempt to reconnect. -
Uses of Nullable in org.springframework.mock.http.server.reactive
Modifier and TypeMethodDescriptionMockServerHttpRequest.getLocalAddress()
MockServerHttpRequest.getRemoteAddress()
protected SslInfo
MockServerHttpRequest.initSslInfo()
-
Uses of Nullable in org.springframework.mock.web
Modifier and TypeMethodDescriptionMockPageContext.findAttribute
(String name) MockHttpServletRequest.getAsyncContext()
MockPageContext.getAttribute
(String name) MockPageContext.getAttribute
(String name, int scope) MockServletContext.getAttribute
(String name) MockHttpServletRequest.getAuthType()
MockHttpServletRequest.getCharacterEncoding()
MockServletContext.getClassLoader()
MockSessionCookieConfig.getComment()
byte[]
MockHttpServletRequest.getContentAsByteArray()
Get the content of the request body as a byte array.MockHttpServletRequest.getContentAsString()
Get the content of the request body as aString
, using the configured character encoding.MockHttpServletRequest.getContentType()
MockHttpServletResponse.getContentType()
MockMultipartFile.getContentType()
MockPart.getContentType()
Cookie[]
MockHttpServletRequest.getCookies()
MockAsyncContext.getDispatchedPath()
MockSessionCookieConfig.getDomain()
MockPageContext.getELContext()
MockHttpServletResponse.getErrorMessage()
MockPageContext.getException()
MockCookie.getExpires()
Get the "Expires" attribute for this cookie.MockPageContext.getExpressionEvaluator()
Deprecated.MockServletContext.getFilterRegistration
(String filterName) This method always returnsnull
.MockHttpServletResponse.getForwardedUrl()
Return the primary value for the given header as a String, if any.MockHttpServletResponse.getHeaderValue
(String name) Return the primary value for the given header, if any.MockHttpServletResponse.getIncludedUrl()
MockHttpServletMapping.getMappingMatch()
MockHttpServletRequest.getMethod()
MockServletContext.getMimeType
(String filePath) MockSessionCookieConfig.getName()
MockHttpServletRequest.getParameter
(String name) MockSessionCookieConfig.getPath()
MockHttpServletRequest.getPathInfo()
MockHttpServletRequest.getPathTranslated()
MockHttpServletRequest.getQueryString()
MockServletContext.getRealPath
(String path) MockHttpServletResponse.getRedirectedUrl()
MockHttpServletRequest.getRemoteUser()
MockFilterChain.getRequest()
Return the request thatMockFilterChain.doFilter(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)
has been called with.MockServletContext.getRequestCharacterEncoding()
MockHttpServletRequest.getRequestedSessionId()
MockHttpServletRequest.getRequestURI()
MockServletContext.getResource
(String path) MockServletContext.getResourceAsStream
(String path) MockServletContext.getResourcePaths
(String path) MockAsyncContext.getResponse()
MockFilterChain.getResponse()
Return the response thatMockFilterChain.doFilter(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)
has been called with.MockServletContext.getResponseCharacterEncoding()
MockCookie.getSameSite()
Get the "SameSite" attribute for this cookie.MockServletContext.getServletRegistration
(String servletName) This method always returnsnull
.MockHttpServletRequest.getSession()
MockHttpServletRequest.getSession
(boolean create) MockPart.getSubmittedFileName()
MockHttpServletRequest.getUserPrincipal()
MockPageContext.getVariableResolver()
Deprecated.Modifier and TypeMethodDescriptionvoid
void
MockHttpServletRequest.addParameter
(String name, String value) Add a single value for the specified HTTP parameter.void
MockAsyncContext.dispatch
(ServletContext context, String path) void
MockHttpServletRequest.setAsyncContext
(MockAsyncContext asyncContext) void
MockCookie.setAttribute
(String name, String value) void
MockHttpServletRequest.setAttribute
(String name, Object value) void
MockHttpSession.setAttribute
(String name, Object value) void
MockPageContext.setAttribute
(String name, Object value) void
MockPageContext.setAttribute
(String name, Object value, int scope) void
MockServletContext.setAttribute
(String name, Object value) void
MockHttpServletRequest.setAuthType
(String authType) void
MockHttpServletRequest.setCharacterEncoding
(String characterEncoding) void
MockHttpServletResponse.setCharacterEncoding
(String characterEncoding) void
MockSessionCookieConfig.setComment
(String comment) void
MockHttpServletRequest.setContent
(byte[] content) Set the content of the request body as a byte array.void
MockHttpServletRequest.setContentType
(String contentType) void
MockHttpServletResponse.setContentType
(String contentType) void
MockHttpServletRequest.setCookies
(Cookie... cookies) void
void
MockCookie.setExpires
(ZonedDateTime expires) Set the "Expires" attribute for this cookie.void
MockHttpServletResponse.setForwardedUrl
(String forwardedUrl) void
void
MockHttpServletRequest.setHttpServletMapping
(HttpServletMapping httpServletMapping) void
MockHttpServletResponse.setIncludedUrl
(String includedUrl) void
void
void
void
void
MockHttpServletRequest.setPathInfo
(String pathInfo) void
MockHttpServletRequest.setQueryString
(String queryString) void
MockHttpServletRequest.setRemoteUser
(String remoteUser) void
MockServletContext.setRequestCharacterEncoding
(String requestCharacterEncoding) void
MockHttpServletRequest.setRequestedSessionId
(String requestedSessionId) void
MockHttpServletRequest.setRequestURI
(String requestURI) void
MockServletContext.setResponseCharacterEncoding
(String responseCharacterEncoding) void
MockCookie.setSameSite
(String sameSite) Set the "SameSite" attribute for this cookie.void
MockHttpServletRequest.setUserPrincipal
(Principal userPrincipal) MockHttpServletRequest.startAsync
(ServletRequest request, ServletResponse response) ModifierConstructorDescriptionMockAsyncContext
(ServletRequest request, ServletResponse response) MockBodyContent
(String content, HttpServletResponse response, Writer targetWriter) Create a MockBodyContent for the given response.MockBodyContent
(String content, HttpServletResponse response, Writer targetWriter) Create a MockBodyContent for the given response.MockFilterConfig
(ServletContext servletContext) Create a new MockFilterConfig.MockFilterConfig
(ServletContext servletContext, String filterName) Create a new MockFilterConfig.MockHttpServletMapping
(String matchValue, String pattern, String servletName, MappingMatch match) MockHttpServletRequest
(ServletContext servletContext) Create a newMockHttpServletRequest
with the suppliedServletContext
.MockHttpServletRequest
(ServletContext servletContext, String method, String requestURI) MockHttpServletRequest
(ServletContext servletContext, String method, String requestURI) MockHttpServletRequest
(ServletContext servletContext, String method, String requestURI) MockHttpServletRequest
(String method, String requestURI) Create a newMockHttpServletRequest
with a defaultMockServletContext
.MockHttpServletRequest
(String method, String requestURI) Create a newMockHttpServletRequest
with a defaultMockServletContext
.MockHttpSession
(ServletContext servletContext) Create a new MockHttpSession.MockHttpSession
(ServletContext servletContext, String id) Create a new MockHttpSession.MockHttpSession
(ServletContext servletContext, String id) Create a new MockHttpSession.MockJspWriter
(HttpServletResponse response, Writer targetWriter) Create a MockJspWriter for the given response.MockJspWriter
(HttpServletResponse response, Writer targetWriter) Create a MockJspWriter for the given response.MockMultipartFile
(String name, byte[] content) Create a new MockMultipartFile with the given content.MockMultipartFile
(String name, String originalFilename, String contentType, byte[] content) Create a new MockMultipartFile with the given content.MockMultipartFile
(String name, String originalFilename, String contentType, byte[] content) Create a new MockMultipartFile with the given content.MockMultipartFile
(String name, String originalFilename, String contentType, byte[] content) Create a new MockMultipartFile with the given content.MockMultipartFile
(String name, String originalFilename, String contentType, InputStream contentStream) Create a new MockMultipartFile with the given content.MockMultipartFile
(String name, String originalFilename, String contentType, InputStream contentStream) Create a new MockMultipartFile with the given content.MockMultipartHttpServletRequest
(ServletContext servletContext) Create a newMockMultipartHttpServletRequest
with the suppliedServletContext
.MockPageContext
(ServletContext servletContext) Create new MockPageContext with a defaultMockHttpServletRequest
,MockHttpServletResponse
,MockServletConfig
.MockPageContext
(ServletContext servletContext, HttpServletRequest request) Create new MockPageContext with a MockHttpServletResponse, MockServletConfig.MockPageContext
(ServletContext servletContext, HttpServletRequest request) Create new MockPageContext with a MockHttpServletResponse, MockServletConfig.MockPageContext
(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response) Create new MockPageContext with a MockServletConfig.MockPageContext
(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response) Create new MockPageContext with a MockServletConfig.MockPageContext
(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response) Create new MockPageContext with a MockServletConfig.MockPageContext
(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, ServletConfig servletConfig) Create new MockServletConfig.MockPageContext
(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, ServletConfig servletConfig) Create new MockServletConfig.MockPageContext
(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, ServletConfig servletConfig) Create new MockServletConfig.MockPageContext
(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, ServletConfig servletConfig) Create new MockServletConfig.Constructor for a part with byte[] content only.Constructor for a part with a filename and byte[] content.Constructor for a part with a filename and byte[] content.MockServletConfig
(ServletContext servletContext) Create a new MockServletConfig.MockServletConfig
(ServletContext servletContext, String servletName) Create a new MockServletConfig.MockServletContext
(String resourceBasePath, ResourceLoader resourceLoader) Create a newMockServletContext
using the supplied resource base path and resource loader.MockServletContext
(ResourceLoader resourceLoader) Create a newMockServletContext
, using the specifiedResourceLoader
and no base path. -
Uses of Nullable in org.springframework.mock.web.server
-
Uses of Nullable in org.springframework.orm
Modifier and TypeMethodDescriptionObjectOptimisticLockingFailureException.getIdentifier()
Return the identifier of the object for which the locking failed.ObjectRetrievalFailureException.getIdentifier()
Return the identifier of the object that was not found.Class<?>
ObjectOptimisticLockingFailureException.getPersistentClass()
Return the persistent class of the object for which the locking failed.Class<?>
ObjectRetrievalFailureException.getPersistentClass()
Return the persistent class of the object that was not found.ObjectOptimisticLockingFailureException.getPersistentClassName()
Return the name of the persistent class of the object for which the locking failed.ObjectRetrievalFailureException.getPersistentClassName()
Return the name of the persistent class of the object that was not found.ModifierConstructorDescriptionObjectOptimisticLockingFailureException
(Class<?> persistentClass, Object identifier, String msg, Throwable cause) Create a new ObjectOptimisticLockingFailureException for the given object, with the given explicit message.ObjectOptimisticLockingFailureException
(Class<?> persistentClass, Object identifier, String msg, Throwable cause) Create a new ObjectOptimisticLockingFailureException for the given object, with the given explicit message.ObjectOptimisticLockingFailureException
(Class<?> persistentClass, Object identifier, Throwable cause) Create a new ObjectOptimisticLockingFailureException for the given object, with the default "optimistic locking failed" message.ObjectOptimisticLockingFailureException
(String persistentClassName, Object identifier, String msg, Throwable cause) Create a new ObjectOptimisticLockingFailureException for the given object, with the given explicit message.ObjectOptimisticLockingFailureException
(String persistentClassName, Object identifier, String msg, Throwable cause) Create a new ObjectOptimisticLockingFailureException for the given object, with the given explicit message.ObjectOptimisticLockingFailureException
(String persistentClassName, Object identifier, Throwable cause) Create a new ObjectOptimisticLockingFailureException for the given object, with the default "optimistic locking failed" message.ObjectRetrievalFailureException
(Class<?> persistentClass, Object identifier, String msg, Throwable cause) Create a new ObjectRetrievalFailureException for the given object, with the given explicit message and exception.ObjectRetrievalFailureException
(Class<?> persistentClass, Object identifier, String msg, Throwable cause) Create a new ObjectRetrievalFailureException for the given object, with the given explicit message and exception.ObjectRetrievalFailureException
(String persistentClassName, Object identifier, String msg, Throwable cause) Create a new ObjectRetrievalFailureException for the given object, with the given explicit message and exception.ObjectRetrievalFailureException
(String persistentClassName, Object identifier, String msg, Throwable cause) Create a new ObjectRetrievalFailureException for the given object, with the given explicit message and exception. -
Uses of Nullable in org.springframework.orm.hibernate5
Modifier and TypeMethodDescriptionprotected <T> T
HibernateTemplate.doExecute
(HibernateCallback<T> action, boolean enforceNativeSession) Execute the action specified by the given action object within a Session.HibernateCallback.doInHibernate
(Session session) Gets called byHibernateTemplate.execute
with an active HibernateSession
.<T> T
HibernateOperations.execute
(HibernateCallback<T> action) Execute the action specified by the given action object within aSession
.<T> T
HibernateTemplate.execute
(HibernateCallback<T> action) <T> T
HibernateTemplate.executeWithNativeSession
(HibernateCallback<T> action) Execute the action specified by the given action object within a nativeSession
.<T> T
HibernateOperations.get
(Class<T> entityClass, Serializable id) Return the persistent instance of the given entity class with the given identifier, ornull
if not found.<T> T
HibernateOperations.get
(Class<T> entityClass, Serializable id, LockMode lockMode) Return the persistent instance of the given entity class with the given identifier, ornull
if not found.HibernateOperations.get
(String entityName, Serializable id) Return the persistent instance of the given entity class with the given identifier, ornull
if not found.HibernateOperations.get
(String entityName, Serializable id, LockMode lockMode) Return the persistent instance of the given entity class with the given identifier, ornull
if not found.<T> T
HibernateTemplate.get
(Class<T> entityClass, Serializable id) <T> T
HibernateTemplate.get
(Class<T> entityClass, Serializable id, LockMode lockMode) HibernateTemplate.get
(String entityName, Serializable id) HibernateTemplate.get
(String entityName, Serializable id, LockMode lockMode) HibernateTransactionManager.getDataSource()
Return the JDBC DataSource that this instance manages transactions for.static DataSource
SessionFactoryUtils.getDataSource
(SessionFactory sessionFactory) Determine the DataSource of the given SessionFactory.HibernateTransactionManager.getEntityInterceptor()
Return the current Hibernate entity interceptor, ornull
if none.String[]
HibernateTemplate.getFilterNames()
Return the names of Hibernate filters to be activated, if any.LocalSessionFactoryBean.getObject()
SessionHolder.getPreviousFlushMode()
HibernateTemplate.getQueryCacheRegion()
Return the name of the cache region for queries executed by this template.HibernateTemplate.getSessionFactory()
Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.HibernateTransactionManager.getSessionFactory()
Return the SessionFactory that this instance should manage transactions for.SessionHolder.getTransaction()
HibernateExceptionTranslator.translateExceptionIfPossible
(RuntimeException ex) Modifier and TypeMethodDescriptionint
HibernateTemplate.bulkUpdate
(String queryString, Object... values) Deprecated.static void
SessionFactoryUtils.closeSession
(Session session) Perform actual closing of the Hibernate Session, catching and logging any cleanup exceptions thrown.void
void
protected void
boolean
List<?>
Deprecated.<T> List<T>
HibernateTemplate.findByExample
(String entityName, T exampleEntity, int firstResult, int maxResults) List<?>
HibernateTemplate.findByNamedQuery
(String queryName, Object... values) Deprecated.List<?>
HibernateTemplate.findByNamedQueryAndNamedParam
(String queryName, String[] paramNames, Object[] values) Deprecated.List<?>
HibernateTemplate.findByNamedQueryAndNamedParam
(String queryName, String[] paramNames, Object[] values) Deprecated.<T> T
HibernateTemplate.get
(Class<T> entityClass, Serializable id, LockMode lockMode) HibernateTemplate.get
(String entityName, Serializable id, LockMode lockMode) Iterator<?>
Deprecated.<T> T
HibernateTemplate.load
(Class<T> entityClass, Serializable id, LockMode lockMode) HibernateTemplate.load
(String entityName, Serializable id, LockMode lockMode) void
void
HibernateTransactionManager.setDataSource
(DataSource dataSource) Set the JDBC DataSource that this instance should manage transactions for.void
HibernateTransactionManager.setEntityInterceptor
(Interceptor entityInterceptor) Set a Hibernate entity interceptor that allows to inspect and change property values before writing to and reading from the database.void
HibernateTemplate.setFilterNames
(String... filterNames) Set one or more names of Hibernate filters to be activated for all Sessions that this accessor works with.void
SessionHolder.setPreviousFlushMode
(FlushMode previousFlushMode) void
HibernateTemplate.setQueryCacheRegion
(String queryCacheRegion) Set the name of the cache region for queries executed by this template.void
HibernateTemplate.setSessionFactory
(SessionFactory sessionFactory) Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.void
HibernateTransactionManager.setSessionFactory
(SessionFactory sessionFactory) Set the SessionFactory that this instance should manage transactions for.void
SessionHolder.setTransaction
(Transaction transaction) void
void
ModifierConstructorDescriptionCreate a new HibernateSystemException, wrapping an arbitrary HibernateException.LocalSessionFactoryBuilder
(DataSource dataSource) Create a new LocalSessionFactoryBuilder for the given DataSource.LocalSessionFactoryBuilder
(DataSource dataSource, ClassLoader classLoader) Create a new LocalSessionFactoryBuilder for the given DataSource.LocalSessionFactoryBuilder
(DataSource dataSource, ResourceLoader resourceLoader) Create a new LocalSessionFactoryBuilder for the given DataSource.LocalSessionFactoryBuilder
(DataSource dataSource, ResourceLoader resourceLoader, MetadataSources metadataSources) Create a new LocalSessionFactoryBuilder for the given DataSource. -
Uses of Nullable in org.springframework.orm.hibernate5.support
Modifier and TypeMethodDescriptionfinal HibernateTemplate
HibernateDaoSupport.getHibernateTemplate()
Return the HibernateTemplate for this DAO, pre-initialized with the SessionFactory or set explicitly.final SessionFactory
HibernateDaoSupport.getSessionFactory()
Return the Hibernate SessionFactory used by this DAO.OpenSessionInterceptor.getSessionFactory()
Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.OpenSessionInViewInterceptor.getSessionFactory()
Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.OpenSessionInterceptor.invoke
(MethodInvocation invocation) Modifier and TypeMethodDescriptionvoid
OpenSessionInViewInterceptor.afterCompletion
(WebRequest request, Exception ex) Unbind the HibernateSession
from the thread and close it.void
OpenSessionInViewInterceptor.postHandle
(WebRequest request, ModelMap model) final void
HibernateDaoSupport.setHibernateTemplate
(HibernateTemplate hibernateTemplate) Set the HibernateTemplate for this DAO explicitly, as an alternative to specifying a SessionFactory.void
OpenSessionInterceptor.setSessionFactory
(SessionFactory sessionFactory) Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.void
OpenSessionInViewInterceptor.setSessionFactory
(SessionFactory sessionFactory) Set the Hibernate SessionFactory that should be used to create Hibernate Sessions. -
Uses of Nullable in org.springframework.orm.jpa
Modifier and TypeMethodDescriptionDefaultJpaDialect.beginTransaction
(EntityManager entityManager, TransactionDefinition definition) This implementation invokes the standard JPATransaction.begin
method.JpaDialect.beginTransaction
(EntityManager entityManager, TransactionDefinition definition) Begin the given JPA transaction, applying the semantics specified by the given Spring transaction definition (in particular, an isolation level and a timeout).static DataAccessException
EntityManagerFactoryUtils.convertJpaAccessExceptionIfPossible
(RuntimeException ex) Convert the given runtime exception to an appropriate exception from theorg.springframework.dao
hierarchy.static EntityManager
EntityManagerFactoryUtils.doGetTransactionalEntityManager
(EntityManagerFactory emf, Map<?, ?> properties) Obtain a JPA EntityManager from the given factory.static EntityManager
EntityManagerFactoryUtils.doGetTransactionalEntityManager
(EntityManagerFactory emf, Map<?, ?> properties, boolean synchronizedWithTransaction) Obtain a JPA EntityManager from the given factory.AbstractEntityManagerFactoryBean.getBootstrapExecutor()
Return the asynchronous executor for background bootstrapping, if any.AbstractEntityManagerFactoryBean.getDataSource()
EntityManagerFactoryInfo.getDataSource()
Return the JDBC DataSource that this EntityManagerFactory obtains its JDBC Connections from.JpaTransactionManager.getDataSource()
Return the JDBC DataSource that this instance manages transactions for.EntityManagerFactoryAccessor.getEntityManagerFactory()
Return the JPA EntityManagerFactory that should be used to create EntityManagers.JpaTransactionManager.getEntityManagerFactory()
Return the EntityManagerFactory that this instance should manage transactions for.Class<? extends EntityManager>
AbstractEntityManagerFactoryBean.getEntityManagerInterface()
Class<? extends EntityManager>
EntityManagerFactoryInfo.getEntityManagerInterface()
Return the (potentially vendor-specific) EntityManager interface that this factory's EntityManagers will implement.DefaultJpaDialect.getJdbcConnection
(EntityManager entityManager, boolean readOnly) This implementation always returnsnull
, indicating that no JDBC Connection can be provided.JpaDialect.getJdbcConnection
(EntityManager entityManager, boolean readOnly) Retrieve the JDBC Connection that the given JPA EntityManager uses underneath, if accessing a relational database.AbstractEntityManagerFactoryBean.getJpaDialect()
EntityManagerFactoryInfo.getJpaDialect()
Return the vendor-specific JpaDialect implementation for this EntityManagerFactory, ornull
if not known.default JpaDialect
JpaVendorAdapter.getJpaDialect()
Return the vendor-specific JpaDialect implementation for this provider, ornull
if there is none.AbstractEntityManagerFactoryBean.getJpaVendorAdapter()
Return the JpaVendorAdapter implementation for this EntityManagerFactory, ornull
if not known.AbstractEntityManagerFactoryBean.getObject()
Return the singleton EntityManagerFactory.AbstractEntityManagerFactoryBean.getPersistenceProvider()
EntityManagerFactoryInfo.getPersistenceProvider()
Return the underlying PersistenceProvider that the underlying EntityManagerFactory was created with.default String
JpaVendorAdapter.getPersistenceProviderRootPackage()
Return the name of the persistence provider's root package (e.g.AbstractEntityManagerFactoryBean.getPersistenceUnitInfo()
EntityManagerFactoryInfo.getPersistenceUnitInfo()
Return the PersistenceUnitInfo used to create this EntityManagerFactory, if the in-container API was used.LocalContainerEntityManagerFactoryBean.getPersistenceUnitInfo()
AbstractEntityManagerFactoryBean.getPersistenceUnitName()
EntityManagerFactoryAccessor.getPersistenceUnitName()
Return the name of the persistence unit to access the EntityManagerFactory for, if any.EntityManagerFactoryInfo.getPersistenceUnitName()
Return the name of the persistence unit used to create this EntityManagerFactory, ornull
if it is an unnamed default.JpaTransactionManager.getPersistenceUnitName()
Return the name of the persistence unit to manage transactions for, if any.LocalContainerEntityManagerFactoryBean.getPersistenceUnitName()
protected SavepointManager
EntityManagerHolder.getSavepointManager()
protected EntityManager
EntityManagerFactoryAccessor.getTransactionalEntityManager()
Obtain the transactional EntityManager for this accessor's EntityManagerFactory, if any.static EntityManager
EntityManagerFactoryUtils.getTransactionalEntityManager
(EntityManagerFactory emf) Obtain a JPA EntityManager from the given factory.static EntityManager
EntityManagerFactoryUtils.getTransactionalEntityManager
(EntityManagerFactory emf, Map<?, ?> properties) Obtain a JPA EntityManager from the given factory.DefaultJpaDialect.prepareTransaction
(EntityManager entityManager, boolean readOnly, String name) JpaDialect.prepareTransaction
(EntityManager entityManager, boolean readOnly, String name) Prepare a JPA transaction, applying the specified semantics.AbstractEntityManagerFactoryBean.translateExceptionIfPossible
(RuntimeException ex) Implementation of the PersistenceExceptionTranslator interface, as autodetected by Spring's PersistenceExceptionTranslationPostProcessor.DefaultJpaDialect.translateExceptionIfPossible
(RuntimeException ex) This implementation delegates to EntityManagerFactoryUtils.Modifier and TypeMethodDescriptionvoid
DefaultJpaDialect.cleanupTransaction
(Object transactionData) This implementation does nothing, since the defaultbeginTransaction
implementation does not require any cleanup.void
JpaDialect.cleanupTransaction
(Object transactionData) Clean up the transaction via the given transaction data.static void
EntityManagerFactoryUtils.closeEntityManager
(EntityManager em) Close the given JPA EntityManager, catching and logging any cleanup exceptions thrown.static EntityManager
ExtendedEntityManagerCreator.createContainerManagedEntityManager
(EntityManagerFactory emf, Map<?, ?> properties) Create a container-managed extended EntityManager proxy.static EntityManager
ExtendedEntityManagerCreator.createContainerManagedEntityManager
(EntityManagerFactory emf, Map<?, ?> properties, boolean synchronizedWithTransaction) Create a container-managed extended EntityManager proxy.protected EntityManagerFactory
AbstractEntityManagerFactoryBean.createEntityManagerFactoryProxy
(EntityManagerFactory emf) Create a proxy for the givenEntityManagerFactory
.AbstractEntityManagerFactoryBean.createNativeEntityManager
(Map<?, ?> properties) EntityManagerFactoryInfo.createNativeEntityManager
(Map<?, ?> properties) Create a native JPA EntityManager to be used as the framework-managed resource behind an application-level EntityManager handle.static EntityManager
SharedEntityManagerCreator.createSharedEntityManager
(EntityManagerFactory emf, Map<?, ?> properties) Create a transactional EntityManager proxy for the given EntityManagerFactory.static EntityManager
SharedEntityManagerCreator.createSharedEntityManager
(EntityManagerFactory emf, Map<?, ?> properties, boolean synchronizedWithTransaction) Create a transactional EntityManager proxy for the given EntityManagerFactory.static EntityManager
SharedEntityManagerCreator.createSharedEntityManager
(EntityManagerFactory emf, Map<?, ?> properties, boolean synchronizedWithTransaction, Class<?>... entityManagerInterfaces) Create a transactional EntityManager proxy for the given EntityManagerFactory.static EntityManager
SharedEntityManagerCreator.createSharedEntityManager
(EntityManagerFactory emf, Map<?, ?> properties, Class<?>... entityManagerInterfaces) Create a transactional EntityManager proxy for the given EntityManagerFactory.static EntityManager
EntityManagerFactoryUtils.doGetTransactionalEntityManager
(EntityManagerFactory emf, Map<?, ?> properties, boolean synchronizedWithTransaction) Obtain a JPA EntityManager from the given factory.protected void
static EntityManagerFactory
EntityManagerFactoryUtils.findEntityManagerFactory
(ListableBeanFactory beanFactory, String unitName) Find an EntityManagerFactory with the given name in the given Spring application context (represented as ListableBeanFactory).static EntityManager
EntityManagerFactoryUtils.getTransactionalEntityManager
(EntityManagerFactory emf, Map<?, ?> properties) Obtain a JPA EntityManager from the given factory.DefaultJpaDialect.prepareTransaction
(EntityManager entityManager, boolean readOnly, String name) JpaDialect.prepareTransaction
(EntityManager entityManager, boolean readOnly, String name) Prepare a JPA transaction, applying the specified semantics.void
AbstractEntityManagerFactoryBean.setBootstrapExecutor
(AsyncTaskExecutor bootstrapExecutor) Specify an asynchronous executor for background bootstrapping, e.g.void
JpaTransactionManager.setDataSource
(DataSource dataSource) Set the JDBC DataSource that this instance should manage transactions for.void
EntityManagerFactoryAccessor.setEntityManagerFactory
(EntityManagerFactory emf) Set the JPA EntityManagerFactory that should be used to create EntityManagers.void
JpaTransactionManager.setEntityManagerFactory
(EntityManagerFactory emf) Set the EntityManagerFactory that this instance should manage transactions for.void
AbstractEntityManagerFactoryBean.setEntityManagerInterface
(Class<? extends EntityManager> emInterface) Specify the (potentially vendor-specific) EntityManager interface that this factory's EntityManagers are supposed to implement.void
AbstractEntityManagerFactoryBean.setJpaDialect
(JpaDialect jpaDialect) Specify the vendor-specific JpaDialect implementation to associate with this EntityManagerFactory.void
JpaTransactionManager.setJpaDialect
(JpaDialect jpaDialect) Set the JPA dialect to use for this transaction manager.void
JpaTransactionManager.setJpaProperties
(Properties jpaProperties) Specify JPA properties, to be passed intoEntityManagerFactory.createEntityManager(Map)
(if any).void
AbstractEntityManagerFactoryBean.setJpaPropertyMap
(Map<String, ?> jpaProperties) Specify JPA properties as a Map, to be passed intoPersistence.createEntityManagerFactory
(if any).void
EntityManagerFactoryAccessor.setJpaPropertyMap
(Map<String, Object> jpaProperties) Specify JPA properties as a Map, to be passed intoEntityManagerFactory.createEntityManager(Map)
(if any).void
JpaTransactionManager.setJpaPropertyMap
(Map<String, ?> jpaProperties) Specify JPA properties as a Map, to be passed intoEntityManagerFactory.createEntityManager(Map)
(if any).void
AbstractEntityManagerFactoryBean.setJpaVendorAdapter
(JpaVendorAdapter jpaVendorAdapter) Specify the JpaVendorAdapter implementation for the desired JPA provider, if any.void
AbstractEntityManagerFactoryBean.setPersistenceProvider
(PersistenceProvider persistenceProvider) Set the PersistenceProvider instance to use for creating the EntityManagerFactory.void
AbstractEntityManagerFactoryBean.setPersistenceUnitName
(String persistenceUnitName) Specify the name of the EntityManagerFactory configuration.void
EntityManagerFactoryAccessor.setPersistenceUnitName
(String persistenceUnitName) Set the name of the persistence unit to access the EntityManagerFactory for.void
JpaTransactionManager.setPersistenceUnitName
(String persistenceUnitName) Set the name of the persistence unit to manage transactions for.void
LocalContainerEntityManagerFactoryBean.setPersistenceUnitName
(String persistenceUnitName) Uses the specified persistence unit name as the name of the default persistence unit, if applicable.protected void
EntityManagerHolder.setSavepointManager
(SavepointManager savepointManager) -
Uses of Nullable in org.springframework.orm.jpa.persistenceunit
Modifier and TypeMethodDescriptionMutablePersistenceUnitInfo.getClassLoader()
This implementation returns the default ClassLoader.DefaultPersistenceUnitManager.getDataSourceLookup()
Return the JDBC DataSourceLookup that provides DataSources for the persistence provider, resolving data source names inpersistence.xml
against Spring-managed DataSource instances.DefaultPersistenceUnitManager.getDefaultDataSource()
Return the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified inpersistence.xml
.DefaultPersistenceUnitManager.getDefaultJtaDataSource()
Return the JTA-aware DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified inpersistence.xml
.MutablePersistenceUnitInfo.getJtaDataSource()
DefaultPersistenceUnitManager.getLoadTimeWeaver()
Return the Spring LoadTimeWeaver to use for class instrumentation according to the JPA class transformer contract.MutablePersistenceUnitInfo.getNonJtaDataSource()
MutablePersistenceUnitInfo.getPersistenceProviderClassName()
MutablePersistenceUnitInfo.getPersistenceProviderPackageName()
protected final MutablePersistenceUnitInfo
DefaultPersistenceUnitManager.getPersistenceUnitInfo
(String persistenceUnitName) Return the specified PersistenceUnitInfo from this manager's cache of processed persistence units, keeping it in the cache (i.e.MutablePersistenceUnitInfo.getPersistenceUnitName()
DefaultPersistenceUnitManager.getPersistenceUnitPostProcessors()
Return the PersistenceUnitPostProcessors to be applied to each PersistenceUnitInfo that has been parsed by this manager.MutablePersistenceUnitInfo.getPersistenceUnitRootUrl()
PersistenceManagedTypes.getPersistenceUnitRootUrl()
Return the persistence unit root url ornull
if it could not be determined.Modifier and TypeMethodDescriptionvoid
DefaultPersistenceUnitManager.setDataSourceLookup
(DataSourceLookup dataSourceLookup) Specify the JDBC DataSourceLookup that provides DataSources for the persistence provider, resolving data source names inpersistence.xml
against Spring-managed DataSource instances.void
DefaultPersistenceUnitManager.setDefaultDataSource
(DataSource defaultDataSource) Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified inpersistence.xml
.void
DefaultPersistenceUnitManager.setDefaultJtaDataSource
(DataSource defaultJtaDataSource) Specify the JDBC DataSource that the JPA persistence provider is supposed to use for accessing the database if none has been specified inpersistence.xml
.void
MutablePersistenceUnitInfo.setJtaDataSource
(DataSource jtaDataSource) void
DefaultPersistenceUnitManager.setLoadTimeWeaver
(LoadTimeWeaver loadTimeWeaver) Specify the Spring LoadTimeWeaver to use for class instrumentation according to the JPA class transformer contract.void
MutablePersistenceUnitInfo.setNonJtaDataSource
(DataSource nonJtaDataSource) void
MutablePersistenceUnitInfo.setPersistenceProviderClassName
(String persistenceProviderClassName) void
MutablePersistenceUnitInfo.setPersistenceProviderPackageName
(String persistenceProviderPackageName) void
MutablePersistenceUnitInfo.setPersistenceUnitName
(String persistenceUnitName) void
DefaultPersistenceUnitManager.setPersistenceUnitPostProcessors
(PersistenceUnitPostProcessor... postProcessors) Set the PersistenceUnitPostProcessors to be applied to each PersistenceUnitInfo that has been parsed by this manager.void
MutablePersistenceUnitInfo.setPersistenceUnitRootUrl
(URL persistenceUnitRootUrl) -
Uses of Nullable in org.springframework.orm.jpa.support
Modifier and TypeMethodDescriptionprotected String
OpenEntityManagerInViewFilter.getEntityManagerFactoryBeanName()
Return the bean name of the EntityManagerFactory to fetch from Spring's root application context.SharedEntityManagerBean.getObject()
protected EntityManager
PersistenceAnnotationBeanPostProcessor.getPersistenceContext
(String unitName, boolean extended) Return a specified persistence context for the given unit name, as defined through the "persistenceContexts" (or "extendedPersistenceContexts") map.protected EntityManagerFactory
PersistenceAnnotationBeanPostProcessor.getPersistenceUnit
(String unitName) Return a specified persistence unit for the given unit name, as defined through the "persistenceUnits" map.protected String
OpenEntityManagerInViewFilter.getPersistenceUnitName()
Return the name of the persistence unit to access the EntityManagerFactory for, if any.Modifier and TypeMethodDescriptionvoid
OpenEntityManagerInViewInterceptor.afterCompletion
(WebRequest request, Exception ex) protected EntityManagerFactory
PersistenceAnnotationBeanPostProcessor.findDefaultEntityManagerFactory
(String requestingBeanName) Find a single default EntityManagerFactory in the Spring application context.protected EntityManagerFactory
PersistenceAnnotationBeanPostProcessor.findEntityManagerFactory
(String unitName, String requestingBeanName) Find an EntityManagerFactory with the given name in the current Spring application context, falling back to a single default EntityManagerFactory (if any) in case of no unit name specified.protected EntityManagerFactory
PersistenceAnnotationBeanPostProcessor.findEntityManagerFactory
(String unitName, String requestingBeanName) Find an EntityManagerFactory with the given name in the current Spring application context, falling back to a single default EntityManagerFactory (if any) in case of no unit name specified.protected EntityManagerFactory
PersistenceAnnotationBeanPostProcessor.findNamedEntityManagerFactory
(String unitName, String requestingBeanName) Find an EntityManagerFactory with the given name in the current Spring application context.protected EntityManager
PersistenceAnnotationBeanPostProcessor.getPersistenceContext
(String unitName, boolean extended) Return a specified persistence context for the given unit name, as defined through the "persistenceContexts" (or "extendedPersistenceContexts") map.protected EntityManagerFactory
PersistenceAnnotationBeanPostProcessor.getPersistenceUnit
(String unitName) Return a specified persistence unit for the given unit name, as defined through the "persistenceUnits" map.void
OpenEntityManagerInViewInterceptor.postHandle
(WebRequest request, ModelMap model) void
PersistenceAnnotationBeanPostProcessor.setDefaultPersistenceUnitName
(String unitName) Specify the default persistence unit name, to be used in case of no unit name specified in an@PersistenceUnit
/@PersistenceContext
annotation.void
OpenEntityManagerInViewFilter.setEntityManagerFactoryBeanName
(String entityManagerFactoryBeanName) Set the bean name of the EntityManagerFactory to fetch from Spring's root application context.void
OpenEntityManagerInViewFilter.setPersistenceUnitName
(String persistenceUnitName) Set the name of the persistence unit to access the EntityManagerFactory for. -
Uses of Nullable in org.springframework.orm.jpa.vendor
Modifier and TypeMethodDescriptionEclipseLinkJpaDialect.beginTransaction
(EntityManager entityManager, TransactionDefinition definition) protected Class<?>
HibernateJpaVendorAdapter.determineDatabaseDialectClass
(Database database) Determine the Hibernate database dialect class for the given target database.protected String
EclipseLinkJpaVendorAdapter.determineTargetDatabaseName
(Database database) Determine the EclipseLink target database name for the given database.protected String
AbstractJpaVendorAdapter.getDatabasePlatform()
Return the name of the target database to operate on.protected Object
HibernateJpaDialect.getIdentifier
(HibernateException hibEx) AbstractJpaVendorAdapter.getJpaDialect()
AbstractJpaVendorAdapter.getPersistenceProviderRootPackage()
protected FlushMode
HibernateJpaDialect.prepareFlushMode
(Session session, boolean readOnly) HibernateJpaDialect.translateExceptionIfPossible
(RuntimeException ex) Modifier and TypeMethodDescriptionvoid
HibernateJpaDialect.cleanupTransaction
(Object transactionData) HibernateJpaDialect.prepareTransaction
(EntityManager entityManager, boolean readOnly, String name) void
AbstractJpaVendorAdapter.setDatabasePlatform
(String databasePlatform) Specify the name of the target database to operate on. -
Uses of Nullable in org.springframework.oxm.jaxb
Modifier and TypeMethodDescriptionClass<?>[]
Jaxb2Marshaller.getClassesToBeBound()
Return the list of Java classes to be recognized by a newly created JAXBContext.Jaxb2Marshaller.getContextPath()
Return the JAXB context path.String[]
Jaxb2Marshaller.getPackagesToScan()
Return the packages to search for JAXB2 annotations.Modifier and TypeMethodDescriptionvoid
Jaxb2Marshaller.marshal
(Object graph, Result result, MimeContainer mimeContainer) void
Jaxb2Marshaller.setClassesToBeBound
(Class<?>... classesToBeBound) Set the list of Java classes to be recognized by a newly created JAXBContext.void
Jaxb2Marshaller.setContextPath
(String contextPath) Set a JAXB context path.void
Jaxb2Marshaller.setPackagesToScan
(String... packagesToScan) Set the packages to search for classes with JAXB2 annotations in the classpath.Jaxb2Marshaller.unmarshal
(Source source, MimeContainer mimeContainer) -
Uses of Nullable in org.springframework.oxm.mime
Modifier and TypeMethodDescriptionMimeContainer.getAttachment
(String contentId) Return the attachment with the given content id, ornull
if not found.Modifier and TypeMethodDescriptionvoid
MimeMarshaller.marshal
(Object graph, Result result, MimeContainer mimeContainer) Marshals the object graph with the given root into the providedResult
, writing binary data to aMimeContainer
.MimeUnmarshaller.unmarshal
(Source source, MimeContainer mimeContainer) Unmarshals the given providedSource
into an object graph, reading binary attachments from aMimeContainer
. -
Uses of Nullable in org.springframework.oxm.support
Modifier and TypeMethodDescriptionprotected String
AbstractMarshaller.getDefaultEncoding()
Determine the default encoding to use for marshalling or unmarshalling from a byte stream, ornull
if none.Modifier and TypeMethodDescriptionprotected abstract void
AbstractMarshaller.marshalSaxHandlers
(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler) Abstract template method for marshalling the given object graph to a SAXContentHandler
. -
Uses of Nullable in org.springframework.oxm.xstream
Modifier and TypeMethodDescriptionvoid
XStreamMarshaller.marshalOutputStream
(Object graph, OutputStream outputStream, com.thoughtworks.xstream.converters.DataHolder dataHolder) protected void
XStreamMarshaller.marshalSaxHandlers
(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler) void
XStreamMarshaller.marshalWriter
(Object graph, Writer writer, com.thoughtworks.xstream.converters.DataHolder dataHolder) XStreamMarshaller.unmarshalInputStream
(InputStream inputStream, com.thoughtworks.xstream.converters.DataHolder dataHolder) XStreamMarshaller.unmarshalReader
(Reader reader, com.thoughtworks.xstream.converters.DataHolder dataHolder) -
Uses of Nullable in org.springframework.r2dbc
Modifier and TypeMethodDescriptionUncategorizedR2dbcException.getSql()
Return the SQL that led to the problem (if known).ModifierConstructorDescriptionUncategorizedR2dbcException
(String msg, String sql, R2dbcException ex) Constructor forUncategorizedSQLException
. -
Uses of Nullable in org.springframework.r2dbc.connection
Modifier and TypeMethodDescriptionprotected Boolean
SingleConnectionFactory.getAutoCommitValue()
Return whether the returnedConnection
's "autoCommit" setting should be overridden.R2dbcTransactionManager.getConnectionFactory()
Return the R2DBCConnectionFactory
that this instance manages transactions for.protected IsolationLevel
R2dbcTransactionManager.resolveIsolationLevel
(int isolationLevel) Resolve the isolation level constant to a R2DBCIsolationLevel
.Modifier and TypeMethodDescriptionstatic DataAccessException
ConnectionFactoryUtils.convertR2dbcException
(String task, String sql, R2dbcException ex) Translate the givenR2dbcException
into a genericDataAccessException
.protected reactor.core.publisher.Mono<Void>
R2dbcTransactionManager.doResume
(TransactionSynchronizationManager synchronizationManager, Object transaction, Object suspendedResources) protected void
ConnectionHolder.setConnection
(Connection connection) Override the existing Connection with the givenConnection
.void
R2dbcTransactionManager.setConnectionFactory
(ConnectionFactory connectionFactory) Set the R2DBCConnectionFactory
that this instance should manage transactions for. -
Uses of Nullable in org.springframework.r2dbc.connection.init
Modifier and TypeMethodDescriptionstatic reactor.core.publisher.Mono<Void>
ScriptUtils.executeSqlScript
(Connection connection, EncodedResource resource, DataBufferFactory dataBufferFactory, boolean continueOnError, boolean ignoreFailedDrops, String[] commentPrefixes, String separator, String blockCommentStartDelimiter, String blockCommentEndDelimiter) Execute the given SQL script.static reactor.core.publisher.Mono<Void>
ScriptUtils.executeSqlScript
(Connection connection, EncodedResource resource, DataBufferFactory dataBufferFactory, boolean continueOnError, boolean ignoreFailedDrops, String commentPrefix, String separator, String blockCommentStartDelimiter, String blockCommentEndDelimiter) Execute the given SQL script.void
ResourceDatabasePopulator.setSqlScriptEncoding
(String sqlScriptEncoding) Specify the encoding for the configured SQL scripts, if different from the platform encoding.void
ResourceDatabasePopulator.setSqlScriptEncoding
(Charset sqlScriptEncoding) Specify the encoding for the configured SQL scripts, if different from the platform encoding.ModifierConstructorDescriptionResourceDatabasePopulator
(boolean continueOnError, boolean ignoreFailedDrops, String sqlScriptEncoding, Resource... scripts) Construct a newResourceDatabasePopulator
with the supplied values.ScriptException
(String message, Throwable cause) Create a newScriptException
.ScriptParseException
(String message, EncodedResource resource) Create a newScriptParseException
.ScriptParseException
(String message, EncodedResource resource, Throwable cause) Create a newScriptParseException
.ScriptParseException
(String message, EncodedResource resource, Throwable cause) Create a newScriptParseException
. -
Uses of Nullable in org.springframework.r2dbc.core
Modifier and TypeMethodDescriptionprotected Object
ColumnMapRowMapper.getColumnValue
(Row row, int index) Retrieve a R2DBC object value for the specified column.protected Object
BeanPropertyRowMapper.getItemValue
(Readable readable, int itemIndex, Class<?> paramType) Retrieve an R2DBC object value for the specified item index (a column or an out-parameter).SqlProvider.getSql()
Return the SQL string for this object, i.e.Parameter.getValue()
Deprecated.Return the column value (can benull
). -
Uses of Nullable in org.springframework.r2dbc.core.binding
Modifier and TypeMethodDescriptionBindMarkersFactoryResolver.BindMarkerFactoryProvider.getBindMarkers
(ConnectionFactory connectionFactory) Return aBindMarkersFactory
for aConnectionFactory
.abstract Object
Bindings.Binding.getValue()
Return the binding value. -
Uses of Nullable in org.springframework.scheduling
Modifier and TypeMethodDescriptiondefault String
SchedulingAwareRunnable.getQualifier()
Return a qualifier associated with this Runnable.TriggerContext.lastActualExecution()
Return the last actual execution time of the task, ornull
if not scheduled before.default Date
TriggerContext.lastActualExecutionTime()
Deprecated.as of 6.0, in favor onTriggerContext.lastActualExecution()
TriggerContext.lastCompletion()
Return the last completion time of the task, ornull
if not scheduled before.default Date
TriggerContext.lastCompletionTime()
Deprecated.as of 6.0, in favor onTriggerContext.lastCompletion()
TriggerContext.lastScheduledExecution()
Return the last scheduled execution time of the task, ornull
if not scheduled before.default Date
TriggerContext.lastScheduledExecutionTime()
Deprecated.as of 6.0, in favor onTriggerContext.lastScheduledExecution()
Trigger.nextExecution
(TriggerContext triggerContext) Determine the next execution time according to the given trigger context.default Date
Trigger.nextExecutionTime
(TriggerContext triggerContext) Deprecated.as of 6.0, in favor ofTrigger.nextExecution(TriggerContext)
Schedule the givenRunnable
, invoking it whenever the trigger indicates a next execution time. -
Uses of Nullable in org.springframework.scheduling.annotation
Modifier and TypeFieldDescriptionprotected AnnotationAttributes
AbstractAsyncConfiguration.enableAsync
protected Supplier<AsyncUncaughtExceptionHandler>
AbstractAsyncConfiguration.exceptionHandler
AbstractAsyncConfiguration.executor
Modifier and TypeMethodDescriptionprotected Runnable
ScheduledAnnotationBeanPostProcessor.createRunnable
(Object target, Method method) Deprecated.AsyncResult.get()
Deprecated.Deprecated.default Executor
AsyncConfigurer.getAsyncExecutor()
TheExecutor
instance to be used when processing async method invocations.default AsyncUncaughtExceptionHandler
AsyncConfigurer.getAsyncUncaughtExceptionHandler()
TheAsyncUncaughtExceptionHandler
instance to be used when an exception is thrown during an asynchronous method execution withvoid
return type.AsyncConfigurerSupport.getAsyncUncaughtExceptionHandler()
Deprecated.protected String
AnnotationAsyncExecutionInterceptor.getExecutorQualifier
(Method method) Return the qualifier or bean name of the executor to be used when executing the given method, specified viaAsync.value()
at the method or declaring class level.Modifier and TypeMethodDescriptionprotected Advice
AsyncAnnotationAdvisor.buildAdvice
(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) protected Advice
AsyncAnnotationAdvisor.buildAdvice
(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) void
AsyncAnnotationBeanPostProcessor.configure
(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Configure this post-processor with the given executor and exception handler suppliers, applying the corresponding default if a supplier is not resolvable.void
AsyncAnnotationBeanPostProcessor.configure
(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Configure this post-processor with the given executor and exception handler suppliers, applying the corresponding default if a supplier is not resolvable.protected Runnable
ScheduledAnnotationBeanPostProcessor.createRunnable
(Object target, Method method, String qualifier) Create aRunnable
for the given bean instance, calling the specified scheduled method.ModifierConstructorDescriptionAnnotationAsyncExecutionInterceptor
(Executor defaultExecutor) Create a newAnnotationAsyncExecutionInterceptor
with the given executor and a simpleAsyncUncaughtExceptionHandler
.AnnotationAsyncExecutionInterceptor
(Executor defaultExecutor, AsyncUncaughtExceptionHandler exceptionHandler) Create a newAnnotationAsyncExecutionInterceptor
with the given executor.AsyncAnnotationAdvisor
(Executor executor, AsyncUncaughtExceptionHandler exceptionHandler) Create a newAsyncAnnotationAdvisor
for the given task executor.AsyncAnnotationAdvisor
(Executor executor, AsyncUncaughtExceptionHandler exceptionHandler) Create a newAsyncAnnotationAdvisor
for the given task executor.AsyncAnnotationAdvisor
(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Create a newAsyncAnnotationAdvisor
for the given task executor.AsyncAnnotationAdvisor
(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Create a newAsyncAnnotationAdvisor
for the given task executor.AsyncResult
(V value) Deprecated.Create a new AsyncResult holder. -
Uses of Nullable in org.springframework.scheduling.concurrent
Modifier and TypeMethodDescriptionForkJoinPoolFactoryBean.getObject()
ScheduledExecutorFactoryBean.getObject()
ThreadPoolExecutorFactoryBean.getObject()
Modifier and TypeMethodDescriptionprotected void
ExecutorConfigurationSupport.afterExecute
(Runnable task, Throwable ex) An after-execute callback for framework subclasses to delegate to (for start/stop handling), and possibly also for custom subclasses to extend (making sure to call this implementation as well).void
ExecutorConfigurationSupport.setRejectedExecutionHandler
(RejectedExecutionHandler rejectedExecutionHandler) Set the RejectedExecutionHandler to use for the ExecutorService.void
ExecutorConfigurationSupport.setThreadFactory
(ThreadFactory threadFactory) Set the ThreadFactory to use for the ExecutorService's thread pool.void
ExecutorConfigurationSupport.setThreadNamePrefix
(String threadNamePrefix) void
ScheduledExecutorTask.setTimeUnit
(TimeUnit timeUnit) Specify the time unit for the delay and period values.ModifierConstructorDescriptionConcurrentTaskExecutor
(Executor executor) Create a new ConcurrentTaskExecutor, using the givenExecutor
.ConcurrentTaskScheduler
(ScheduledExecutorService scheduledExecutor) Create a new ConcurrentTaskScheduler, using the givenScheduledExecutorService
as shared delegate. -
Uses of Nullable in org.springframework.scheduling.config
Modifier and TypeMethodDescriptionprotected String
TaskSchedulerRouter.determineQualifier
(Runnable task) TaskExecutorFactoryBean.getObject()
io.micrometer.observation.ObservationRegistry
ScheduledTaskRegistrar.getObservationRegistry()
Return theObservationRegistry
for this registrar.ScheduledTaskRegistrar.getScheduler()
Return theTaskScheduler
instance for this registrar (may benull
).AnnotationDrivenBeanDefinitionParser.parse
(Element element, ParserContext parserContext) ScheduledTaskRegistrar.scheduleCronTask
(CronTask task) Schedule the specified cron task, either right away if possible or on initialization of the scheduler.ScheduledTaskRegistrar.scheduleFixedDelayTask
(FixedDelayTask task) Schedule the specified fixed-delay task, either right away if possible or on initialization of the scheduler.ScheduledTaskRegistrar.scheduleFixedRateTask
(FixedRateTask task) Schedule the specified fixed-rate task, either right away if possible or on initialization of the scheduler.ScheduledTaskRegistrar.scheduleTriggerTask
(TriggerTask task) Schedule the specified trigger task, either right away if possible or on initialization of the scheduler.Modifier and TypeMethodDescriptionvoid
TaskSchedulerRouter.setBeanFactory
(BeanFactory beanFactory) The bean factory for scheduler lookups.void
TaskSchedulerRouter.setBeanName
(String name) The bean name for this router, or the bean name of the containing bean if the router instance is internally held.void
ScheduledTaskRegistrar.setObservationRegistry
(io.micrometer.observation.ObservationRegistry observationRegistry) Configure anObservationRegistry
to record observations for scheduled tasks.void
ScheduledTaskRegistrar.setScheduler
(Object scheduler) Set theTaskScheduler
to register scheduled tasks with, or aScheduledExecutorService
to be wrapped as aTaskScheduler
. -
Uses of Nullable in org.springframework.scheduling.quartz
Modifier and TypeMethodDescriptionstatic DataSource
SchedulerFactoryBean.getConfigTimeDataSource()
Return theDataSource
for the currently configured Quartz Scheduler, to be used byLocalDataSourceJobStore
.static DataSource
SchedulerFactoryBean.getConfigTimeNonTransactionalDataSource()
Return the non-transactionalDataSource
for the currently configured Quartz Scheduler, to be used byLocalDataSourceJobStore
.static ResourceLoader
SchedulerFactoryBean.getConfigTimeResourceLoader()
Return theResourceLoader
for the currently configured Quartz Scheduler, to be used byResourceLoaderClassLoadHelper
.static Executor
SchedulerFactoryBean.getConfigTimeTaskExecutor()
Return theExecutor
for the currently configured Quartz Scheduler, to be used byLocalTaskExecutorThreadPool
.CronTriggerFactoryBean.getObject()
JobDetailFactoryBean.getObject()
MethodInvokingJobDetailFactoryBean.getObject()
SchedulerFactoryBean.getObject()
SimpleTriggerFactoryBean.getObject()
ResourceLoaderClassLoadHelper.getResource
(String name) ResourceLoaderClassLoadHelper.getResourceAsStream
(String name) Modifier and TypeMethodDescriptionprotected Scheduler
SchedulerFactoryBean.createScheduler
(SchedulerFactory schedulerFactory, String schedulerName) Create the Scheduler instance for the given factory and scheduler name.ModifierConstructorDescriptionResourceLoaderClassLoadHelper
(ResourceLoader resourceLoader) Create a new ResourceLoaderClassLoadHelper for the given ResourceLoader. -
Uses of Nullable in org.springframework.scheduling.support
Modifier and TypeMethodDescriptionPeriodicTrigger.getInitialDelayDuration()
Return the initial delay, ornull
if none.ScheduledMethodRunnable.getQualifier()
SimpleTriggerContext.lastActualExecution()
SimpleTriggerContext.lastCompletion()
SimpleTriggerContext.lastScheduledExecution()
<T extends Temporal & Comparable<? super T>>
TCronExpression.next
(T temporal) Calculate the nextTemporal
that matches this expression.Modifier and TypeMethodDescriptionTaskUtils.decorateTaskWithErrorHandler
(Runnable task, ErrorHandler errorHandler, boolean isRepeatingTask) Decorate the task for error handling.boolean
boolean
boolean
static boolean
CronExpression.isValidExpression
(String expression) Determine whether the given string represents a valid cron expression.void
SimpleTriggerContext.update
(Instant lastScheduledExecution, Instant lastActualExecution, Instant lastCompletion) Update this holder's state with the latest time values.void
SimpleTriggerContext.update
(Instant lastScheduledExecution, Instant lastActualExecution, Instant lastCompletion) Update this holder's state with the latest time values.void
SimpleTriggerContext.update
(Instant lastScheduledExecution, Instant lastActualExecution, Instant lastCompletion) Update this holder's state with the latest time values.void
SimpleTriggerContext.update
(Date lastScheduledExecutionTime, Date lastActualExecutionTime, Date lastCompletionTime) Deprecated.as of 6.0, in favor ofSimpleTriggerContext.update(Instant, Instant, Instant)
void
SimpleTriggerContext.update
(Date lastScheduledExecutionTime, Date lastActualExecutionTime, Date lastCompletionTime) Deprecated.as of 6.0, in favor ofSimpleTriggerContext.update(Instant, Instant, Instant)
void
SimpleTriggerContext.update
(Date lastScheduledExecutionTime, Date lastActualExecutionTime, Date lastCompletionTime) Deprecated.as of 6.0, in favor ofSimpleTriggerContext.update(Instant, Instant, Instant)
ModifierConstructorDescriptionPeriodicTrigger
(long period, TimeUnit timeUnit) Deprecated.as of 6.0, in favor onPeriodicTrigger(Duration)
ScheduledMethodRunnable
(Object target, Method method, String qualifier, Supplier<io.micrometer.observation.ObservationRegistry> observationRegistrySupplier) Create aScheduledMethodRunnable
for the given target instance, calling the specified method.SimpleTriggerContext
(Instant lastScheduledExecution, Instant lastActualExecution, Instant lastCompletion) Create a SimpleTriggerContext with the given time values, exposing the system clock for the default time zone.SimpleTriggerContext
(Instant lastScheduledExecution, Instant lastActualExecution, Instant lastCompletion) Create a SimpleTriggerContext with the given time values, exposing the system clock for the default time zone.SimpleTriggerContext
(Instant lastScheduledExecution, Instant lastActualExecution, Instant lastCompletion) Create a SimpleTriggerContext with the given time values, exposing the system clock for the default time zone.SimpleTriggerContext
(Date lastScheduledExecutionTime, Date lastActualExecutionTime, Date lastCompletionTime) Deprecated.as of 6.0, in favor ofSimpleTriggerContext(Instant, Instant, Instant)
SimpleTriggerContext
(Date lastScheduledExecutionTime, Date lastActualExecutionTime, Date lastCompletionTime) Deprecated.as of 6.0, in favor ofSimpleTriggerContext(Instant, Instant, Instant)
SimpleTriggerContext
(Date lastScheduledExecutionTime, Date lastActualExecutionTime, Date lastCompletionTime) Deprecated.as of 6.0, in favor ofSimpleTriggerContext(Instant, Instant, Instant)
-
Uses of Nullable in org.springframework.scripting
Modifier and TypeMethodDescriptionScriptEvaluator.evaluate
(ScriptSource script) Evaluate the given script.ScriptEvaluator.evaluate
(ScriptSource script, Map<String, Object> arguments) Evaluate the given script with the given arguments.ScriptFactory.getScriptedObject
(ScriptSource scriptSource, Class<?>... actualInterfaces) Factory method for creating the scripted Java object.Class<?>
ScriptFactory.getScriptedObjectType
(ScriptSource scriptSource) Determine the type of the scripted Java object.Class<?>[]
ScriptFactory.getScriptInterfaces()
Return the business interfaces that the script is supposed to implement.ScriptCompilationException.getScriptSource()
Return the source for the offending script.ScriptSource.suggestedClassName()
Determine a class name for the underlying script.Modifier and TypeMethodDescriptionScriptEvaluator.evaluate
(ScriptSource script, Map<String, Object> arguments) Evaluate the given script with the given arguments.ScriptFactory.getScriptedObject
(ScriptSource scriptSource, Class<?>... actualInterfaces) Factory method for creating the scripted Java object. -
Uses of Nullable in org.springframework.scripting.bsh
Modifier and TypeMethodDescriptionBshScriptEvaluator.evaluate
(ScriptSource script) BshScriptEvaluator.evaluate
(ScriptSource script, Map<String, Object> arguments) BshScriptFactory.getScriptedObject
(ScriptSource scriptSource, Class<?>... actualInterfaces) Load and parse the BeanShell script viaBshScriptUtils
.Class<?>
BshScriptFactory.getScriptedObjectType
(ScriptSource scriptSource) Class<?>[]
BshScriptFactory.getScriptInterfaces()
Modifier and TypeMethodDescriptionstatic Object
BshScriptUtils.createBshObject
(String scriptSource, Class<?>... scriptInterfaces) Create a new BeanShell-scripted object from the given script source, using the default ClassLoader.static Object
BshScriptUtils.createBshObject
(String scriptSource, Class<?>[] scriptInterfaces, ClassLoader classLoader) Create a new BeanShell-scripted object from the given script source.static Object
BshScriptUtils.createBshObject
(String scriptSource, Class<?>[] scriptInterfaces, ClassLoader classLoader) Create a new BeanShell-scripted object from the given script source.BshScriptEvaluator.evaluate
(ScriptSource script, Map<String, Object> arguments) BshScriptFactory.getScriptedObject
(ScriptSource scriptSource, Class<?>... actualInterfaces) Load and parse the BeanShell script viaBshScriptUtils
.ModifierConstructorDescriptionBshScriptFactory
(String scriptSourceLocator, Class<?>... scriptInterfaces) Create a new BshScriptFactory for the given script source. -
Uses of Nullable in org.springframework.scripting.groovy
Modifier and TypeMethodDescriptionGroovyScriptEvaluator.evaluate
(ScriptSource script) GroovyScriptEvaluator.evaluate
(ScriptSource script, Map<String, Object> arguments) protected Object
GroovyScriptFactory.executeScript
(ScriptSource scriptSource, Class<?> scriptClass) Instantiate the given Groovy script class and run it if necessary.GroovyScriptFactory.getScriptedObject
(ScriptSource scriptSource, Class<?>... actualInterfaces) Loads and parses the Groovy script via the GroovyClassLoader.Class<?>
GroovyScriptFactory.getScriptedObjectType
(ScriptSource scriptSource) Class<?>[]
GroovyScriptFactory.getScriptInterfaces()
Groovy scripts determine their interfaces themselves, hence we don't need to explicitly expose interfaces here.Modifier and TypeMethodDescriptionprotected groovy.lang.GroovyClassLoader
GroovyScriptFactory.buildGroovyClassLoader
(ClassLoader classLoader) Build aGroovyClassLoader
for the givenClassLoader
.GroovyScriptEvaluator.evaluate
(ScriptSource script, Map<String, Object> arguments) GroovyScriptFactory.getScriptedObject
(ScriptSource scriptSource, Class<?>... actualInterfaces) Loads and parses the Groovy script via the GroovyClassLoader.void
GroovyScriptEvaluator.setCompilerConfiguration
(org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration) Set a custom compiler configuration for this evaluator.ModifierConstructorDescriptionGroovyScriptEvaluator
(ClassLoader classLoader) Construct a new GroovyScriptEvaluator.GroovyScriptFactory
(String scriptSourceLocator, org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration) Create a new GroovyScriptFactory for the given script source, specifying a strategy interface that can create a custom MetaClass to supply missing methods and otherwise change the behavior of the object.GroovyScriptFactory
(String scriptSourceLocator, GroovyObjectCustomizer groovyObjectCustomizer) Create a new GroovyScriptFactory for the given script source, specifying a strategy interface that can create a custom MetaClass to supply missing methods and otherwise change the behavior of the object. -
Uses of Nullable in org.springframework.scripting.support
Modifier and TypeMethodDescriptionprotected Object
StandardScriptFactory.adaptToInterfaces
(Object script, ScriptSource scriptSource, Class<?>... actualInterfaces) StandardScriptEvaluator.evaluate
(ScriptSource script) StandardScriptEvaluator.evaluate
(ScriptSource script, Map<String, Object> argumentBindings) StandardScriptFactory.getScriptedObject
(ScriptSource scriptSource, Class<?>... actualInterfaces) Load and parse the script via JSR-223's ScriptEngine.Class<?>
StandardScriptFactory.getScriptedObjectType
(ScriptSource scriptSource) Class<?>[]
StandardScriptFactory.getScriptInterfaces()
Class<?>
ScriptFactoryPostProcessor.predictBeanType
(Class<?> beanClass, String beanName) protected ScriptEngine
StandardScriptFactory.retrieveScriptEngine
(ScriptSource scriptSource) ResourceScriptSource.suggestedClassName()
StaticScriptSource.suggestedClassName()
Modifier and TypeMethodDescriptionprotected Object
StandardScriptFactory.adaptToInterfaces
(Object script, ScriptSource scriptSource, Class<?>... actualInterfaces) protected Class<?>
ScriptFactoryPostProcessor.createConfigInterface
(BeanDefinition bd, Class<?>[] interfaces) Create a config interface for the given bean definition, defining setter methods for the defined property values as well as an init method and a destroy method (if defined).protected Object
ScriptFactoryPostProcessor.createRefreshableProxy
(TargetSource ts, Class<?>[] interfaces, boolean proxyTargetClass) Create a refreshable proxy for the given AOP TargetSource.protected BeanDefinition
ScriptFactoryPostProcessor.createScriptedObjectBeanDefinition
(BeanDefinition bd, String scriptFactoryBeanName, ScriptSource scriptSource, Class<?>[] interfaces) Create a bean definition for the scripted object, based on the given script definition, extracting the definition data that is relevant for the scripted object (that is, everything but bean class and constructor arguments).StandardScriptEvaluator.evaluate
(ScriptSource script, Map<String, Object> argumentBindings) StandardScriptFactory.getScriptedObject
(ScriptSource scriptSource, Class<?>... actualInterfaces) Load and parse the script via JSR-223's ScriptEngine.void
ResourceScriptSource.setEncoding
(String encoding) Set the encoding used for reading the script resource.ModifierConstructorDescriptionStandardScriptFactory
(String scriptEngineName, String scriptSourceLocator, Class<?>... scriptInterfaces) Create a new StandardScriptFactory for the given script source.StandardScriptFactory
(String scriptEngineName, String scriptSourceLocator, Class<?>... scriptInterfaces) Create a new StandardScriptFactory for the given script source.StaticScriptSource
(String script, String className) Create a new StaticScriptSource for the given script. -
Uses of Nullable in org.springframework.test.annotation
-
Uses of Nullable in org.springframework.test.context
Modifier and TypeMethodDescriptionContextCustomizerFactory.createContextCustomizer
(Class<?> testClass, List<ContextConfigurationAttributes> configAttributes) Create aContextCustomizer
that should be used to customize aConfigurableApplicationContext
before it is refreshed.static <T extends Annotation>
TestContextAnnotationUtils.AnnotationDescriptor<T>TestContextAnnotationUtils.findAnnotationDescriptor
(Class<?> clazz, Class<T> annotationType) Find theTestContextAnnotationUtils.AnnotationDescriptor
for the suppliedannotationType
on the suppliedClass
, traversing its annotations, interfaces, superclasses, and enclosing classes if no annotation can be found on the given class itself.TestContextAnnotationUtils.findAnnotationDescriptorForTypes
(Class<?> clazz, Class<? extends Annotation>... annotationTypes) Find theTestContextAnnotationUtils.UntypedAnnotationDescriptor
for the firstClass
in the inheritance hierarchy of the specifiedclazz
(including the specifiedclazz
itself) which declares at least one of the specifiedannotationTypes
.static <T extends Annotation>
TTestContextAnnotationUtils.findMergedAnnotation
(Class<?> clazz, Class<T> annotationType) Find the first annotation of the specifiedannotationType
within the annotation hierarchy above the supplied class, merge that annotation's attributes with matching attributes from annotations in lower levels of the annotation hierarchy, and synthesize the result back into an annotation of the specifiedannotationType
.Get theEnclosingConfiguration
enum constant with the supplied name, ignoring case.static TestConstructor.AutowireMode
Get theAutowireMode
enum constant with the supplied name, ignoring case.ContextConfigurationAttributes.getName()
Get the name of the context hierarchy level that was declared via@ContextConfiguration
.MergedContextConfiguration.getParent()
Get theMergedContextConfiguration
for the parent application context in a context hierarchy.MergedContextConfiguration.getParentApplicationContext()
Get the parentApplicationContext
for the context defined by thisMergedContextConfiguration
from the context cache.TestContext.getTestException()
Get the exception that was thrown during execution of the test method.TestContextAnnotationUtils.AnnotationDescriptor.next()
Find the nextTestContextAnnotationUtils.AnnotationDescriptor
for the specified annotation type in the hierarchy above the root declaring class of this descriptor.TestContextAnnotationUtils.UntypedAnnotationDescriptor.next()
Find the nextTestContextAnnotationUtils.UntypedAnnotationDescriptor
for the specified annotation types in the hierarchy above the root declaring class of this descriptor.Modifier and TypeMethodDescriptionvoid
TestContextManager.afterTestExecution
(Object testInstance, Method testMethod, Throwable exception) Hook for post-processing a test immediately after execution of the test method in the supplied test context — for example, for timing or logging purposes.void
TestContextManager.afterTestMethod
(Object testInstance, Method testMethod, Throwable exception) Hook for post-processing a test after execution of after lifecycle callbacks of the underlying test framework — for example, tearing down test fixtures, ending a transaction, etc.void
CacheAwareContextLoaderDelegate.closeContext
(MergedContextConfiguration mergedConfig, DirtiesContext.HierarchyMode hierarchyMode) Remove the application context for the suppliedMergedContextConfiguration
from theContextCache
and close it if it is an instance ofConfigurableApplicationContext
.boolean
Determine if the supplied object is equal to thisContextConfigurationAttributes
instance by comparing both object's declaring class, locations, annotated classes, inheritLocations flag, context initializer classes, inheritInitializers flag, and theContextLoader class
.boolean
Determine if the supplied object is equal to thisMergedContextConfiguration
instance by comparing both objects' locations, annotated classes, context initializer classes, active profiles, property source descriptors, property source properties, context customizers, parents, and the fully qualified names of theirContextLoaders
.Get theEnclosingConfiguration
enum constant with the supplied name, ignoring case.static TestConstructor.AutowireMode
Get theAutowireMode
enum constant with the supplied name, ignoring case.void
TestContext.markApplicationContextDirty
(DirtiesContext.HierarchyMode hierarchyMode) Call this method to signal that the application context associated with this test context is dirty and should be removed from the context cache.protected static String
MergedContextConfiguration.nullSafeClassName
(ContextLoader contextLoader) Generate a null-safeString
representation of the suppliedContextLoader
based solely on the fully qualified name of the loader or "null" if the supplied loader isnull
.default String[]
SmartContextLoader.processLocations
(Class<?> clazz, String... locations) SmartContextLoader
does not support deprecatedContextLoader
methods.protected static String[]
MergedContextConfiguration.processStrings
(String[] array) void
TestContext.updateState
(Object testInstance, Method testMethod, Throwable testException) Update this test context to reflect the state of the currently executing test.void
TestContext.updateState
(Object testInstance, Method testMethod, Throwable testException) Update this test context to reflect the state of the currently executing test.void
TestContext.updateState
(Object testInstance, Method testMethod, Throwable testException) Update this test context to reflect the state of the currently executing test.ModifierConstructorDescriptionContextConfigurationAttributes
(Class<?> declaringClass, String[] locations, Class<?>[] classes, boolean inheritLocations, Class<? extends ApplicationContextInitializer<?>>[] initializers, boolean inheritInitializers, String name, Class<? extends ContextLoader> contextLoaderClass) Construct a newContextConfigurationAttributes
instance for the test class that declared the@ContextConfiguration
annotation and its corresponding attributes.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, String[] activeProfiles, ContextLoader contextLoader) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, String[] activeProfiles, ContextLoader contextLoader) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, String[] activeProfiles, ContextLoader contextLoader) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters.MergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newMergedContextConfiguration
instance for the supplied parameters. -
Uses of Nullable in org.springframework.test.context.aot
Modifier and TypeMethodDescriptionAotTestContextInitializers.getContextInitializer
(Class<?> testClass) Get the AOTApplicationContextInitializer
for the specified test class.AotTestContextInitializers.getContextInitializerClass
(Class<?> testClass) Get the AOTApplicationContextInitializer
Class
for the specified test class.Retrieve the attribute value for the given name as aString
. -
Uses of Nullable in org.springframework.test.context.cache
Modifier and TypeMethodDescriptionContextCache.get
(MergedContextConfiguration key) Obtain a cachedApplicationContext
for the given key.DefaultContextCache.get
(MergedContextConfiguration key) Obtain a cachedApplicationContext
for the given key.Modifier and TypeMethodDescriptionvoid
DefaultCacheAwareContextLoaderDelegate.closeContext
(MergedContextConfiguration mergedConfig, DirtiesContext.HierarchyMode hierarchyMode) void
ContextCache.remove
(MergedContextConfiguration key, DirtiesContext.HierarchyMode hierarchyMode) Remove the context with the given key from the cache and explicitly close it if it is an instance ofConfigurableApplicationContext
.void
DefaultContextCache.remove
(MergedContextConfiguration key, DirtiesContext.HierarchyMode hierarchyMode) Remove the context with the given key from the cache and explicitly close it if it is an instance ofConfigurableApplicationContext
. -
Uses of Nullable in org.springframework.test.context.event
Modifier and TypeMethodDescriptionstatic ApplicationEvents
ApplicationEventsHolder.getApplicationEvents()
Get theApplicationEvents
for the current thread. -
Uses of Nullable in org.springframework.test.context.junit.jupiter
Modifier and TypeMethodDescriptionSpringExtension.resolveParameter
(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext) Resolve a value for theParameter
in the suppliedParameterContext
by retrieving the corresponding dependency from the test'sApplicationContext
. -
Uses of Nullable in org.springframework.test.context.junit4
Modifier and TypeFieldDescriptionprotected ApplicationContext
AbstractJUnit4SpringContextTests.applicationContext
TheApplicationContext
that was injected into this test instance viaAbstractJUnit4SpringContextTests.setApplicationContext(ApplicationContext)
.Modifier and TypeMethodDescriptionSpringJUnit4ClassRunner.getExpectedException
(FrameworkMethod frameworkMethod) Get theexception
that the supplied test method is expected to throw. -
Uses of Nullable in org.springframework.test.context.junit4.statements
ModifierConstructorDescriptionProfileValueChecker
(Statement next, Class<?> testClass, Method testMethod) Construct a newProfileValueChecker
statement. -
Uses of Nullable in org.springframework.test.context.support
Modifier and TypeMethodDescriptionGet the value of the named property.DefaultTestContext.getAttribute
(String name) final Throwable
DefaultTestContext.getTestException()
DefaultTestContext.removeAttribute
(String name) protected Class<? extends ContextLoader>
AbstractTestContextBootstrapper.resolveExplicitContextLoaderClass
(List<ContextConfigurationAttributes> configAttributesList) Modifier and TypeMethodDescriptionprotected void
AbstractDirtiesContextTestExecutionListener.dirtyContext
(TestContext testContext, DirtiesContext.HierarchyMode hierarchyMode) Mark the application context of the supplied test context as dirty and setREINJECT_DEPENDENCIES_ATTRIBUTE
in the test context totrue
.static boolean
TestConstructorUtils.isAutowirableConstructor
(Constructor<?> constructor, Class<?> testClass, PropertyProvider fallbackPropertyProvider) Determine if the supplied constructor for the given test class is autowirable.static boolean
TestConstructorUtils.isAutowirableConstructor
(Executable executable, Class<?> testClass, PropertyProvider fallbackPropertyProvider) Determine if the supplied executable for the given test class is an autowirable constructor.void
DefaultTestContext.markApplicationContextDirty
(DirtiesContext.HierarchyMode hierarchyMode) Mark the application context associated with this test context as dirty (i.e., by removing it from the context cache and closing it).void
DefaultTestContext.setAttribute
(String name, Object value) void
DefaultTestContext.updateState
(Object testInstance, Method testMethod, Throwable testException) void
DefaultTestContext.updateState
(Object testInstance, Method testMethod, Throwable testException) void
DefaultTestContext.updateState
(Object testInstance, Method testMethod, Throwable testException) -
Uses of Nullable in org.springframework.test.context.testng
Modifier and TypeFieldDescriptionprotected ApplicationContext
AbstractTestNGSpringContextTests.applicationContext
TheApplicationContext
that was injected into this test instance viaAbstractTestNGSpringContextTests.setApplicationContext(ApplicationContext)
. -
Uses of Nullable in org.springframework.test.context.transaction
Modifier and TypeMethodDescriptionprotected PlatformTransactionManager
TransactionalTestExecutionListener.getTransactionManager
(TestContext testContext) Get the transaction manager to use for the supplied test context.protected PlatformTransactionManager
TransactionalTestExecutionListener.getTransactionManager
(TestContext testContext, String qualifier) static DataSource
TestContextTransactionUtils.retrieveDataSource
(TestContext testContext, String name) Retrieve theDataSource
to use for the supplied test context.static PlatformTransactionManager
TestContextTransactionUtils.retrieveTransactionManager
(TestContext testContext, String name) Retrieve the transaction manager to use for the supplied test context.Modifier and TypeMethodDescriptionprotected PlatformTransactionManager
TransactionalTestExecutionListener.getTransactionManager
(TestContext testContext, String qualifier) static DataSource
TestContextTransactionUtils.retrieveDataSource
(TestContext testContext, String name) Retrieve theDataSource
to use for the supplied test context.static PlatformTransactionManager
TestContextTransactionUtils.retrieveTransactionManager
(TestContext testContext, String name) Retrieve the transaction manager to use for the supplied test context. -
Uses of Nullable in org.springframework.test.context.web
Modifier and TypeMethodDescriptionboolean
Determine if the supplied object is equal to thisWebMergedContextConfiguration
instance by comparing both objects' locations, annotated classes, context initializer classes, active profiles, resource base paths, property source descriptors, property source properties, context customizers, parents, and the fully qualified names of theirContextLoaders
.ModifierConstructorDescriptionWebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newWebMergedContextConfiguration
instance for the supplied parameters.WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newWebMergedContextConfiguration
instance for the supplied parameters.WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newWebMergedContextConfiguration
instance for the supplied parameters.WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newWebMergedContextConfiguration
instance for the supplied parameters.WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newWebMergedContextConfiguration
instance for the supplied parameters.WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newWebMergedContextConfiguration
instance for the supplied parameters.WebMergedContextConfiguration
(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a newWebMergedContextConfiguration
instance for the supplied parameters. -
Uses of Nullable in org.springframework.test.util
Modifier and TypeMethodDescriptionJsonPathExpectationsHelper.evaluateJsonPath
(String content) Evaluate the JSON path and return the resulting value.<T> T
XpathExpectationsHelper.evaluateXpath
(byte[] content, String encoding, Class<T> targetClass) Evaluate the XPath and return the resulting value.protected <T> T
XpathExpectationsHelper.evaluateXpath
(Document document, QName evaluationType, Class<T> expectedClass) Apply the XPath expression to given document.static Object
static Object
static Object
static Object
ReflectionTestUtils.invokeGetterMethod
(Object target, String name) Invoke the getter method with the givenname
on the supplied target object with the suppliedvalue
.static <T> T
ReflectionTestUtils.invokeMethod
(Class<?> targetClass, String name, Object... args) Invoke the static method with the givenname
on the supplied target class with the supplied arguments.static <T> T
ReflectionTestUtils.invokeMethod
(Object targetObject, Class<?> targetClass, String name, Object... args) Invoke the method with the givenname
on the providedtargetObject
/targetClass
with the supplied arguments.static <T> T
ReflectionTestUtils.invokeMethod
(Object target, String name, Object... args) Invoke the method with the givenname
on the supplied target object with the supplied arguments.Modifier and TypeMethodDescriptionvoid
XpathExpectationsHelper.assertBoolean
(byte[] content, String encoding, boolean expectedValue) Apply the XPath expression and assert the resulting content as a Boolean.static void
AssertionErrors.assertEquals
(String message, Object expected, Object actual) Assert two objects are equal and raise anAssertionError
otherwise.static void
AssertionErrors.assertEquals
(String message, Object expected, Object actual) Assert two objects are equal and raise anAssertionError
otherwise.void
XpathExpectationsHelper.assertNode
(byte[] content, String encoding, Matcher<? super Node> matcher) Parse the content, evaluate the XPath expression as aNode
, and assert it with the givenMatcher<Node>
.void
XpathExpectationsHelper.assertNodeCount
(byte[] content, String encoding, int expectedCount) Apply the XPath expression and assert the resulting content as an integer.void
XpathExpectationsHelper.assertNodeCount
(byte[] content, String encoding, Matcher<? super Integer> matcher) Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.void
XpathExpectationsHelper.assertNodeList
(byte[] content, String encoding, Matcher<? super NodeList> matcher) Parse the content, evaluate the XPath expression as aNodeList
, and assert it with the givenMatcher<NodeList>
.static void
AssertionErrors.assertNotEquals
(String message, Object expected, Object actual) Assert two objects are not equal and raise anAssertionError
otherwise.static void
AssertionErrors.assertNotEquals
(String message, Object expected, Object actual) Assert two objects are not equal and raise anAssertionError
otherwise.static void
AssertionErrors.assertNotNull
(String message, Object object) Assert that the given object is notnull
and raise anAssertionError
otherwise.static void
AssertionErrors.assertNull
(String message, Object object) Assert that the given object isnull
and raise anAssertionError
otherwise.void
XpathExpectationsHelper.assertNumber
(byte[] content, String encoding, Double expectedValue) Apply the XPath expression and assert the resulting content as a Double.void
XpathExpectationsHelper.assertNumber
(byte[] content, String encoding, Matcher<? super Double> matcher) Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.void
XpathExpectationsHelper.assertString
(byte[] content, String encoding, String expectedValue) Apply the XPath expression and assert the resulting content as a String.void
XpathExpectationsHelper.assertString
(byte[] content, String encoding, Matcher<? super String> matcher) Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.void
JsonPathExpectationsHelper.assertValue
(String content, Object expectedValue) Evaluate the JSON path expression against the suppliedcontent
and assert that the result is equal to the expected value.void
XpathExpectationsHelper.doesNotExist
(byte[] content, String encoding) Apply the XPath expression and assert the resulting content does not exist.<T> T
XpathExpectationsHelper.evaluateXpath
(byte[] content, String encoding, Class<T> targetClass) Evaluate the XPath and return the resulting value.void
Apply the XPath expression and assert the resulting content exists.static void
Fail a test with the given message passing along expected and actual values to be appended to the message.static void
Fail a test with the given message passing along expected and actual values to be appended to the message.static Object
static Object
static <T> T
ReflectionTestUtils.invokeMethod
(Object targetObject, Class<?> targetClass, String name, Object... args) Invoke the method with the givenname
on the providedtargetObject
/targetClass
with the supplied arguments.static <T> T
ReflectionTestUtils.invokeMethod
(Object targetObject, Class<?> targetClass, String name, Object... args) Invoke the method with the givenname
on the providedtargetObject
/targetClass
with the supplied arguments.static void
ReflectionTestUtils.invokeSetterMethod
(Object target, String name, Object value, Class<?> type) Invoke the setter method with the givenname
on the supplied target object with the suppliedvalue
.static void
ReflectionTestUtils.invokeSetterMethod
(Object target, String name, Object value, Class<?> type) Invoke the setter method with the givenname
on the supplied target object with the suppliedvalue
.protected Document
XpathExpectationsHelper.parseXmlByteArray
(byte[] xml, String encoding) Parse the given XML content to aDocument
.static void
static void
static void
static void
static void
ReflectionTestUtils.setField
(Object targetObject, Class<?> targetClass, String name, Object value, Class<?> type) Set the field with the givenname
/type
on the providedtargetObject
/targetClass
to the suppliedvalue
.static void
ReflectionTestUtils.setField
(Object targetObject, Class<?> targetClass, String name, Object value, Class<?> type) Set the field with the givenname
/type
on the providedtargetObject
/targetClass
to the suppliedvalue
.static void
ReflectionTestUtils.setField
(Object targetObject, Class<?> targetClass, String name, Object value, Class<?> type) Set the field with the givenname
/type
on the providedtargetObject
/targetClass
to the suppliedvalue
.static void
ReflectionTestUtils.setField
(Object targetObject, Class<?> targetClass, String name, Object value, Class<?> type) Set the field with the givenname
/type
on the providedtargetObject
/targetClass
to the suppliedvalue
.static void
ReflectionTestUtils.setField
(Object targetObject, Class<?> targetClass, String name, Object value, Class<?> type) Set the field with the givenname
/type
on the providedtargetObject
/targetClass
to the suppliedvalue
.static void
static void
static void
static void
-
Uses of Nullable in org.springframework.test.web.client
Modifier and TypeMethodDescriptionAbstractRequestExpectationManager.RequestExpectationGroup.findExpectation
(ClientHttpRequest request) Return a matching expectation, ornull
if none match.protected ResponseCreator
DefaultRequestExpectation.getResponseCreator()
Modifier and TypeMethodDescriptionDefaultRequestExpectation.createResponse
(ClientHttpRequest request) Note that as of 5.0.3, the creation of the response, which may block intentionally, is separated from request count tracking, and this method no longer increments the count transparently.ResponseCreator.createResponse
(ClientHttpRequest request) Create a response for the given request. -
Uses of Nullable in org.springframework.test.web.client.match
-
Uses of Nullable in org.springframework.test.web.client.response
Modifier and TypeMethodDescriptionDefaultResponseCreator.createResponse
(ClientHttpRequest request) static DefaultResponseCreator
MockRestResponseCreators.withSuccess
(byte[] body, MediaType contentType) ResponseCreator
for a 200 response (OK) with byte[] body.static DefaultResponseCreator
MockRestResponseCreators.withSuccess
(String body, MediaType contentType) ResponseCreator
for a 200 response (OK) with String body.static DefaultResponseCreator
MockRestResponseCreators.withSuccess
(Resource body, MediaType contentType) ResponseCreator
for a 200 response (OK) content withResource
-based body. -
Uses of Nullable in org.springframework.test.web.reactive.server
Modifier and TypeMethodDescriptionExchangeResult.getMockServerResult()
Return the result from the mock server exchange, if applicable, for further assertions on the state of the server response.byte[]
ExchangeResult.getRequestBodyContent()
Return the raw request body content written through the request.EntityExchangeResult.getResponseBody()
Return the entity extracted from the response body.byte[]
ExchangeResult.getResponseBodyContent()
Return the raw request body content written to the response.ExchangeResult.getUriTemplate()
Return the original URI template used to prepare the request, if any.Modifier and TypeMethodDescriptionvoid
WebTestClientConfigurer.afterConfigurerAdded
(WebTestClient.Builder builder, WebHttpHandlerBuilder httpHandlerBuilder, ClientHttpConnector connector) Invoked once only, immediately (i.e.void
WebTestClientConfigurer.afterConfigurerAdded
(WebTestClient.Builder builder, WebHttpHandlerBuilder httpHandlerBuilder, ClientHttpConnector connector) Invoked once only, immediately (i.e.boolean
boolean
WebTestClient.BodyContentSpec.xpath
(String expression, Map<String, String> namespaces, Object... args) Access to response body assertions with specific namespaces using an XPath expression to inspect a specific subset of the body. -
Uses of Nullable in org.springframework.test.web.servlet
Modifier and TypeMethodDescriptionMvcResult.getHandler()
Return the executed handler.MvcResult.getInterceptors()
Return interceptors around the handler.MvcResult.getModelAndView()
Return theModelAndView
prepared by the handler.MvcResult.getResolvedException()
Return any exception raised by a handler and successfully resolved through aHandlerExceptionResolver
.Modifier and TypeMethodDescriptionprotected final MockMvc
MockMvcBuilderSupport.createMockMvc
(Filter[] filters, MockServletConfig servletConfig, WebApplicationContext webAppContext, RequestBuilder defaultRequestBuilder, Charset defaultResponseCharacterEncoding, List<ResultMatcher> globalResultMatchers, List<ResultHandler> globalResultHandlers, List<DispatcherServletCustomizer> dispatcherServletCustomizers) Delegates toMockMvcBuilderSupport.createMockMvc(Filter[], MockServletConfig, WebApplicationContext, RequestBuilder, List, List, List)
for creation of theMockMvc
instance and configures that instance with the supplieddefaultResponseCharacterEncoding
.protected final MockMvc
MockMvcBuilderSupport.createMockMvc
(Filter[] filters, MockServletConfig servletConfig, WebApplicationContext webAppContext, RequestBuilder defaultRequestBuilder, Charset defaultResponseCharacterEncoding, List<ResultMatcher> globalResultMatchers, List<ResultHandler> globalResultHandlers, List<DispatcherServletCustomizer> dispatcherServletCustomizers) Delegates toMockMvcBuilderSupport.createMockMvc(Filter[], MockServletConfig, WebApplicationContext, RequestBuilder, List, List, List)
for creation of theMockMvc
instance and configures that instance with the supplieddefaultResponseCharacterEncoding
.protected final MockMvc
MockMvcBuilderSupport.createMockMvc
(Filter[] filters, MockServletConfig servletConfig, WebApplicationContext webAppContext, RequestBuilder defaultRequestBuilder, Charset defaultResponseCharacterEncoding, List<ResultMatcher> globalResultMatchers, List<ResultHandler> globalResultHandlers, List<DispatcherServletCustomizer> dispatcherServletCustomizers) Delegates toMockMvcBuilderSupport.createMockMvc(Filter[], MockServletConfig, WebApplicationContext, RequestBuilder, List, List, List)
for creation of theMockMvc
instance and configures that instance with the supplieddefaultResponseCharacterEncoding
.protected final MockMvc
MockMvcBuilderSupport.createMockMvc
(Filter[] filters, MockServletConfig servletConfig, WebApplicationContext webAppContext, RequestBuilder defaultRequestBuilder, List<ResultMatcher> globalResultMatchers, List<ResultHandler> globalResultHandlers, List<DispatcherServletCustomizer> dispatcherServletCustomizers) protected final MockMvc
MockMvcBuilderSupport.createMockMvc
(Filter[] filters, MockServletConfig servletConfig, WebApplicationContext webAppContext, RequestBuilder defaultRequestBuilder, List<ResultMatcher> globalResultMatchers, List<ResultHandler> globalResultHandlers, List<DispatcherServletCustomizer> dispatcherServletCustomizers) -
Uses of Nullable in org.springframework.test.web.servlet.client
Modifier and TypeMethodDescriptionMockMvcWebTestClient.ControllerSpec.mappedInterceptors
(String[] pathPatterns, HandlerInterceptor... interceptors) Add interceptors for specific patterns. -
Uses of Nullable in org.springframework.test.web.servlet.htmlunit
ModifierConstructorDescriptionMockMvcWebConnection
(MockMvc mockMvc, com.gargoylesoftware.htmlunit.WebClient webClient, String contextPath) Create a new instance with the specified context path. -
Uses of Nullable in org.springframework.test.web.servlet.request
Modifier and TypeMethodDescriptionSet the locale of the request, overriding any previous locales.Merges the properties of the "parent" RequestBuilder accepting values only if not already set in "this" instance.Specify the portion of the requestURI that represents the pathInfo. -
Uses of Nullable in org.springframework.test.web.servlet.result
Modifier and TypeMethodDescriptionRequestResultMatchers.asyncResult
(Object expectedResult) Assert the result from asynchronous processing.Assert a flash attribute's value.Assert a model attribute value.Assert a request attribute value.static ResultMatcher
MockMvcResultMatchers.forwardedUrl
(String expectedUrl) Asserts the request was forwarded to the given URL.protected void
PrintingResultHandler.printHandler
(Object handler, HandlerInterceptor[] interceptors) Print the handler.protected void
PrintingResultHandler.printHandler
(Object handler, HandlerInterceptor[] interceptors) Print the handler.protected void
PrintingResultHandler.printModelAndView
(ModelAndView mav) Print the ModelAndView.protected void
PrintingResultHandler.printResolvedException
(Exception resolvedException) Print exceptions resolved through a HandlerExceptionResolver.void
PrintingResultHandler.ResultValuePrinter.printValue
(String label, Object value) RequestResultMatchers.sessionAttribute
(String name, Object value) Assert a session attribute value.Evaluate the JSON path expression against the response content and assert that the result is equal to the supplied value. -
Uses of Nullable in org.springframework.test.web.servlet.setup
Modifier and TypeMethodDescriptiondefault RequestPostProcessor
MockMvcConfigurer.beforeMockMvcCreated
(ConfigurableMockMvcBuilder<?> builder, WebApplicationContext context) Invoked when the MockMvc instance is about to be created with the MockMvc builder and the Spring WebApplicationContext that will be passed to theDispatcherServlet
.MockMvcConfigurerAdapter.beforeMockMvcCreated
(ConfigurableMockMvcBuilder<?> builder, WebApplicationContext cxt) Modifier and TypeMethodDescriptionStandaloneMockMvcBuilder.addMappedInterceptors
(String[] pathPatterns, HandlerInterceptor... interceptors) Add interceptors mapped to a set of path patterns.StandaloneMockMvcBuilder.extendMvcSingletons
(ServletContext servletContext) This method could be used from a subclass to register additional Spring MVC infrastructure such as additionalHandlerMapping
,HandlerAdapter
, and others.StandaloneMockMvcBuilder.setPatternParser
(PathPatternParser parser) Enable URL path matching with parsedPathPatterns
instead of String pattern matching with aPathMatcher
. -
Uses of Nullable in org.springframework.transaction
Modifier and TypeMethodDescriptionfinal Throwable
TransactionSystemException.getApplicationException()
Return the application exception that was thrown before this transaction exception, if any.default String
TransactionDefinition.getName()
Return the name of this transaction.TransactionSystemException.getOriginalException()
Return the exception that was the first to be thrown within the failed transaction: i.e.Modifier and TypeMethodDescriptiondefault void
TransactionExecutionListener.afterBegin
(TransactionExecution transaction, Throwable beginFailure) Callback after the transaction begin step.default void
TransactionExecutionListener.afterCommit
(TransactionExecution transaction, Throwable commitFailure) Callback after the transaction commit step.default void
TransactionExecutionListener.afterRollback
(TransactionExecution transaction, Throwable rollbackFailure) Callback after the transaction rollback step.boolean
reactor.core.publisher.Mono<ReactiveTransaction>
ReactiveTransactionManager.getReactiveTransaction
(TransactionDefinition definition) Emit a currently active reactive transaction or create a new one, according to the specified propagation behavior.PlatformTransactionManager.getTransaction
(TransactionDefinition definition) Return a currently active transaction or create a new one, according to the specified propagation behavior. -
Uses of Nullable in org.springframework.transaction.annotation
Modifier and TypeFieldDescriptionprotected AnnotationAttributes
AbstractTransactionManagementConfiguration.enableTx
protected TransactionManager
AbstractTransactionManagementConfiguration.txManager
Default transaction manager, as configured through aTransactionManagementConfigurer
.Modifier and TypeMethodDescriptionprotected TransactionAttribute
AnnotationTransactionAttributeSource.determineTransactionAttribute
(AnnotatedElement element) Determine the transaction attribute for the given method or class.protected TransactionAttribute
AnnotationTransactionAttributeSource.findTransactionAttribute
(Class<?> clazz) protected TransactionAttribute
AnnotationTransactionAttributeSource.findTransactionAttribute
(Method method) Ejb3TransactionAnnotationParser.parseTransactionAnnotation
(AnnotatedElement element) JtaTransactionAnnotationParser.parseTransactionAnnotation
(AnnotatedElement element) SpringTransactionAnnotationParser.parseTransactionAnnotation
(AnnotatedElement element) TransactionAnnotationParser.parseTransactionAnnotation
(AnnotatedElement element) Parse the transaction attribute for the given method or class, based on an annotation type understood by this parser. -
Uses of Nullable in org.springframework.transaction.config
-
Uses of Nullable in org.springframework.transaction.event
Modifier and TypeMethodDescriptiondefault void
TransactionalApplicationListener.SynchronizationCallback.postProcessEvent
(ApplicationEvent event, Throwable ex) Called after a transactional event listener invocation. -
Uses of Nullable in org.springframework.transaction.interceptor
Modifier and TypeMethodDescriptionprotected TransactionAttribute
AbstractFallbackTransactionAttributeSource.computeTransactionAttribute
(Method method, Class<?> targetClass) Same signature asAbstractFallbackTransactionAttributeSource.getTransactionAttribute(java.lang.reflect.Method, java.lang.Class<?>)
, but doesn't cache the result.protected static TransactionAspectSupport.TransactionInfo
TransactionAspectSupport.currentTransactionInfo()
Subclasses can use this to return the current TransactionInfo.protected TransactionManager
TransactionAspectSupport.determineTransactionManager
(TransactionAttribute txAttr) Determine the specific transaction manager to use for the given transaction.protected abstract TransactionAttribute
AbstractFallbackTransactionAttributeSource.findTransactionAttribute
(Class<?> clazz) Subclasses need to implement this to return the transaction attribute for the given class, if any.protected abstract TransactionAttribute
AbstractFallbackTransactionAttributeSource.findTransactionAttribute
(Method method) Subclasses need to implement this to return the transaction attribute for the given method, if any.protected final BeanFactory
TransactionAspectSupport.getBeanFactory()
Return the BeanFactory to use for retrievingTransactionManager
beans.DefaultTransactionAttribute.getDescriptor()
Return a descriptor for this transaction attribute, ornull
if none.DefaultTransactionAttribute.getQualifier()
Return a qualifier value associated with this transaction attribute.DelegatingTransactionAttribute.getQualifier()
TransactionAttribute.getQualifier()
Return a qualifier value associated with this transaction attribute.DefaultTransactionAttribute.getTimeoutString()
Return the timeout to apply, if any, as a String value that resolves to a number of seconds.AbstractFallbackTransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) Determine the transaction attribute for this method invocation.CompositeTransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) MatchAlwaysTransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) MethodMapTransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) NameMatchTransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) TransactionAspectSupport.TransactionInfo.getTransactionAttribute()
TransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) Return the transaction attribute for the given method, ornull
if the method is non-transactional.TransactionAspectSupport.getTransactionAttributeSource()
Return the transaction attribute source.TransactionAspectSupport.getTransactionManager()
Return the default transaction manager, ornull
if unknown.protected final String
TransactionAspectSupport.getTransactionManagerBeanName()
Return the name of the default transaction manager bean.TransactionAspectSupport.TransactionInfo.getTransactionStatus()
TransactionInterceptor.invoke
(MethodInvocation invocation) protected Object
TransactionAspectSupport.invokeWithinTransaction
(Method method, Class<?> targetClass, TransactionAspectSupport.InvocationCallback invocation) General delegate for around-advice-based subclasses, delegating to several other template methods on this class.protected String
TransactionAspectSupport.methodIdentification
(Method method, Class<?> targetClass) Convenience method to return a String representation of this Method for use in logging.TransactionAspectSupport.InvocationCallback.proceedWithInvocation()
Modifier and TypeMethodDescriptionprotected void
TransactionAspectSupport.cleanupTransactionInfo
(TransactionAspectSupport.TransactionInfo txInfo) Reset the TransactionInfo ThreadLocal.protected void
TransactionAspectSupport.commitTransactionAfterReturning
(TransactionAspectSupport.TransactionInfo txInfo) Execute after successful completion of call, but not after an exception was handled.protected void
TransactionAspectSupport.completeTransactionAfterThrowing
(TransactionAspectSupport.TransactionInfo txInfo, Throwable ex) Handle a throwable, completing the transaction.protected TransactionAttribute
AbstractFallbackTransactionAttributeSource.computeTransactionAttribute
(Method method, Class<?> targetClass) Same signature asAbstractFallbackTransactionAttributeSource.getTransactionAttribute(java.lang.reflect.Method, java.lang.Class<?>)
, but doesn't cache the result.protected TransactionAspectSupport.TransactionInfo
TransactionAspectSupport.createTransactionIfNecessary
(PlatformTransactionManager tm, TransactionAttribute txAttr, String joinpointIdentification) Create a transaction if necessary based on the given TransactionAttribute.protected TransactionAspectSupport.TransactionInfo
TransactionAspectSupport.createTransactionIfNecessary
(PlatformTransactionManager tm, TransactionAttribute txAttr, String joinpointIdentification) Create a transaction if necessary based on the given TransactionAttribute.protected TransactionManager
TransactionAspectSupport.determineTransactionManager
(TransactionAttribute txAttr) Determine the specific transaction manager to use for the given transaction.boolean
boolean
boolean
boolean
protected Object
AbstractFallbackTransactionAttributeSource.getCacheKey
(Method method, Class<?> targetClass) Determine a cache key for the given method and target class.AbstractFallbackTransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) Determine the transaction attribute for this method invocation.CompositeTransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) MatchAlwaysTransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) MethodMapTransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) NameMatchTransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) TransactionAttributeSource.getTransactionAttribute
(Method method, Class<?> targetClass) Return the transaction attribute for the given method, ornull
if the method is non-transactional.protected void
MethodMapTransactionAttributeSource.initMethodMap
(Map<String, TransactionAttribute> methodMap) Initialize the specified"methodMap"
, if any.protected Object
TransactionAspectSupport.invokeWithinTransaction
(Method method, Class<?> targetClass, TransactionAspectSupport.InvocationCallback invocation) General delegate for around-advice-based subclasses, delegating to several other template methods on this class.protected String
TransactionAspectSupport.methodIdentification
(Method method, Class<?> targetClass) Convenience method to return a String representation of this Method for use in logging.void
TransactionAspectSupport.TransactionInfo.newTransactionStatus
(TransactionStatus status) protected TransactionAspectSupport.TransactionInfo
TransactionAspectSupport.prepareTransactionInfo
(PlatformTransactionManager tm, TransactionAttribute txAttr, String joinpointIdentification, TransactionStatus status) Prepare a TransactionInfo for the given attribute and status object.protected TransactionAspectSupport.TransactionInfo
TransactionAspectSupport.prepareTransactionInfo
(PlatformTransactionManager tm, TransactionAttribute txAttr, String joinpointIdentification, TransactionStatus status) Prepare a TransactionInfo for the given attribute and status object.protected TransactionAspectSupport.TransactionInfo
TransactionAspectSupport.prepareTransactionInfo
(PlatformTransactionManager tm, TransactionAttribute txAttr, String joinpointIdentification, TransactionStatus status) Prepare a TransactionInfo for the given attribute and status object.void
DefaultTransactionAttribute.resolveAttributeStrings
(StringValueResolver resolver) Resolve attribute values that are defined as resolvable Strings:DefaultTransactionAttribute.setTimeoutString(java.lang.String)
,DefaultTransactionAttribute.setQualifier(java.lang.String)
,DefaultTransactionAttribute.setLabels(java.util.Collection<java.lang.String>)
.void
TransactionAspectSupport.setBeanFactory
(BeanFactory beanFactory) Set the BeanFactory to use for retrievingTransactionManager
beans.void
DefaultTransactionAttribute.setDescriptor
(String descriptor) Set a descriptor for this transaction attribute, e.g.void
DefaultTransactionAttribute.setQualifier
(String qualifier) Associate a qualifier value with this transaction attribute.void
DefaultTransactionAttribute.setTimeoutString
(String timeoutString) Set the timeout to apply, if any, as a String value that resolves to a number of seconds.void
TransactionAspectSupport.setTransactionAttributeSource
(TransactionAttributeSource transactionAttributeSource) Set the transaction attribute source which is used to find transaction attributes.void
TransactionAspectSupport.setTransactionManager
(TransactionManager transactionManager) Specify the default transaction manager to use to drive transactions.void
TransactionAspectSupport.setTransactionManagerBeanName
(String transactionManagerBeanName) Specify the name of the default transaction manager bean.ModifierConstructorDescriptionTransactionInfo
(PlatformTransactionManager transactionManager, TransactionAttribute transactionAttribute, String joinpointIdentification) TransactionInfo
(PlatformTransactionManager transactionManager, TransactionAttribute transactionAttribute, String joinpointIdentification) -
Uses of Nullable in org.springframework.transaction.jta
Modifier and TypeMethodDescriptionprotected TransactionManager
JtaTransactionManager.findTransactionManager
(UserTransaction ut) Find the JTA TransactionManager through autodetection: checking whether the UserTransaction object implements the TransactionManager, and checking the fallback JNDI locations.protected TransactionSynchronizationRegistry
JtaTransactionManager.findTransactionSynchronizationRegistry
(UserTransaction ut, TransactionManager tm) Find the JTA 1.1 TransactionSynchronizationRegistry through autodetection: checking whether the UserTransaction object or TransactionManager object implements it, and checking Jakarta EE's standard JNDI location.protected UserTransaction
JtaTransactionManager.findUserTransaction()
Find the JTA UserTransaction through a default JNDI lookup: "java:comp/UserTransaction".JtaTransactionManager.getJndiEnvironment()
Return the JNDI environment to use for JNDI lookups.JtaTransactionManager.getTransactionManager()
Return the JTA TransactionManager that this transaction manager uses, if any.JtaTransactionManager.getTransactionSynchronizationRegistry()
Return the JTA 1.1 TransactionSynchronizationRegistry that this transaction manager uses, if any.JtaTransactionManager.getUserTransaction()
Return the JTA UserTransaction that this transaction manager uses.protected TransactionManager
JtaTransactionManager.retrieveTransactionManager()
Allows subclasses to retrieve the JTA TransactionManager in a vendor-specific manner.protected TransactionSynchronizationRegistry
JtaTransactionManager.retrieveTransactionSynchronizationRegistry()
Allows subclasses to retrieve the JTA 1.1 TransactionSynchronizationRegistry in a vendor-specific manner.protected UserTransaction
JtaTransactionManager.retrieveUserTransaction()
Allows subclasses to retrieve the JTA UserTransaction in a vendor-specific manner.Modifier and TypeMethodDescriptionJtaTransactionManager.createTransaction
(String name, int timeout) SimpleTransactionFactory.createTransaction
(String name, int timeout) TransactionFactory.createTransaction
(String name, int timeout) Create an active Transaction object based on the given name and timeout.protected void
JtaTransactionManager.doJtaResume
(JtaTransactionObject txObject, Object suspendedTransaction) Perform a JTA resume on the JTA TransactionManager.protected void
protected TransactionManager
JtaTransactionManager.findTransactionManager
(UserTransaction ut) Find the JTA TransactionManager through autodetection: checking whether the UserTransaction object implements the TransactionManager, and checking the fallback JNDI locations.protected TransactionSynchronizationRegistry
JtaTransactionManager.findTransactionSynchronizationRegistry
(UserTransaction ut, TransactionManager tm) Find the JTA 1.1 TransactionSynchronizationRegistry through autodetection: checking whether the UserTransaction object or TransactionManager object implements it, and checking Jakarta EE's standard JNDI location.protected TransactionSynchronizationRegistry
JtaTransactionManager.findTransactionSynchronizationRegistry
(UserTransaction ut, TransactionManager tm) Find the JTA 1.1 TransactionSynchronizationRegistry through autodetection: checking whether the UserTransaction object or TransactionManager object implements it, and checking Jakarta EE's standard JNDI location.void
JtaTransactionManager.setJndiEnvironment
(Properties jndiEnvironment) Set the JNDI environment to use for JNDI lookups.void
JtaTransactionManager.setTransactionManager
(TransactionManager transactionManager) Set the JTA TransactionManager to use as direct reference.void
JtaTransactionManager.setTransactionSynchronizationRegistry
(TransactionSynchronizationRegistry transactionSynchronizationRegistry) Set the JTA 1.1 TransactionSynchronizationRegistry to use as direct reference.void
JtaTransactionManager.setUserTransaction
(UserTransaction userTransaction) Set the JTA UserTransaction to use as direct reference.ModifierConstructorDescriptionSpringJtaSynchronizationAdapter
(TransactionSynchronization springSynchronization, TransactionManager jtaTransactionManager) Deprecated.as of 6.0.12 since JTA 1.1+ requires implicit rollback-only setting in case of an exception thrown inbeforeCompletion
, so the regularSpringJtaSynchronizationAdapter(TransactionSynchronization)
constructor is sufficient for all scenariosSpringJtaSynchronizationAdapter
(TransactionSynchronization springSynchronization, UserTransaction jtaUserTransaction) Deprecated.as of 6.0.12 since JTA 1.1+ requires implicit rollback-only setting in case of an exception thrown inbeforeCompletion
, so the regularSpringJtaSynchronizationAdapter(TransactionSynchronization)
constructor is sufficient for all scenarios -
Uses of Nullable in org.springframework.transaction.reactive
Modifier and TypeMethodDescriptionTransactionContext.getCurrentTransactionIsolationLevel()
TransactionSynchronizationManager.getCurrentTransactionIsolationLevel()
Return the isolation level for the current transaction, if any.TransactionContext.getCurrentTransactionName()
TransactionSynchronizationManager.getCurrentTransactionName()
Return the name of the current transaction, ornull
if none set.TransactionContext.getParent()
TransactionSynchronizationManager.getResource
(Object key) Retrieve a resource for the given key that is bound to the current context.GenericReactiveTransaction.getSuspendedResources()
Return the holder for resources that have been suspended for this transaction, if any.TransactionContext.getSynchronizations()
TransactionSynchronizationManager.unbindResourceIfPossible
(Object key) Unbind a resource for the given key from the current context.Modifier and TypeMethodDescriptionprotected reactor.core.publisher.Mono<Void>
AbstractReactiveTransactionManager.doResume
(TransactionSynchronizationManager synchronizationManager, Object transaction, Object suspendedResources) Resume the resources of the current transaction.final reactor.core.publisher.Mono<ReactiveTransaction>
AbstractReactiveTransactionManager.getReactiveTransaction
(TransactionDefinition definition) This implementation handles propagation behavior.void
TransactionContext.setCurrentTransactionIsolationLevel
(Integer currentTransactionIsolationLevel) void
TransactionSynchronizationManager.setCurrentTransactionIsolationLevel
(Integer isolationLevel) Expose an isolation level for the current transaction.void
TransactionContext.setCurrentTransactionName
(String currentTransactionName) void
TransactionSynchronizationManager.setCurrentTransactionName
(String name) Expose the name of the current transaction, if any.void
TransactionContext.setSynchronizations
(Set<TransactionSynchronization> synchronizations) ModifierConstructorDescriptionGenericReactiveTransaction
(Object transaction, boolean newTransaction, boolean newSynchronization, boolean readOnly, boolean debug, Object suspendedResources) Deprecated, for removal: This API element is subject to removal in a future version.GenericReactiveTransaction
(Object transaction, boolean newTransaction, boolean newSynchronization, boolean readOnly, boolean debug, Object suspendedResources) Deprecated, for removal: This API element is subject to removal in a future version.GenericReactiveTransaction
(String transactionName, Object transaction, boolean newTransaction, boolean newSynchronization, boolean nested, boolean readOnly, boolean debug, Object suspendedResources) Create a newDefaultReactiveTransactionStatus
instance.GenericReactiveTransaction
(String transactionName, Object transaction, boolean newTransaction, boolean newSynchronization, boolean nested, boolean readOnly, boolean debug, Object suspendedResources) Create a newDefaultReactiveTransactionStatus
instance.GenericReactiveTransaction
(String transactionName, Object transaction, boolean newTransaction, boolean newSynchronization, boolean nested, boolean readOnly, boolean debug, Object suspendedResources) Create a newDefaultReactiveTransactionStatus
instance. -
Uses of Nullable in org.springframework.transaction.support
Modifier and TypeMethodDescriptionTransactionCallback.doInTransaction
(TransactionStatus status) Gets called byTransactionTemplate.execute(org.springframework.transaction.support.TransactionCallback<T>)
within a transactional context.final Object
TransactionCallbackWithoutResult.doInTransaction
(TransactionStatus status) <T> T
CallbackPreferringPlatformTransactionManager.execute
(TransactionDefinition definition, TransactionCallback<T> callback) Execute the action specified by the given callback object within a transaction.<T> T
TransactionOperations.execute
(TransactionCallback<T> action) Execute the action specified by the given callback object within a transaction.<T> T
TransactionTemplate.execute
(TransactionCallback<T> action) SimpleTransactionScope.getConversationId()
static Integer
TransactionSynchronizationManager.getCurrentTransactionIsolationLevel()
Return the isolation level for the current transaction, if any.static String
TransactionSynchronizationManager.getCurrentTransactionName()
Return the name of the current transaction, ornull
if none set.ResourceHolderSupport.getDeadline()
Return the expiration deadline of this object.final String
DefaultTransactionDefinition.getName()
DelegatingTransactionDefinition.getName()
static Object
TransactionSynchronizationManager.getResource
(Object key) Retrieve a resource for the given key that is bound to the current thread.protected Object
AbstractTransactionStatus.getSavepoint()
Get the savepoint for this transaction, if any.DefaultTransactionStatus.getSuspendedResources()
Return the holder for resources that have been suspended for this transaction, if any.TransactionTemplate.getTransactionManager()
Return the transaction management strategy to be used.SimpleTransactionScope.resolveContextualObject
(String key) protected final AbstractPlatformTransactionManager.SuspendedResourcesHolder
Suspend the given transaction.static Object
TransactionSynchronizationManager.unbindResourceIfPossible
(Object key) Unbind a resource for the given key from the current thread.Modifier and TypeMethodDescriptionprotected void
Resume the resources of the current transaction.boolean
This implementation compares thetoString()
results.boolean
boolean
<T> T
CallbackPreferringPlatformTransactionManager.execute
(TransactionDefinition definition, TransactionCallback<T> callback) Execute the action specified by the given callback object within a transaction.final TransactionStatus
AbstractPlatformTransactionManager.getTransaction
(TransactionDefinition definition) This implementation handles propagation behavior.static void
TransactionSynchronizationUtils.invokeAfterCommit
(List<TransactionSynchronization> synchronizations) Actually invoke theafterCommit
methods of the given Spring TransactionSynchronization objects.static void
TransactionSynchronizationUtils.invokeAfterCompletion
(List<TransactionSynchronization> synchronizations, int completionStatus) Actually invoke theafterCompletion
methods of the given Spring TransactionSynchronization objects.protected final void
AbstractPlatformTransactionManager.resume
(Object transaction, AbstractPlatformTransactionManager.SuspendedResourcesHolder resourcesHolder) Resume the given transaction.protected final void
AbstractPlatformTransactionManager.resume
(Object transaction, AbstractPlatformTransactionManager.SuspendedResourcesHolder resourcesHolder) Resume the given transaction.static void
TransactionSynchronizationManager.setCurrentTransactionIsolationLevel
(Integer isolationLevel) Expose an isolation level for the current transaction.static void
TransactionSynchronizationManager.setCurrentTransactionName
(String name) Expose the name of the current transaction, if any.protected void
AbstractTransactionStatus.setSavepoint
(Object savepoint) Set a savepoint for this transaction.void
TransactionTemplate.setTransactionManager
(PlatformTransactionManager transactionManager) Set the transaction management strategy to be used.protected final AbstractPlatformTransactionManager.SuspendedResourcesHolder
Suspend the given transaction.ModifierConstructorDescriptionDefaultTransactionStatus
(Object transaction, boolean newTransaction, boolean newSynchronization, boolean readOnly, boolean debug, Object suspendedResources) Deprecated, for removal: This API element is subject to removal in a future version.DefaultTransactionStatus
(Object transaction, boolean newTransaction, boolean newSynchronization, boolean readOnly, boolean debug, Object suspendedResources) Deprecated, for removal: This API element is subject to removal in a future version.DefaultTransactionStatus
(String transactionName, Object transaction, boolean newTransaction, boolean newSynchronization, boolean nested, boolean readOnly, boolean debug, Object suspendedResources) Create a newDefaultTransactionStatus
instance.DefaultTransactionStatus
(String transactionName, Object transaction, boolean newTransaction, boolean newSynchronization, boolean nested, boolean readOnly, boolean debug, Object suspendedResources) Create a newDefaultTransactionStatus
instance.DefaultTransactionStatus
(String transactionName, Object transaction, boolean newTransaction, boolean newSynchronization, boolean nested, boolean readOnly, boolean debug, Object suspendedResources) Create a newDefaultTransactionStatus
instance. -
Uses of Nullable in org.springframework.ui
Modifier and TypeMethodDescriptionConcurrentModel.getAttribute
(String attributeName) Model.getAttribute
(String attributeName) Return the attribute value for the given name, if any.ModelMap.getAttribute
(String attributeName) Return the attribute value for the given name, if any.Modifier and TypeMethodDescriptionConcurrentModel.addAllAttributes
(Collection<?> attributeValues) Copy all attributes in the suppliedCollection
into thisMap
, using attribute name generation for each element.ConcurrentModel.addAllAttributes
(Map<String, ?> attributes) Copy all attributes in the suppliedMap
into thisMap
.ExtendedModelMap.addAllAttributes
(Collection<?> attributeValues) ExtendedModelMap.addAllAttributes
(Map<String, ?> attributes) ModelMap.addAllAttributes
(Collection<?> attributeValues) Copy all attributes in the suppliedCollection
into thisMap
, using attribute name generation for each element.ModelMap.addAllAttributes
(Map<String, ?> attributes) Copy all attributes in the suppliedMap
into thisMap
.ConcurrentModel.addAttribute
(String attributeName, Object attributeValue) Add the supplied attribute under the supplied name.ExtendedModelMap.addAttribute
(String attributeName, Object attributeValue) Model.addAttribute
(String attributeName, Object attributeValue) Add the supplied attribute under the supplied name.ModelMap.addAttribute
(String attributeName, Object attributeValue) Add the supplied attribute under the supplied name.ConcurrentModel.mergeAttributes
(Map<String, ?> attributes) Copy all attributes in the suppliedMap
into thisMap
, with existing objects of the same name taking precedence (i.e.ExtendedModelMap.mergeAttributes
(Map<String, ?> attributes) ModelMap.mergeAttributes
(Map<String, ?> attributes) Copy all attributes in the suppliedMap
into thisMap
, with existing objects of the same name taking precedence (i.e. -
Uses of Nullable in org.springframework.ui.context
Modifier and TypeMethodDescriptionHierarchicalThemeSource.getParentThemeSource()
Deprecated.Return the parent of this ThemeSource, ornull
if none.Deprecated.Return the Theme instance for the given theme name.Modifier and TypeMethodDescriptionvoid
HierarchicalThemeSource.setParentThemeSource
(ThemeSource parent) Deprecated.Set the parent that will be used to try to resolve theme messages that this object can't resolve. -
Uses of Nullable in org.springframework.ui.context.support
Modifier and TypeMethodDescriptionDelegatingThemeSource.getParentThemeSource()
Deprecated.ResourceBundleThemeSource.getParentThemeSource()
Deprecated.Deprecated.Deprecated.This implementation returns a SimpleTheme instance, holding a ResourceBundle-based MessageSource whose basename corresponds to the given theme name (prefixed by the configured "basenamePrefix").Modifier and TypeMethodDescriptionvoid
ResourceBundleThemeSource.setBasenamePrefix
(String basenamePrefix) Deprecated.Set the prefix that gets applied to the ResourceBundle basenames, i.e.void
ResourceBundleThemeSource.setBeanClassLoader
(ClassLoader beanClassLoader) Deprecated.void
ResourceBundleThemeSource.setDefaultEncoding
(String defaultEncoding) Deprecated.Set the default charset to use for parsing resource bundle files.void
DelegatingThemeSource.setParentThemeSource
(ThemeSource parentThemeSource) Deprecated.void
ResourceBundleThemeSource.setParentThemeSource
(ThemeSource parent) Deprecated. -
Uses of Nullable in org.springframework.ui.freemarker
Modifier and TypeMethodDescriptionSpringTemplateLoader.findTemplateSource
(String name) protected freemarker.cache.TemplateLoader
FreeMarkerConfigurationFactory.getAggregateTemplateLoader
(List<freemarker.cache.TemplateLoader> templateLoaders) Return a TemplateLoader based on the given TemplateLoader list.freemarker.template.Configuration
FreeMarkerConfigurationFactoryBean.getObject()
-
Uses of Nullable in org.springframework.util
Modifier and TypeMethodDescriptionLinkedCaseInsensitiveMap.computeIfAbsent
(String key, Function<? super String, ? extends V> mappingFunction) static String[]
StringUtils.concatenateStringArrays
(String[] array1, String[] array2) Concatenate the givenString
arrays into one, with overlapping array elements included twice.StopWatch.currentTaskName()
Get the name of the currently running task, if any.static Object
SerializationUtils.deserialize
(byte[] 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 Class<?>
ClassUtils.determineCommonAncestor
(Class<?> clazz1, Class<?> clazz2) Determine the common ancestor of the given classes, if any.<T> T
ConcurrentReferenceHashMap.Segment.doTask
(int hash, Object key, ConcurrentReferenceHashMap<K, V>.org.springframework.util.ConcurrentReferenceHashMap.Task<T> task) Apply an update operation to this segment.static Class<?>
CollectionUtils.findCommonElementType
(Collection<?> collection) Find the common element type of the given Collection, if any.static Field
static Field
static Field
ReflectionUtils.findFieldIgnoreCase
(Class<?> clazz, String name) static <E> E
CollectionUtils.findFirstMatch
(Collection<?> source, Collection<E> candidates) Return the first element in 'candidates
' that is contained in 'source
'.protected Method
MethodInvoker.findMatchingMethod()
Find a matching method with the specified name for the specified arguments.static Method
ReflectionUtils.findMethod
(Class<?> clazz, String name) Attempt to find aMethod
on the supplied class with the supplied name and no parameters.static Method
ReflectionUtils.findMethod
(Class<?> clazz, String name, Class<?>... paramTypes) Attempt to find aMethod
on the supplied class with the supplied name and parameter types.static Object
CollectionUtils.findValueOfType
(Collection<?> collection, Class<?>[] types) Find a single value of one of the given types in the given Collection: searching the Collection for a value of the first type, then searching for a value of the second type, etc.static <T> T
CollectionUtils.findValueOfType
(Collection<?> collection, Class<T> type) Find a single value of the given type in the given Collection.static <T> T
CollectionUtils.firstElement
(List<T> list) Retrieve the first element of the given List, accessing the zero index.static <T> T
CollectionUtils.firstElement
(Set<T> set) Retrieve the first element of the given Set, usingSortedSet.first()
or otherwise using the iterator.ConcurrentReferenceHashMap.Reference.get()
Return the referenced entry, ornull
if the entry is no longer available.MimeType.getCharset()
Return the character set, as indicated by acharset
parameter, if any.static <T> Constructor<T>
ClassUtils.getConstructorIfAvailable
(Class<T> clazz, Class<?>... paramTypes) Determine whether the given class has a public constructor with the given signature, and return it if available (else returnnull
).static ClassLoader
ClassUtils.getDefaultClassLoader()
Return the default ClassLoader to use: typically the thread context ClassLoader, if available; the ClassLoader that loaded the ClassUtils class will be used as fallback.static String
ClassUtils.getDescriptiveType
(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 Object
Get the field represented by the suppliedfield object
on the specifiedtarget object
.static String
StringUtils.getFilename
(String path) Extract the filename from the given Java resource path, e.g.static String
StringUtils.getFilenameExtension
(String path) Extract the filename extension from the given Java resource path, e.g.Return the first value for the given key.ConcurrentReferenceHashMap.Entry.getKey()
static Method
ClassUtils.getMethodIfAvailable
(Class<?> clazz, String methodName, Class<?>... paramTypes) Determine whether the given class has a public method with the given signature, and return it if available (else returnnull
).ConcurrentReferenceHashMap.Reference.getNext()
Return the next reference in the chain, ornull
if none.ConcurrentReferenceHashMap.getOrDefault
(Object key, V defaultValue) LinkedCaseInsensitiveMap.getOrDefault
(Object key, V defaultValue) MimeType.getParameter
(String name) Return a generic parameter value, given a parameter name.protected final ConcurrentReferenceHashMap.Reference<K,
V> ConcurrentReferenceHashMap.getReference
(Object key, ConcurrentReferenceHashMap.Restructure restructure) Return aConcurrentReferenceHashMap.Reference
to theConcurrentReferenceHashMap.Entry
for the specifiedkey
, ornull
if not found.ConcurrentReferenceHashMap.Segment.getReference
(Object key, int hash, ConcurrentReferenceHashMap.Restructure restructure) static Method
ClassUtils.getStaticMethod
(Class<?> clazz, String methodName, Class<?>... args) Return a public static method of a class.MimeType.getSubtypeSuffix()
Return the subtype suffix as defined in RFC 6839.Class<?>
MethodInvoker.getTargetClass()
Return the target class on which to call the target method.MethodInvoker.getTargetMethod()
Return the name of the method to be invoked.MethodInvoker.getTargetObject()
Return the target object on which to call the target method.CustomizableThreadCreator.getThreadGroup()
Return the thread group that threads should be created in (ornull
for the default group).ConcurrentReferenceHashMap.Entry.getValue()
MethodInvoker.invoke()
Invoke the specified method.static Object
ReflectionUtils.invokeMethod
(Method method, Object target) Invoke the specifiedMethod
against the supplied target object with no arguments.static Object
ReflectionUtils.invokeMethod
(Method method, Object target, Object... args) Invoke the specifiedMethod
against the supplied target object with the supplied arguments.static <T> T
CollectionUtils.lastElement
(List<T> list) Retrieve the last element of the given List, accessing the highest index.static <T> T
CollectionUtils.lastElement
(Set<T> set) Retrieve the last element of the given Set, usingSortedSet.last()
or otherwise iterating over all elements (assuming a linked set).RouteMatcher.matchAndExtract
(String pattern, RouteMatcher.Route route) Match the pattern to the route and extract template variables.SimpleRouteMatcher.matchAndExtract
(String pattern, RouteMatcher.Route route) static ClassLoader
ClassUtils.overrideThreadContextClassLoader
(ClassLoader classLoaderToUse) Override the thread context ClassLoader with the environment's bean ClassLoader if necessary, i.e.static Locale
StringUtils.parseLocale
(String localeValue) Parse the givenString
value into aLocale
, accepting theLocale.toString()
format as well as BCP 47 language tags as specified byLocale.forLanguageTag(java.lang.String)
.static Locale
StringUtils.parseLocaleString
(String localeString) Parse the givenString
representation into aLocale
.ConcurrentReferenceHashMap.ReferenceManager.pollForPurge()
Return any reference that has been garbage collected and can be purged from the underlying structure ornull
if no references need purging.ConcurrentReferenceHashMap.putIfAbsent
(K key, V value) LinkedCaseInsensitiveMap.putIfAbsent
(String key, V value) MultiValueMapAdapter.putIfAbsent
(K key, List<V> value) static String
Quote the givenString
with single quotes.static Object
StringUtils.quoteIfString
(Object obj) Turn the given Object into aString
with single quotes if it is aString
; keeping the Object as-is else.boolean
Immediately remove the given key and any associated value.PropertyPlaceholderHelper.PlaceholderResolver.resolvePlaceholder
(String placeholderName) Resolve the supplied placeholder name to the replacement value.static Class<?>
ClassUtils.resolvePrimitiveClassName
(String name) Resolve the given class name as primitive class, if appropriate, according to the JVM's naming rules for primitive classes.StringValueResolver.resolveStringValue
(String strVal) Resolve the given String value, for example parsing placeholders.static byte[]
Serialize the given object to a byte array.static String[]
Split aString
at the first occurrence of the delimiter.static Properties
StringUtils.splitArrayElementsIntoProperties
(String[] array, String delimiter) Take an array of strings and split each element based on the given delimiter.static Properties
StringUtils.splitArrayElementsIntoProperties
(String[] array, String delimiter, String charsToDelete) Take an array of strings and split each element based on the given delimiter.static Object
ObjectUtils.unwrapOptional
(Object obj) Unwrap the given object which is potentially aOptional
.Modifier and TypeMethodDescriptionvoid
Add the given single value to the current list of values for the given key.void
default void
MultiValueMap.addIfAbsent
(K key, V value) static <A,
O extends A>
A[]ObjectUtils.addObjectToArray
(A[] array, O obj) Append the given object to the given array, returning a new array consisting of the input array contents plus the given object.static <A,
O extends A>
A[]ObjectUtils.addObjectToArray
(A[] array, O obj) Append the given object to the given array, returning a new array consisting of the input array contents plus the given object.static <A,
O extends A>
A[]ObjectUtils.addObjectToArray
(A[] array, O obj, int position) Add the given object to the given array at the specified position, returning a new array consisting of the input array contents plus the given object.static <A,
O extends A>
A[]ObjectUtils.addObjectToArray
(A[] array, O obj, int position) Add the given object to the given array at the specified position, returning a new array consisting of the input array contents plus the given object.static String[]
StringUtils.addStringToArray
(String[] array, String str) Append the givenString
to the givenString
array, returning a new array consisting of the input array contents plus the givenString
.static String
StringUtils.arrayToCommaDelimitedString
(Object[] arr) Convert aString
array into a comma delimitedString
(i.e., CSV).static String
StringUtils.arrayToDelimitedString
(Object[] arr, String delim) Convert aString
array into a delimitedString
(e.g.static List<?>
CollectionUtils.arrayToList
(Object source) Convert the supplied array into a List.static String
ClassUtils.classNamesToString
(Collection<Class<?>> classes) Build a String that consists of the names of the classes/interfaces in the given collection.static String
ClassUtils.classPackageAsResourcePath
(Class<?> clazz) Given an input class object, return a string which consists of the class's package name as a pathname, i.e., all dots ('.') are replaced by slashes ('/').static String
StringUtils.collectionToCommaDelimitedString
(Collection<?> coll) Convert aCollection
into a delimitedString
(e.g., CSV).static String
StringUtils.collectionToDelimitedString
(Collection<?> coll, String delim) Convert aCollection
into a delimitedString
(e.g.static String
StringUtils.collectionToDelimitedString
(Collection<?> coll, String delim, String prefix, String suffix) Convert aCollection
to a delimitedString
(e.g.StringUtils.commaDelimitedListToSet
(String str) Convert a comma delimited list (e.g., a row from a CSV file) into a set.static String[]
StringUtils.commaDelimitedListToStringArray
(String str) Convert a comma delimited list (e.g., a row from a CSV file) into an array of strings.static String[]
StringUtils.concatenateStringArrays
(String[] array1, String[] array2) Concatenate the givenString
arrays into one, with overlapping array elements included twice.static String[]
StringUtils.concatenateStringArrays
(String[] array1, String[] array2) Concatenate the givenString
arrays into one, with overlapping array elements included twice.static boolean
CollectionUtils.contains
(Enumeration<?> enumeration, Object element) Check whether the given Enumeration contains the given element.static boolean
Check whether the given Iterator contains the given element.static boolean
ObjectUtils.containsElement
(Object[] array, Object element) Check whether the given array contains the given element.static boolean
CollectionUtils.containsInstance
(Collection<?> collection, Object element) Check whether the given Collection contains the given element instance.boolean
ConcurrentReferenceHashMap.containsKey
(Object key) static boolean
StringUtils.containsWhitespace
(CharSequence str) Check whether the givenCharSequence
contains any whitespace characters.static boolean
StringUtils.containsWhitespace
(String str) Check whether the givenString
contains any whitespace characters.static byte[]
FileCopyUtils.copyToByteArray
(InputStream in) Copy the contents of the given InputStream into a new byte array.static byte[]
StreamUtils.copyToByteArray
(InputStream in) Copy the contents of the given InputStream into a new byte array.static String
FileCopyUtils.copyToString
(Reader in) Copy the contents of the given Reader into a String.static String
StreamUtils.copyToString
(InputStream in, Charset charset) Copy the contents of the given InputStream into a String.static Class<?>
ClassUtils.createCompositeInterface
(Class<?>[] interfaces, ClassLoader classLoader) Create a composite interface Class for the given interfaces, implementing the given interfaces in one single Class.ConcurrentReferenceHashMap.ReferenceManager.createReference
(ConcurrentReferenceHashMap.Entry<K, V> entry, int hash, ConcurrentReferenceHashMap.Reference<K, V> next) Factory method used to create a newConcurrentReferenceHashMap.Reference
.static String
Delete any character in a givenString
.static boolean
FileSystemUtils.deleteRecursively
(File root) Delete the suppliedFile
- for directories, recursively delete any nested directories or files as well.static boolean
FileSystemUtils.deleteRecursively
(Path root) Delete the suppliedPath
— for directories, recursively delete any nested directories or files as well.static String[]
StringUtils.delimitedListToStringArray
(String str, String delimiter) Take aString
that is a delimited list and convert it into aString
array.static String[]
StringUtils.delimitedListToStringArray
(String str, String delimiter) Take aString
that is a delimited list and convert it into aString
array.static String[]
StringUtils.delimitedListToStringArray
(String str, String delimiter, String charsToDelete) Take aString
that is a delimited list and convert it into aString
array.static String[]
StringUtils.delimitedListToStringArray
(String str, String delimiter, String charsToDelete) Take aString
that is a delimited list and convert it into aString
array.static String[]
StringUtils.delimitedListToStringArray
(String str, String delimiter, String charsToDelete) Take aString
that is a delimited list and convert it into aString
array.static Object
SerializationUtils.deserialize
(byte[] 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 Class<?>
ClassUtils.determineCommonAncestor
(Class<?> clazz1, Class<?> clazz2) Determine the common ancestor of the given classes, if any.static Class<?>
ClassUtils.determineCommonAncestor
(Class<?> clazz1, Class<?> clazz2) Determine the common ancestor of the given classes, if any.static void
Assert.doesNotContain
(String textToSearch, String substring, String message) Assert that the given text does not contain the given substring.static void
Assert.doesNotContain
(String textToSearch, String substring, Supplier<String> messageSupplier) Assert that the given text does not contain the given substring.protected boolean
AntPathMatcher.doMatch
(String pattern, String path, boolean fullMatch, Map<String, String> uriTemplateVariables) Actually match the givenpath
against the givenpattern
.protected boolean
AntPathMatcher.doMatch
(String pattern, String path, boolean fullMatch, Map<String, String> uriTemplateVariables) Actually match the givenpath
against the givenpattern
.<T> T
ConcurrentReferenceHashMap.Segment.doTask
(int hash, Object key, ConcurrentReferenceHashMap<K, V>.org.springframework.util.ConcurrentReferenceHashMap.Task<T> task) Apply an update operation to this segment.static void
ReflectionUtils.doWithFields
(Class<?> clazz, ReflectionUtils.FieldCallback fc, ReflectionUtils.FieldFilter ff) Invoke the given callback on all fields in the target class, going up the class hierarchy to get all declared fields.static void
ReflectionUtils.doWithMethods
(Class<?> clazz, ReflectionUtils.MethodCallback mc, ReflectionUtils.MethodFilter mf) Perform the given callback operation on all matching methods of the given class and superclasses (or given interface and super-interfaces).static boolean
StringUtils.endsWithIgnoreCase
(String str, String suffix) Test if the givenString
ends with the specified suffix, ignoring upper/lower case.static boolean
StringUtils.endsWithIgnoreCase
(String str, String suffix) Test if the givenString
ends with the specified suffix, ignoring upper/lower case.boolean
boolean
boolean
boolean
boolean
boolean
MimeType.equalsTypeAndSubtype
(MimeType other) Similar toMimeType.equals(Object)
but based on the type and subtype only, i.e.static Field
static Field
static Method
ReflectionUtils.findMethod
(Class<?> clazz, String name, Class<?>... paramTypes) Attempt to find aMethod
on the supplied class with the supplied name and parameter types.static <T> T
CollectionUtils.findValueOfType
(Collection<?> collection, Class<T> type) Find a single value of the given type in the given Collection.static <T> T
CollectionUtils.firstElement
(List<T> list) Retrieve the first element of the given List, accessing the zero index.static <T> T
CollectionUtils.firstElement
(Set<T> set) Retrieve the first element of the given Set, usingSortedSet.first()
or otherwise using the iterator.static Class<?>
ClassUtils.forName
(String name, ClassLoader classLoader) Replacement forClass.forName()
that also returns Class instances for primitives (e.g.static Class<?>[]
ClassUtils.getAllInterfacesForClass
(Class<?> clazz, ClassLoader classLoader) Return all interfaces that the given class implements as an array, including ones implemented by superclasses.ClassUtils.getAllInterfacesForClassAsSet
(Class<?> clazz, ClassLoader classLoader) Return all interfaces that the given class implements as a Set, including ones implemented by superclasses.static String
ClassUtils.getDescriptiveType
(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 String
ObjectUtils.getDisplayString
(Object obj) Return a content-based String representation ifobj
is notnull
; otherwise returns an empty String.static Object
Get the field represented by the suppliedfield object
on the specifiedtarget object
.static String
StringUtils.getFilename
(String path) Extract the filename from the given Java resource path, e.g.static String
StringUtils.getFilenameExtension
(String path) Extract the filename extension from the given Java resource path, e.g.protected int
Get the hash for a given object, apply an additional hash function to reduce collisions.static Method
ClassUtils.getInterfaceMethodIfPossible
(Method method, Class<?> targetClass) Determine a corresponding interface method for the given method handle, if possible.static Method
Determine whether the given class has a public method with the given signature, and return it if available (else throws anIllegalStateException
).static Method
ClassUtils.getMethodIfAvailable
(Class<?> clazz, String methodName, Class<?>... paramTypes) Determine whether the given class has a public method with the given signature, and return it if available (else returnnull
).static Method
ClassUtils.getMostSpecificMethod
(Method method, Class<?> targetClass) Given a method, which may come from an interface, and a target class used in the current reflective invocation, find the corresponding target method if there is one — for example, the method may beIFoo.bar()
, and the target class may beDefaultFoo
.ConcurrentReferenceHashMap.getOrDefault
(Object key, V defaultValue) ConcurrentReferenceHashMap.getOrDefault
(Object key, V defaultValue) static String
ClassUtils.getQualifiedMethodName
(Method method, Class<?> clazz) Return the qualified name of the given method, consisting of fully qualified interface/class name + "." + method name.protected final ConcurrentReferenceHashMap.Reference<K,
V> ConcurrentReferenceHashMap.getReference
(Object key, ConcurrentReferenceHashMap.Restructure restructure) Return aConcurrentReferenceHashMap.Reference
to theConcurrentReferenceHashMap.Entry
for the specifiedkey
, ornull
if not found.ConcurrentReferenceHashMap.Segment.getReference
(Object key, int hash, ConcurrentReferenceHashMap.Restructure restructure) static Method[]
ReflectionUtils.getUniqueDeclaredMethods
(Class<?> leafClass, ReflectionUtils.MethodFilter mf) Get the unique set of declared methods on the leaf class and all superclasses.static void
Assert that the given String is not empty; that is, it must not benull
and not the empty String.static void
Assert that the given String is not empty; that is, it must not benull
and not the empty String.static boolean
StringUtils.hasLength
(CharSequence str) Check that the givenCharSequence
is neithernull
nor of length 0.static boolean
Check that the givenString
is neithernull
nor of length 0.static void
Assert that the given String contains valid text content; that is, it must not benull
and must contain at least one non-whitespace character.static void
Assert that the given String contains valid text content; that is, it must not benull
and must contain at least one non-whitespace character.static boolean
StringUtils.hasText
(CharSequence str) Check whether the givenCharSequence
contains actual text.static boolean
Check whether the givenString
contains actual text.static String
ObjectUtils.identityToString
(Object obj) Return a String representation of an object's overall identity.boolean
Indicate whether this MIME Type includes the given MIME Type.static Object
ReflectionUtils.invokeMethod
(Method method, Object target) Invoke the specifiedMethod
against the supplied target object with no arguments.static Object
ReflectionUtils.invokeMethod
(Method method, Object target, Object... args) Invoke the specifiedMethod
against the supplied target object with the supplied arguments.static Object
ReflectionUtils.invokeMethod
(Method method, Object target, Object... args) Invoke the specifiedMethod
against the supplied target object with the supplied arguments.static boolean
Determine whether the given object is an array: either an Object array or a primitive array.static void
Assert.isAssignable
(Class<?> superType, Class<?> subType, String message) Assert thatsuperType.isAssignableFrom(subType)
istrue
.static void
Assert.isAssignable
(Class<?> superType, Class<?> subType, Supplier<String> messageSupplier) Assert thatsuperType.isAssignableFrom(subType)
istrue
.static boolean
TypeUtils.isAssignableBound
(Type lhsType, Type rhsType) static boolean
TypeUtils.isAssignableBound
(Type lhsType, Type rhsType) static boolean
ClassUtils.isAssignableValue
(Class<?> type, Object value) Determine if the given type is assignable from the given value, assuming setting by reflection.static boolean
ClassUtils.isCacheSafe
(Class<?> clazz, ClassLoader classLoader) Check whether the given class is cache-safe in the given context, i.e.static boolean
ClassUtils.isCglibProxyClass
(Class<?> clazz) Deprecated.as of 5.2, in favor of custom (possibly narrower) checks or simply a check for containingClassUtils.CGLIB_CLASS_SEPARATOR
static boolean
ClassUtils.isCglibProxyClassName
(String className) Deprecated.as of 5.2, in favor of custom (possibly narrower) checks or simply a check for containingClassUtils.CGLIB_CLASS_SEPARATOR
boolean
MimeType.isCompatibleWith
(MimeType other) Indicate whether this MIME Type is compatible with the given MIME Type.static boolean
ObjectUtils.isCompatibleWithThrowsClause
(Throwable ex, Class<?>... declaredExceptions) Check whether the given exception is compatible with the specified exception types, as declared in a throws clause.static boolean
CollectionUtils.isEmpty
(Collection<?> collection) Returntrue
if the supplied Collection isnull
or empty.static boolean
Returntrue
if the supplied Map isnull
or empty.static boolean
Determine whether the given object is empty.static boolean
Determine whether the given array is empty: i.e.static boolean
Deprecated.as of 5.3, in favor ofStringUtils.hasLength(String)
andStringUtils.hasText(String)
(orObjectUtils.isEmpty(Object)
)static boolean
ReflectionUtils.isEqualsMethod
(Method method) Determine whether the given method is an "equals" method.static boolean
ReflectionUtils.isHashCodeMethod
(Method method) Determine whether the given method is a "hashCode" method.static void
Assert.isInstanceOf
(Class<?> type, Object obj) Assert that the provided object is an instance of the provided class.static void
Assert.isInstanceOf
(Class<?> type, Object obj, String message) Assert that the provided object is an instance of the provided class.static void
Assert.isInstanceOf
(Class<?> type, Object obj, Supplier<String> messageSupplier) Assert that the provided object is an instance of the provided class.static void
Assert that an object isnull
.static void
Assert that an object isnull
.static boolean
ReflectionUtils.isObjectMethod
(Method method) Determine whether the given method is originally declared byObject
.boolean
static boolean
ClassUtils.isPresent
(String className, ClassLoader classLoader) Determine whether theClass
identified by the supplied name is present and can be loaded.static boolean
ReflectionUtils.isToStringMethod
(Method method) Determine whether the given method is a "toString" method.static boolean
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, ClassLoader classLoader) Check whether the given class is visible in the given ClassLoader.static <T> T
CollectionUtils.lastElement
(List<T> list) Retrieve the last element of the given List, accessing the highest index.static <T> T
CollectionUtils.lastElement
(Set<T> set) Retrieve the last element of the given Set, usingSortedSet.last()
or otherwise iterating over all elements (assuming a linked set).static boolean
StringUtils.matchesCharacter
(String str, char singleCharacter) Test if the givenString
matches the given single character.static boolean
ClassUtils.matchesTypeName
(Class<?> clazz, String typeName) Check whether the given class matches the user-specified type name.boolean
AntPathMatcher.AntPathStringMatcher.matchStrings
(String str, Map<String, String> uriTemplateVariables) Main entry point.static <E> void
CollectionUtils.mergeArrayIntoCollection
(Object array, Collection<E> collection) Merge the given array into the given Collection.static <K,
V> void CollectionUtils.mergePropertiesIntoMap
(Properties props, Map<K, V> map) Merge the given Properties instance into the given Map, copying all properties (key-value pairs) over.static void
Assert.noNullElements
(Object[] array, String message) Assert that an array contains nonull
elements.static void
Assert.noNullElements
(Object[] array, Supplier<String> messageSupplier) Assert that an array contains nonull
elements.static void
Assert.noNullElements
(Collection<?> collection, String message) Assert that a collection contains nonull
elements.static void
Assert.noNullElements
(Collection<?> collection, Supplier<String> messageSupplier) Assert that a collection contains nonull
elements.static void
Assert that an array contains elements; that is, it must not benull
and must contain at least one element.static void
Assert that an array contains elements; that is, it must not benull
and must contain at least one element.static void
Assert.notEmpty
(Collection<?> collection, String message) Assert that a collection contains elements; that is, it must not benull
and must contain at least one element.static void
Assert.notEmpty
(Collection<?> collection, Supplier<String> messageSupplier) Assert that a collection contains elements; that is, it must not benull
and must contain at least one element.static void
Assert that a Map contains entries; that is, it must not benull
and must contain at least one entry.static void
Assert that a Map contains entries; that is, it must not benull
and must contain at least one entry.static void
Assert that an object is notnull
.static void
Assert that an object is notnull
.static String
ObjectUtils.nullSafeClassName
(Object obj) Determine the class name for the given object.static String
ObjectUtils.nullSafeConciseToString
(Object obj) Generate a null-safe, concise string representation of the supplied object as described below.static boolean
ObjectUtils.nullSafeEquals
(Object o1, Object o2) Determine if the given objects are equal, returningtrue
if both arenull
orfalse
if only one isnull
.static boolean
ObjectUtils.nullSafeEquals
(Object o1, Object o2) Determine if the given objects are equal, returningtrue
if both arenull
orfalse
if only one isnull
.static int
ObjectUtils.nullSafeHashCode
(boolean[] array) Return a hash code based on the contents of the specified array.static int
ObjectUtils.nullSafeHashCode
(byte[] array) Return a hash code based on the contents of the specified array.static int
ObjectUtils.nullSafeHashCode
(char[] array) Return a hash code based on the contents of the specified array.static int
ObjectUtils.nullSafeHashCode
(double[] array) Return a hash code based on the contents of the specified array.static int
ObjectUtils.nullSafeHashCode
(float[] array) Return a hash code based on the contents of the specified array.static int
ObjectUtils.nullSafeHashCode
(int[] array) Return a hash code based on the contents of the specified array.static int
ObjectUtils.nullSafeHashCode
(long[] array) Return a hash code based on the contents of the specified array.static int
ObjectUtils.nullSafeHashCode
(short[] array) Return a hash code based on the contents of the specified array.static int
ObjectUtils.nullSafeHashCode
(Object obj) Return as hash code for the given object; typically the value ofObject#hashCode()
}.static int
ObjectUtils.nullSafeHashCode
(Object[] array) Return a hash code based on the contents of the specified array.static String
ObjectUtils.nullSafeToString
(boolean[] array) Return a String representation of the contents of the specified array.static String
ObjectUtils.nullSafeToString
(byte[] array) Return a String representation of the contents of the specified array.static String
ObjectUtils.nullSafeToString
(char[] array) Return a String representation of the contents of the specified array.static String
ObjectUtils.nullSafeToString
(double[] array) Return a String representation of the contents of the specified array.static String
ObjectUtils.nullSafeToString
(float[] array) Return a String representation of the contents of the specified array.static String
ObjectUtils.nullSafeToString
(int[] array) Return a String representation of the contents of the specified array.static String
ObjectUtils.nullSafeToString
(long[] array) Return a String representation of the contents of the specified array.static String
ObjectUtils.nullSafeToString
(short[] array) Return a String representation of the contents of the specified array.static String
ObjectUtils.nullSafeToString
(Object obj) Return a String representation of the specified Object.static String
ObjectUtils.nullSafeToString
(Object[] array) Return a String representation of the contents of the specified array.static ClassLoader
ClassUtils.overrideThreadContextClassLoader
(ClassLoader classLoaderToUse) Override the thread context ClassLoader with the environment's bean ClassLoader if necessary, i.e.static <T extends Number>
TNumberUtils.parseNumber
(String text, Class<T> targetClass, NumberFormat numberFormat) Parse the giventext
into aNumber
instance of the given target class, using the suppliedNumberFormat
.protected String
PropertyPlaceholderHelper.parseStringValue
(String value, PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver, Set<String> visitedPlaceholders) ConcurrentReferenceHashMap.putIfAbsent
(K key, V value) ConcurrentReferenceHashMap.putIfAbsent
(K key, V value) LinkedCaseInsensitiveMap.putIfAbsent
(String key, V value) static String
Quote the givenString
with single quotes.static Object
StringUtils.quoteIfString
(Object obj) Turn the given Object into aString
with single quotes if it is aString
; keeping the Object as-is else.boolean
boolean
boolean
boolean
boolean
static String
Replace all occurrences of a substring within a string with another string.static Class<?>
ClassUtils.resolveClassName
(String className, ClassLoader classLoader) Resolve the given class name into a Class instance.static Class<?>
ClassUtils.resolvePrimitiveClassName
(String name) Resolve the given class name as primitive class, if appropriate, according to the JVM's naming rules for primitive classes.static byte[]
Serialize the given object to a byte array.void
Set the given single value under the given key.void
static void
Set the field represented by the supplied field object on the specified target object to the specifiedvalue
.static void
Set the field represented by the supplied field object on the specified target object to the specifiedvalue
.void
AntPathMatcher.setPathSeparator
(String pathSeparator) Set the path separator to use for pattern parsing.void
MethodInvoker.setTargetClass
(Class<?> targetClass) Set the target class on which to call the target method.void
MethodInvoker.setTargetMethod
(String targetMethod) Set the name of the method to be invoked.void
MethodInvoker.setTargetObject
(Object targetObject) Set the target object on which to call the target method.void
CustomizableThreadCreator.setThreadGroup
(ThreadGroup threadGroup) Specify the thread group that threads should be created in.void
CustomizableThreadCreator.setThreadNamePrefix
(String threadNamePrefix) Specify the prefix to use for the names of newly created threads.static boolean
PatternMatchUtils.simpleMatch
(String[] patterns, String str) Match a String against the given patterns, supporting the following simple pattern styles: "xxx*", "*xxx", "*xxx*" and "xxx*yyy" matches (with an arbitrary number of pattern parts), as well as direct equality.static boolean
PatternMatchUtils.simpleMatch
(String pattern, String str) Match a String against the given pattern, supporting the following simple pattern styles: "xxx*", "*xxx", "*xxx*" and "xxx*yyy" matches (with an arbitrary number of pattern parts), as well as direct equality.static boolean
PatternMatchUtils.simpleMatch
(String pattern, String str) Match a String against the given pattern, supporting the following simple pattern styles: "xxx*", "*xxx", "*xxx*" and "xxx*yyy" matches (with an arbitrary number of pattern parts), as well as direct equality.static String[]
Split aString
at the first occurrence of the delimiter.static String[]
Split aString
at the first occurrence of the delimiter.static Properties
StringUtils.splitArrayElementsIntoProperties
(String[] array, String delimiter, String charsToDelete) Take an array of strings and split each element based on the given delimiter.static boolean
StringUtils.startsWithIgnoreCase
(String str, String prefix) Test if the givenString
starts with the specified prefix, ignoring upper/lower case.static boolean
StringUtils.startsWithIgnoreCase
(String str, String prefix) Test if the givenString
starts with the specified prefix, ignoring upper/lower case.static Class<?>[]
ClassUtils.toClassArray
(Collection<Class<?>> collection) Copy the givenCollection
into aClass
array.static <E> Iterator<E>
CollectionUtils.toIterator
(Enumeration<E> enumeration) Adapt anEnumeration
to anIterator
.static String[]
StringUtils.tokenizeToStringArray
(String str, String delimiters) static String[]
StringUtils.tokenizeToStringArray
(String str, String delimiters, boolean trimTokens, boolean ignoreEmptyTokens) static Object[]
ObjectUtils.toObjectArray
(Object source) Convert the given array (which may be a primitive array) to an object array (if necessary of primitive wrapper objects).static String[]
StringUtils.toStringArray
(Collection<String> collection) Copy the givenCollection
into aString
array.static String[]
StringUtils.toStringArray
(Enumeration<String> enumeration) Copy the givenEnumeration
into aString
array.static Object
ObjectUtils.unwrapOptional
(Object obj) Unwrap the given object which is potentially aOptional
.ModifierConstructorDescriptionCustomizableThreadCreator
(String threadNamePrefix) Create a new CustomizableThreadCreator with the given thread name prefix.InstanceFilter
(Collection<? extends T> includes, Collection<? extends T> excludes, boolean matchIfEmpty) Create a new instance based on includes/excludes collections.InstanceFilter
(Collection<? extends T> includes, Collection<? extends T> excludes, boolean matchIfEmpty) Create a new instance based on includes/excludes collections.LinkedCaseInsensitiveMap
(int expectedSize, Locale locale) Create a new LinkedCaseInsensitiveMap that wraps aLinkedHashMap
with an initial capacity that can accommodate the specified number of elements without any immediate resize/rehash operations to be expected, storing case-insensitive keys according to the given Locale (in lower case).LinkedCaseInsensitiveMap
(Locale locale) Create a new LinkedCaseInsensitiveMap that stores case-insensitive keys according to the given Locale (in lower case).Create a newMimeType
for the given type, subtype, and parameters.Copy-constructor that copies the type and subtype of the givenMimeType
, and allows for different parameter.PropertyPlaceholderHelper
(String placeholderPrefix, String placeholderSuffix, String valueSeparator, boolean ignoreUnresolvablePlaceholders) Creates a newPropertyPlaceholderHelper
that uses the supplied prefix and suffix. -
Uses of Nullable in org.springframework.util.comparator
-
Uses of Nullable in org.springframework.util.concurrent
Modifier and TypeMethodDescriptionprotected abstract T
Deprecated.Adapts the given adaptee's result into T.FutureAdapter.get()
Deprecated.Deprecated.SettableListenableFuture.get()
Deprecated.Retrieve the value.Deprecated.Retrieve the value.Modifier and TypeMethodDescriptionvoid
Deprecated.Called when theListenableFuture
completes with success.boolean
Deprecated.Set the value of this future.void
Deprecated.Trigger aSuccessCallback.onSuccess(Object)
call on all added callbacks with the given result.ModifierConstructorDescriptionListenableFutureTask
(Runnable runnable, T result) Deprecated.Create aListenableFutureTask
that will, upon running, execute the givenRunnable
, and arrange thatFutureTask.get()
will return the given result on successful completion. -
Uses of Nullable in org.springframework.util.function
Modifier and TypeMethodDescriptionSingletonSupplier.get()
Get the shared singleton instance for this supplier.static <T> SingletonSupplier<T>
SingletonSupplier.ofNullable
(Supplier<T> supplier) Build aSingletonSupplier
with the given supplier.static <T> SingletonSupplier<T>
SingletonSupplier.ofNullable
(T instance) Build aSingletonSupplier
with the given singleton instance.static <T> T
Resolve the givenSupplier
, getting its result or immediately returningnull
if the supplier itself wasnull
.Modifier and TypeMethodDescriptionstatic <T> SingletonSupplier<T>
SingletonSupplier.ofNullable
(Supplier<T> supplier) Build aSingletonSupplier
with the given supplier.static <T> SingletonSupplier<T>
SingletonSupplier.ofNullable
(T instance) Build aSingletonSupplier
with the given singleton instance.static <T> T
Resolve the givenSupplier
, getting its result or immediately returningnull
if the supplier itself wasnull
.ModifierConstructorDescriptionSingletonSupplier
(Supplier<? extends T> instanceSupplier, Supplier<? extends T> defaultSupplier) Build aSingletonSupplier
with the given instance supplier and a default supplier for the case when the instance isnull
.SingletonSupplier
(T instance, Supplier<? extends T> defaultSupplier) Build aSingletonSupplier
with the given singleton instance and a default supplier for the case when the instance isnull
. -
Uses of Nullable in org.springframework.util.unit
-
Uses of Nullable in org.springframework.util.xml
Modifier and TypeMethodDescriptionstatic Element
DomUtils.getChildElementByTagName
(Element ele, String childEleName) Utility method that returns the first child element identified by its name.static String
DomUtils.getChildElementValueByTagName
(Element ele, String childEleName) Utility method that returns the first child element value identified by its name.static XMLEventReader
StaxUtils.getXMLEventReader
(Source source) Return theXMLEventReader
for the given StAX Source.static XMLEventWriter
StaxUtils.getXMLEventWriter
(Result result) Return theXMLEventWriter
for the given StAX Result.static XMLStreamReader
StaxUtils.getXMLStreamReader
(Source source) Return theXMLStreamReader
for the given StAX Source.static XMLStreamWriter
StaxUtils.getXMLStreamWriter
(Result result) Return theXMLStreamWriter
for the given StAX Result.Modifier and TypeMethodDescriptionvoid
SimpleNamespaceContext.removeBinding
(String prefix) Remove the given prefix from this context. -
Uses of Nullable in org.springframework.validation
Modifier and TypeMethodDescription<T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, Field field) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) DataBinder.findCustomEditor
(Class<?> requiredType, String propertyPath) AbstractBindingResult.findEditor
(String field, Class<?> valueType) This implementation delegates to thePropertyEditorRegistry
's editor lookup facility, if available.AbstractPropertyBindingResult.findEditor
(String field, Class<?> valueType) This implementation exposes a PropertyEditor adapter for a Formatter, if applicable.BindException.findEditor
(String field, Class valueType) BindingResult.findEditor
(String field, Class<?> valueType) Find a custom property editor for the given type and property.protected Object
AbstractBindingResult.formatFieldValue
(String field, Object value) Format the given value for the specified field.protected abstract Object
AbstractBindingResult.getActualFieldValue
(String field) Extract the actual field value for the given field.protected Object
AbstractPropertyBindingResult.getActualFieldValue
(String field) Fetches the field value from the PropertyAccessor.protected Object
MapBindingResult.getActualFieldValue
(String field) String[]
DataBinder.getAllowedFields()
Return the field patterns that should be allowed for binding.static BindingResult
BindingResultUtils.getBindingResult
(Map<?, ?> model, String name) Find the BindingResult for the given name in the given model.DataBinder.getConversionService()
Return the associated ConversionService, if any.protected PropertyEditor
AbstractPropertyBindingResult.getCustomEditor
(String fixedField) Retrieve the custom PropertyEditor for the given field, if any.String[]
DataBinder.getDisallowedFields()
Return the field patterns that should not be allowed for binding.AbstractBindingResult.getFieldError()
AbstractBindingResult.getFieldError
(String field) BindException.getFieldError()
BindException.getFieldError
(String field) default FieldError
Errors.getFieldError()
Get the first error associated with a field, if any.default FieldError
Errors.getFieldError
(String field) Get the first error associated with the given field, if any.Class<?>
AbstractBindingResult.getFieldType
(String field) This default implementation determines the type based on the actual field value, if any.Class<?>
AbstractPropertyBindingResult.getFieldType
(String field) Determines the field type from the property type.Class<?>
BindException.getFieldType
(String field) default Class<?>
Errors.getFieldType
(String field) Determine the type of the given field, as far as possible.AbstractBindingResult.getFieldValue
(String field) BindException.getFieldValue
(String field) Errors.getFieldValue
(String field) Return the current value of the given field, either the current bean property value or a rejected update from the last binding.SimpleErrors.getFieldValue
(String field) AbstractBindingResult.getGlobalError()
BindException.getGlobalError()
default ObjectError
Errors.getGlobalError()
Get the first global error, if any.DataBinder.getNameResolver()
Return theconfigured
name resolver for constructor parameters.AbstractBindingResult.getPropertyEditorRegistry()
This implementation returnsnull
.BindException.getPropertyEditorRegistry()
BindingResult.getPropertyEditorRegistry()
Return the underlying PropertyEditorRegistry.AbstractBindingResult.getRawFieldValue
(String field) BindException.getRawFieldValue
(String field) BindingResult.getRawFieldValue
(String field) Extract the raw field value for the given field.FieldError.getRejectedValue()
Return the rejected field value.String[]
DataBinder.getRequiredFields()
Return the fields that are required for each binding process.abstract Object
AbstractBindingResult.getTarget()
Return the wrapped target object.final Object
BeanPropertyBindingResult.getTarget()
BindException.getTarget()
BindingResult.getTarget()
Return the wrapped target object, which may be a bean, an object with public fields, a Map - depending on the concrete binding strategy.DataBinder.getTarget()
Return the wrapped target object.final Object
DirectFieldBindingResult.getTarget()
DataBinder.getTargetType()
Return theconfigured
type for the target object.DataBinder.getValidator()
Return the primary Validator to apply after each binding step, if any.DataBinder.NameResolver.resolveName
(MethodParameter parameter) Return the name to use for the given method parameter, ornull
if unresolved.DataBinder.ValueResolver.resolveValue
(String name, Class<?> type) Resolve the value for the given name and target parameter type.Modifier and TypeMethodDescription<T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, Field field) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, Field field) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, Field field) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, TypeDescriptor typeDescriptor) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) <T> T
DataBinder.convertIfNecessary
(Object value, Class<T> requiredType, MethodParameter methodParam) protected void
AbstractErrors.doSetNestedPath
(String nestedPath) Actually set the nested path.boolean
boolean
boolean
boolean
boolean
DataBinder.findCustomEditor
(Class<?> requiredType, String propertyPath) DataBinder.findCustomEditor
(Class<?> requiredType, String propertyPath) AbstractBindingResult.findEditor
(String field, Class<?> valueType) This implementation delegates to thePropertyEditorRegistry
's editor lookup facility, if available.AbstractBindingResult.findEditor
(String field, Class<?> valueType) This implementation delegates to thePropertyEditorRegistry
's editor lookup facility, if available.AbstractPropertyBindingResult.findEditor
(String field, Class<?> valueType) This implementation exposes a PropertyEditor adapter for a Formatter, if applicable.AbstractPropertyBindingResult.findEditor
(String field, Class<?> valueType) This implementation exposes a PropertyEditor adapter for a Formatter, if applicable.BindException.findEditor
(String field, Class valueType) BindException.findEditor
(String field, Class valueType) BindingResult.findEditor
(String field, Class<?> valueType) Find a custom property editor for the given type and property.BindingResult.findEditor
(String field, Class<?> valueType) Find a custom property editor for the given type and property.protected String
AbstractErrors.fixedField
(String field) Transform the given field into its full path, regarding the nested path of this instance.Build and return a message code consisting of the given fields, usually delimited byDefaultMessageCodesResolver.CODE_SEPARATOR
.Build and return a message code consisting of the given fields, usually delimited byDefaultMessageCodesResolver.CODE_SEPARATOR
.protected Object
AbstractBindingResult.formatFieldValue
(String field, Object value) Format the given value for the specified field.protected Object
AbstractPropertyBindingResult.formatFieldValue
(String field, Object value) Formats the field value based on registered PropertyEditors.Class<?>
AbstractBindingResult.getFieldType
(String field) This default implementation determines the type based on the actual field value, if any.Class<?>
AbstractPropertyBindingResult.getFieldType
(String field) Determines the field type from the property type.static void
ValidationUtils.invokeValidator
(Validator validator, Object target, Errors errors, Object... validationHints) void
AbstractBindingResult.recordFieldValue
(String field, Class<?> type, Object value) void
BindException.recordFieldValue
(String field, Class<?> type, Object value) default void
BindingResult.recordFieldValue
(String field, Class<?> type, Object value) Record the given value for the specified field.void
DataBinder.registerCustomEditor
(Class<?> requiredType, String field, PropertyEditor propertyEditor) void
DataBinder.registerCustomEditor
(Class<?> requiredType, String field, PropertyEditor propertyEditor) void
void
void
void
void
Register a global error for the entire target object, using the given error description.void
Register a global error for the entire target object, using the given error description.void
void
static void
ValidationUtils.rejectIfEmpty
(Errors errors, String field, String errorCode, Object[] errorArgs, String defaultMessage) Reject the given field with the given error code, error arguments and default message if the value is empty.static void
ValidationUtils.rejectIfEmpty
(Errors errors, String field, String errorCode, Object[] errorArgs, String defaultMessage) Reject the given field with the given error code, error arguments and default message if the value is empty.static void
ValidationUtils.rejectIfEmptyOrWhitespace
(Errors errors, String field, String errorCode, Object[] errorArgs) Reject the given field with the given error code and error arguments if the value is empty or just contains whitespace.static void
ValidationUtils.rejectIfEmptyOrWhitespace
(Errors errors, String field, String errorCode, Object[] errorArgs, String defaultMessage) Reject the given field with the given error code, error arguments and default message if the value is empty or just contains whitespace.static void
ValidationUtils.rejectIfEmptyOrWhitespace
(Errors errors, String field, String errorCode, Object[] errorArgs, String defaultMessage) Reject the given field with the given error code, error arguments and default message if the value is empty or just contains whitespace.void
AbstractBindingResult.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
AbstractBindingResult.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
AbstractBindingResult.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
BindException.rejectValue
(String field, String errorCode) void
BindException.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
BindException.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
BindException.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
BindException.rejectValue
(String field, String errorCode, String defaultMessage) default void
Errors.rejectValue
(String field, String errorCode) Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.void
Errors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.void
Errors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.void
Errors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.default void
Errors.rejectValue
(String field, String errorCode, String defaultMessage) Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.void
SimpleErrors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
SimpleErrors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
SimpleErrors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) String[]
AbstractBindingResult.resolveMessageCodes
(String errorCode, String field) String[]
DefaultMessageCodesResolver.resolveMessageCodes
(String errorCode, String objectName, String field, Class<?> fieldType) Build the code list for the given code and field: an object/field-specific code, a field-specific code, a plain error code.String[]
MessageCodesResolver.resolveMessageCodes
(String errorCode, String objectName, String field, Class<?> fieldType) Build message codes for the given error code and field specification.void
DataBinder.setAllowedFields
(String... allowedFields) Register field patterns that should be allowed for binding.void
DataBinder.setConversionService
(ConversionService conversionService) Specify aConversionService
to use for converting property values, as an alternative to JavaBeans PropertyEditors.void
DataBinder.setDisallowedFields
(String... disallowedFields) Register field patterns that should not be allowed for binding.void
DefaultMessageCodesResolver.setMessageCodeFormatter
(MessageCodeFormatter formatter) Specify the format for message codes built by this resolver.void
DataBinder.setMessageCodesResolver
(MessageCodesResolver messageCodesResolver) Set the strategy to use for resolving errors into message codes.void
AbstractErrors.setNestedPath
(String nestedPath) void
Specify a prefix to be applied to any code built by this resolver.void
DataBinder.setRequiredFields
(String... requiredFields) Register fields that are required for each binding process.void
DataBinder.setValidator
(Validator validator) Set the Validator to apply after each binding step.default void
SmartValidator.validateValue
(Class<?> targetType, String fieldName, Object value, Errors errors, Object... validationHints) Validate the supplied value for the specified field on the target type, reporting the same validation errors as if the value would be bound to the field on an instance of the target class.ModifierConstructorDescriptionBeanPropertyBindingResult
(Object target, String objectName) Create a newBeanPropertyBindingResult
for the given target.BeanPropertyBindingResult
(Object target, String objectName, boolean autoGrowNestedPaths, int autoGrowCollectionLimit) Create a newBeanPropertyBindingResult
for the given target.DataBinder
(Object target) Create a new DataBinder instance, with default object name.DataBinder
(Object target, String objectName) Create a new DataBinder instance.DirectFieldBindingResult
(Object target, String objectName) Create a newDirectFieldBindingResult
for the given target.DirectFieldBindingResult
(Object target, String objectName, boolean autoGrowNestedPaths) Create a newDirectFieldBindingResult
for the given target.FieldError
(String objectName, String field, Object rejectedValue, boolean bindingFailure, String[] codes, Object[] arguments, String defaultMessage) Create a new FieldError instance.FieldError
(String objectName, String field, Object rejectedValue, boolean bindingFailure, String[] codes, Object[] arguments, String defaultMessage) Create a new FieldError instance.FieldError
(String objectName, String field, Object rejectedValue, boolean bindingFailure, String[] codes, Object[] arguments, String defaultMessage) Create a new FieldError instance.FieldError
(String objectName, String field, Object rejectedValue, boolean bindingFailure, String[] codes, Object[] arguments, String defaultMessage) Create a new FieldError instance.ObjectError
(String objectName, String defaultMessage) Create a new instance of the ObjectError class.ObjectError
(String objectName, String[] codes, Object[] arguments, String defaultMessage) Create a new instance of the ObjectError class.ObjectError
(String objectName, String[] codes, Object[] arguments, String defaultMessage) Create a new instance of the ObjectError class.ObjectError
(String objectName, String[] codes, Object[] arguments, String defaultMessage) Create a new instance of the ObjectError class. -
Uses of Nullable in org.springframework.validation.annotation
Modifier and TypeMethodDescriptionstatic Object[]
ValidationAnnotationUtils.determineValidationHints
(Annotation ann) Determine any validation hints by the given annotation. -
Uses of Nullable in org.springframework.validation.beanvalidation
Modifier and TypeMethodDescriptionprotected Object
SpringValidatorAdapter.getRejectedValue
(String field, ConstraintViolation<Object> violation, BindingResult bindingResult) Extract the rejected value behind the given constraint violation, for exposure through the Spring errors representation.MethodValidationInterceptor.invoke
(MethodInvocation invocation) Modifier and TypeMethodDescriptionfinal Set<ConstraintViolation<Object>>
MethodValidationAdapter.invokeValidatorForReturnValue
(Object target, Method method, Object returnValue, Class<?>[] groups) Invoke the validator, and return the resulting violations.MethodValidationAdapter.ObjectNameResolver.resolveName
(MethodParameter parameter, Object value) Determine the name for the given method argument.void
LocalValidatorFactoryBean.setValidationPropertyMap
(Map<String, String> validationProperties) Specify bean validation properties to be passed to the validation provider as a Map.<T> T
<T> T
final MethodValidationResult
MethodValidationAdapter.validateArguments
(Object target, Method method, MethodParameter[] parameters, Object[] arguments, Class<?>[] groups) final MethodValidationResult
MethodValidationAdapter.validateReturnValue
(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups) final MethodValidationResult
MethodValidationAdapter.validateReturnValue
(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups) void
SpringValidatorAdapter.validateValue
(Class<?> targetType, String fieldName, Object value, Errors errors, Object... validationHints) -
Uses of Nullable in org.springframework.validation.method
Modifier and TypeMethodDescriptionParameterValidationResult.getArgument()
The method argument value that was validated.ParameterErrors.getContainer()
When@Valid
is declared on aList
orMap
method parameter, this method returns the list or map that contained the validated objectargument
, whileParameterErrors.getContainerIndex()
andParameterErrors.getContainerKey()
returns the respective index or key.ParameterErrors.getContainerIndex()
ParameterErrors.getContainerKey()
When@Valid
is declared on aMap
, this method returns the key under which the validated objectargument
is stored in the mapParameterErrors.getContainer()
.Modifier and TypeMethodDescriptiondefault void
MethodValidator.applyArgumentValidation
(Object target, Method method, MethodParameter[] parameters, Object[] arguments, Class<?>[] groups) Validate the given method arguments and handle the result.default void
MethodValidator.applyReturnValueValidation
(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups) Validate the given return value and handle the results.default void
MethodValidator.applyReturnValueValidation
(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups) Validate the given return value and handle the results.boolean
void
void
void
ParameterErrors.rejectValue
(String field, String errorCode) void
ParameterErrors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
ParameterErrors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
ParameterErrors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
ParameterErrors.rejectValue
(String field, String errorCode, String defaultMessage) MethodValidator.validateArguments
(Object target, Method method, MethodParameter[] parameters, Object[] arguments, Class<?>[] groups) Validate the given method arguments and return validation results.MethodValidator.validateReturnValue
(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups) Validate the given return value and return the result of validation.MethodValidator.validateReturnValue
(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups) Validate the given return value and return the result of validation.ModifierConstructorDescriptionParameterErrors
(MethodParameter parameter, Object argument, Errors errors, Object container, Integer index, Object key) Create aParameterErrors
.ParameterErrors
(MethodParameter parameter, Object argument, Errors errors, Object container, Integer index, Object key) Create aParameterErrors
.ParameterErrors
(MethodParameter parameter, Object argument, Errors errors, Object container, Integer index, Object key) Create aParameterErrors
.ParameterErrors
(MethodParameter parameter, Object argument, Errors errors, Object container, Integer index, Object key) Create aParameterErrors
.ParameterValidationResult
(MethodParameter param, Object arg, Collection<? extends MessageSourceResolvable> errors) Create aParameterValidationResult
. -
Uses of Nullable in org.springframework.validation.support
Modifier and TypeMethodDescription -
Uses of Nullable in org.springframework.web
Modifier and TypeMethodDescriptionHttpMediaTypeNotSupportedException.getContentType()
Return the HTTP request content type method that caused the failure.default Object[]
ErrorResponse.getDetailMessageArguments()
Return arguments to use along with amessage code
to resolve the problem "detail" for this exception through aMessageSource
.default Object[]
ErrorResponse.getDetailMessageArguments
(MessageSource messageSource, Locale locale) Variant ofErrorResponse.getDetailMessageArguments()
that uses the givenMessageSource
for resolving the message argument values.HttpSessionRequiredException.getExpectedAttribute()
Return the name of the expected session attribute, if any.HttpRequestMethodNotSupportedException.getSupportedHttpMethods()
Return the actually supported HTTP methods asHttpMethod
instances, ornull
if not known.String[]
HttpRequestMethodNotSupportedException.getSupportedMethods()
Return the actually supported HTTP methods, ornull
if not known.Modifier and TypeMethodDescriptiondefault ErrorResponse
ErrorResponse.Builder.build
(MessageSource messageSource, Locale locale) Build theErrorResponse
instance and also resolve the "detail" and "title" through the givenMessageSource
.static String
ErrorResponse.getDefaultDetailMessageCode
(Class<?> exceptionType, String suffix) Build a message code for the "detail" field, for the given exception type.Set the underlyinginstance
field.void
SpringServletContainerInitializer.onStartup
(Set<Class<?>> webAppInitializerClasses, ServletContext servletContext) Delegate theServletContext
to anyWebApplicationInitializer
implementations present on the application classpath.Set a "dynamic"property
on the underlyingProblemDetail
.void
Set thedetail
field of the response body.void
ErrorResponseException.setInstance
(URI instance) Set theinstance
field of the response body.void
Set thetitle
field of the response body.Set the underlyingtitle
field.default ProblemDetail
ErrorResponse.updateAndGetBody
(MessageSource messageSource, Locale locale) Use the givenMessageSource
to resolve thetype
,title
, anddetail
message codes, and then use the resolved values to update the corresponding fields inErrorResponse.getBody()
.ModifierConstructorDescriptionErrorResponseException
(HttpStatusCode status, Throwable cause) Constructor with anHttpStatusCode
and an optional cause.ErrorResponseException
(HttpStatusCode status, ProblemDetail body, Throwable cause) Constructor with a givenProblemDetail
instance, possibly a subclass ofProblemDetail
with extended fields.ErrorResponseException
(HttpStatusCode status, ProblemDetail body, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a givenProblemDetail
, and aMessageSource
code and arguments to resolve the detail message with.ErrorResponseException
(HttpStatusCode status, ProblemDetail body, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a givenProblemDetail
, and aMessageSource
code and arguments to resolve the detail message with.ErrorResponseException
(HttpStatusCode status, ProblemDetail body, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a givenProblemDetail
, and aMessageSource
code and arguments to resolve the detail message with.protected
HttpMediaTypeException
(String message, List<MediaType> supportedMediaTypes, String messageDetailCode, Object[] messageDetailArguments) Create a new HttpMediaTypeException with a list of supported media types.protected
HttpMediaTypeException
(String message, List<MediaType> supportedMediaTypes, String messageDetailCode, Object[] messageDetailArguments) Create a new HttpMediaTypeException with a list of supported media types.HttpMediaTypeNotSupportedException
(MediaType contentType, List<MediaType> mediaTypes) Create a new HttpMediaTypeNotSupportedException.HttpMediaTypeNotSupportedException
(MediaType contentType, List<MediaType> mediaTypes, HttpMethod httpMethod) Create a new HttpMediaTypeNotSupportedException.HttpMediaTypeNotSupportedException
(MediaType contentType, List<MediaType> mediaTypes, HttpMethod httpMethod) Create a new HttpMediaTypeNotSupportedException.HttpMediaTypeNotSupportedException
(MediaType contentType, List<MediaType> supportedMediaTypes, HttpMethod httpMethod, String message) Create a new HttpMediaTypeNotSupportedException.HttpMediaTypeNotSupportedException
(MediaType contentType, List<MediaType> supportedMediaTypes, HttpMethod httpMethod, String message) Create a new HttpMediaTypeNotSupportedException.HttpRequestMethodNotSupportedException
(String method, Collection<String> supportedMethods) Create a newHttpRequestMethodNotSupportedException
. -
Uses of Nullable in org.springframework.web.accept
Modifier and TypeMethodDescriptionPathExtensionContentNegotiationStrategy.getMediaTypeForResource
(Resource resource) Deprecated.protected abstract String
AbstractMappingContentNegotiationStrategy.getMediaTypeKey
(NativeWebRequest request) Extract a key from the request to use to look up media types.protected String
ParameterContentNegotiationStrategy.getMediaTypeKey
(NativeWebRequest request) protected String
PathExtensionContentNegotiationStrategy.getMediaTypeKey
(NativeWebRequest webRequest) Deprecated.ContentNegotiationManagerFactoryBean.getObject()
<T extends ContentNegotiationStrategy>
TContentNegotiationManager.getStrategy
(Class<T> strategyType) Find aContentNegotiationStrategy
of the given type.protected MediaType
AbstractMappingContentNegotiationStrategy.handleNoMatch
(NativeWebRequest request, String key) Override to provide handling when a key is not resolved via.protected MediaType
ServletPathExtensionContentNegotiationStrategy.handleNoMatch
(NativeWebRequest webRequest, String extension) Deprecated.Resolve file extension viaServletContext.getMimeType(String)
and also delegate to base class for a potentialMediaTypeFactory
lookup.protected MediaType
MappingMediaTypeFileExtensionResolver.lookupMediaType
(String extension) Use this method for a reverse lookup from extension to MediaType.Modifier and TypeMethodDescriptionvoid
ContentNegotiationManagerFactoryBean.addMediaTypes
(Map<String, MediaType> mediaTypes) An alternative toContentNegotiationManagerFactoryBean.setMediaTypes(java.util.Properties)
for programmatic registrations.AbstractMappingContentNegotiationStrategy.resolveMediaTypeKey
(NativeWebRequest webRequest, String key) An alternative toAbstractMappingContentNegotiationStrategy.resolveMediaTypes(NativeWebRequest)
that accepts an already extracted key.void
ContentNegotiationManagerFactoryBean.setStrategies
(List<ContentNegotiationStrategy> strategies) Set the exact list of strategies to use.ModifierConstructorDescriptionAbstractMappingContentNegotiationStrategy
(Map<String, MediaType> mediaTypes) Create an instance with the given map of file extensions and media types.MappingMediaTypeFileExtensionResolver
(Map<String, MediaType> mediaTypes) Create an instance with the given map of file extensions and media types.PathExtensionContentNegotiationStrategy
(Map<String, MediaType> mediaTypes) Deprecated.Create an instance with the given map of file extensions and media types.ServletPathExtensionContentNegotiationStrategy
(ServletContext servletContext, Map<String, MediaType> mediaTypes) Deprecated.Create an instance with the given extension-to-MediaType lookup. -
Uses of Nullable in org.springframework.web.bind
Modifier and TypeMethodDescriptionstatic Boolean
ServletRequestUtils.getBooleanParameter
(ServletRequest request, String name) Get a Boolean parameter, ornull
if not present.static Double
ServletRequestUtils.getDoubleParameter
(ServletRequest request, String name) Get a Double parameter, ornull
if not present.WebDataBinder.getEmptyValue
(Class<?> fieldType) Determine an empty value for the specified field.protected Object
WebDataBinder.getEmptyValue
(String field, Class<?> fieldType) Determine an empty value for the specified field.WebDataBinder.getFieldDefaultPrefix()
Return the prefix for parameters that mark default fields.EscapedErrors.getFieldError()
EscapedErrors.getFieldError
(String field) WebDataBinder.getFieldMarkerPrefix()
Return the prefix for parameters that mark potentially empty fields.Class<?>
EscapedErrors.getFieldType
(String field) EscapedErrors.getFieldValue
(String field) static Float
ServletRequestUtils.getFloatParameter
(ServletRequest request, String name) Get a Float parameter, ornull
if not present.EscapedErrors.getGlobalError()
static Integer
ServletRequestUtils.getIntParameter
(ServletRequest request, String name) Get an Integer parameter, ornull
if not present.static Long
ServletRequestUtils.getLongParameter
(ServletRequest request, String name) Get a Long parameter, ornull
if not present.MissingServletRequestParameterException.getMethodParameter()
Return the targetMethodParameter
if the exception was raised for a controller method argument.protected Object
ServletRequestDataBinder.ServletRequestValueResolver.getRequestParameter
(String name, Class<?> type) static String
ServletRequestUtils.getStringParameter
(ServletRequest request, String name) Get a String parameter, ornull
if not present.protected Object
WebDataBinder.resolvePrefixValue
(String name, Class<?> type, BiFunction<String, Class<?>, Object> resolver) Check if a value can be resolved ifWebDataBinder.getFieldDefaultPrefix()
orWebDataBinder.getFieldMarkerPrefix()
is prepended.final Object
ServletRequestDataBinder.ServletRequestValueResolver.resolveValue
(String name, Class<?> paramType) Modifier and TypeMethodDescriptionMethodArgumentNotValidException.errorsToStringList
(List<? extends ObjectError> errors, MessageSource messageSource, Locale locale) Deprecated, for removal: This API element is subject to removal in a future version.in favor ofBindErrorUtils
, to be removed in 6.2protected Object
WebDataBinder.getEmptyValue
(String field, Class<?> fieldType) Determine an empty value for the specified field.void
void
void
EscapedErrors.rejectValue
(String field, String errorCode) void
EscapedErrors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
EscapedErrors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
EscapedErrors.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
EscapedErrors.rejectValue
(String field, String errorCode, String defaultMessage) void
WebDataBinder.setFieldDefaultPrefix
(String fieldDefaultPrefix) Specify a prefix that can be used for parameters that indicate default value fields, having "prefix + field" as name.void
WebDataBinder.setFieldMarkerPrefix
(String fieldMarkerPrefix) Specify a prefix that can be used for parameters that mark potentially empty fields, having "prefix + field" as name.ModifierConstructorDescriptionprotected
MissingRequestValueException
(String msg, boolean missingAfterConversion, String messageDetailCode, Object[] messageDetailArguments) Constructor with a givenProblemDetail
, and aMessageSource
code and arguments to resolve the detail message with.protected
MissingRequestValueException
(String msg, boolean missingAfterConversion, String messageDetailCode, Object[] messageDetailArguments) Constructor with a givenProblemDetail
, and aMessageSource
code and arguments to resolve the detail message with.protected
ServletRequestBindingException
(String msg, String messageDetailCode, Object[] messageDetailArguments) Constructor for ServletRequestBindingException.protected
ServletRequestBindingException
(String msg, String messageDetailCode, Object[] messageDetailArguments) Constructor for ServletRequestBindingException.protected
ServletRequestBindingException
(String msg, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor for ServletRequestBindingException.protected
ServletRequestBindingException
(String msg, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor for ServletRequestBindingException.protected
ServletRequestBindingException
(String msg, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor for ServletRequestBindingException.ServletRequestDataBinder
(Object target) Create a new ServletRequestDataBinder instance, with default object name.ServletRequestDataBinder
(Object target, String objectName) Create a new ServletRequestDataBinder instance.ServletRequestParameterPropertyValues
(ServletRequest request, String prefix) Create new ServletRequestPropertyValues using the given prefix and the default prefix separator (the underscore character "_").ServletRequestParameterPropertyValues
(ServletRequest request, String prefix, String prefixSeparator) Create new ServletRequestPropertyValues supplying both prefix and prefix separator.ServletRequestParameterPropertyValues
(ServletRequest request, String prefix, String prefixSeparator) Create new ServletRequestPropertyValues supplying both prefix and prefix separator.WebDataBinder
(Object target) Create a new WebDataBinder instance, with default object name.WebDataBinder
(Object target, String objectName) Create a new WebDataBinder instance. -
Uses of Nullable in org.springframework.web.bind.annotation
Modifier and TypeMethodDescriptionstatic RequestMethod
Resolve the given method value to anRequestMethod
enum value.static RequestMethod
RequestMethod.resolve
(HttpMethod httpMethod) Resolve the givenHttpMethod
to aRequestMethod
enum value. -
Uses of Nullable in org.springframework.web.bind.support
Modifier and TypeMethodDescriptionWebExchangeBindException.findEditor
(String field, Class valueType) final BindingErrorProcessor
ConfigurableWebBindingInitializer.getBindingErrorProcessor()
Return the strategy to use for processing binding errors.final ConversionService
ConfigurableWebBindingInitializer.getConversionService()
Return the ConversionService which will apply to every DataBinder.WebExchangeBindException.getFieldError()
WebExchangeBindException.getFieldError
(String field) Class<?>
WebExchangeBindException.getFieldType
(String field) WebExchangeBindException.getFieldValue
(String field) WebExchangeBindException.getGlobalError()
final MessageCodesResolver
ConfigurableWebBindingInitializer.getMessageCodesResolver()
Return the strategy to use for resolving errors into message codes.final PropertyEditorRegistrar[]
ConfigurableWebBindingInitializer.getPropertyEditorRegistrars()
Return the PropertyEditorRegistrars to be applied to every DataBinder.WebExchangeBindException.getPropertyEditorRegistry()
WebExchangeBindException.getRawFieldValue
(String field) WebExchangeBindException.getTarget()
final Validator
ConfigurableWebBindingInitializer.getValidator()
Return the Validator to apply after each binding step, if any.WebArgumentResolver.resolveArgument
(MethodParameter methodParameter, NativeWebRequest webRequest) Resolve an argument for the given handler method parameter within the given web request.DefaultSessionAttributeStore.retrieveAttribute
(WebRequest request, String attributeName) SessionAttributeStore.retrieveAttribute
(WebRequest request, String attributeName) Retrieve the specified attribute from the backend session.Modifier and TypeMethodDescriptionfinal WebDataBinder
DefaultDataBinderFactory.createBinder
(NativeWebRequest webRequest, Object target, String objectName) Create a newWebDataBinder
for the given target object and initialize it through aWebBindingInitializer
.final WebDataBinder
DefaultDataBinderFactory.createBinder
(NativeWebRequest webRequest, Object target, String objectName, ResolvableType type) Variant ofWebDataBinderFactory.createBinder(NativeWebRequest, Object, String)
with aResolvableType
for which theDataBinder
is created.WebDataBinderFactory.createBinder
(NativeWebRequest webRequest, Object target, String objectName) Create aWebDataBinder
for the given object.default WebDataBinder
WebDataBinderFactory.createBinder
(NativeWebRequest webRequest, Object target, String objectName, ResolvableType targetType) Variant ofWebDataBinderFactory.createBinder(NativeWebRequest, Object, String)
with aResolvableType
for which theDataBinder
is created.protected WebDataBinder
DefaultDataBinderFactory.createBinderInstance
(Object target, String objectName, NativeWebRequest webRequest) Extension point to create the WebDataBinder instance.boolean
WebExchangeBindException.findEditor
(String field, Class valueType) WebExchangeBindException.findEditor
(String field, Class valueType) void
WebExchangeBindException.recordFieldValue
(String field, Class<?> type, Object value) void
void
void
WebExchangeBindException.rejectValue
(String field, String errorCode) void
WebExchangeBindException.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
WebExchangeBindException.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
WebExchangeBindException.rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) void
WebExchangeBindException.rejectValue
(String field, String errorCode, String defaultMessage) void
DefaultSessionAttributeStore.setAttributeNamePrefix
(String attributeNamePrefix) Specify a prefix to use for the attribute names in the backend session.final void
ConfigurableWebBindingInitializer.setBindingErrorProcessor
(BindingErrorProcessor bindingErrorProcessor) Set the strategy to use for processing binding errors, that is, required field errors andPropertyAccessException
s.final void
ConfigurableWebBindingInitializer.setConversionService
(ConversionService conversionService) Specify a ConversionService which will apply to every DataBinder.final void
ConfigurableWebBindingInitializer.setMessageCodesResolver
(MessageCodesResolver messageCodesResolver) Set the strategy to use for resolving errors into message codes.final void
ConfigurableWebBindingInitializer.setPropertyEditorRegistrars
(PropertyEditorRegistrar[] propertyEditorRegistrars) Specify multiple PropertyEditorRegistrars to be applied to every DataBinder.final void
ConfigurableWebBindingInitializer.setValidator
(Validator validator) Set the Validator to apply after each binding step.ModifierConstructorDescriptionDefaultDataBinderFactory
(WebBindingInitializer initializer) Create a newDefaultDataBinderFactory
instance.WebExchangeDataBinder
(Object target) Create a new instance, with default object name.WebExchangeDataBinder
(Object target, String objectName) Create a new instance.WebRequestDataBinder
(Object target) Create a new WebRequestDataBinder instance, with default object name.WebRequestDataBinder
(Object target, String objectName) Create a new WebRequestDataBinder instance. -
Uses of Nullable in org.springframework.web.client
Modifier and TypeMethodDescription<T> T
Extract the body as an object of the given type.<T> T
RestClient.ResponseSpec.body
(ParameterizedTypeReference<T> bodyType) Extract the body as an object of the given type.protected <T> T
RestTemplate.doExecute
(URI url, String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the given method on the provided URI.protected <T> T
RestTemplate.doExecute
(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Deprecated.<T> T
RestOperations.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Object... uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestOperations.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Map<String, ?> uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestOperations.execute
(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the HTTP method to the given URL, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestTemplate.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Object... uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestTemplate.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Map<String, ?> uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestTemplate.execute
(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the HTTP method to the given URL, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.ResponseExtractor.extractData
(ClientHttpResponse response) Extract data from the givenClientHttpResponse
and return it.protected Charset
DefaultResponseErrorHandler.getCharset
(ClientHttpResponse response) Determine the charset of the response (for inclusion in a status exception).<T> T
RestOperations.getForObject
(String url, Class<T> responseType, Object... uriVariables) Retrieve a representation by doing a GET on the specified URL.<T> T
RestOperations.getForObject
(String url, Class<T> responseType, Map<String, ?> uriVariables) Retrieve a representation by doing a GET on the URI template.<T> T
RestOperations.getForObject
(URI url, Class<T> responseType) Retrieve a representation by doing a GET on the URL.<T> T
RestTemplate.getForObject
(String url, Class<T> responseType, Object... uriVariables) <T> T
RestTemplate.getForObject
(String url, Class<T> responseType, Map<String, ?> uriVariables) <T> T
RestTemplate.getForObject
(URI url, Class<T> responseType) <E> E
RestClientResponseException.getResponseBodyAs
(Class<E> targetType) Convert the error response content to the specified type.<E> E
RestClientResponseException.getResponseBodyAs
(ParameterizedTypeReference<E> targetType) RestClientResponseException.getResponseHeaders()
Return the HTTP response headers.UnknownContentTypeException.getResponseHeaders()
Return the HTTP response headers.<T> T
RestOperations.patchForObject
(String url, Object request, Class<T> responseType, Object... uriVariables) Update a resource by PATCHing the given object to the URI template, and return the representation found in the response.<T> T
RestOperations.patchForObject
(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) Update a resource by PATCHing the given object to the URI template, and return the representation found in the response.<T> T
RestOperations.patchForObject
(URI url, Object request, Class<T> responseType) Update a resource by PATCHing the given object to the URL, and return the representation found in the response.<T> T
RestTemplate.patchForObject
(String url, Object request, Class<T> responseType, Object... uriVariables) <T> T
RestTemplate.patchForObject
(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) <T> T
RestTemplate.patchForObject
(URI url, Object request, Class<T> responseType) RestOperations.postForLocation
(String url, Object request, Object... uriVariables) Create a new resource by POSTing the given object to the URI template, and returns the value of theLocation
header.RestOperations.postForLocation
(String url, Object request, Map<String, ?> uriVariables) Create a new resource by POSTing the given object to the URI template, and returns the value of theLocation
header.RestOperations.postForLocation
(URI url, Object request) Create a new resource by POSTing the given object to the URL, and returns the value of theLocation
header.RestTemplate.postForLocation
(String url, Object request, Object... uriVariables) RestTemplate.postForLocation
(String url, Object request, Map<String, ?> uriVariables) RestTemplate.postForLocation
(URI url, Object request) <T> T
RestOperations.postForObject
(String url, Object request, Class<T> responseType, Object... uriVariables) Create a new resource by POSTing the given object to the URI template, and returns the representation found in the response.<T> T
RestOperations.postForObject
(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) Create a new resource by POSTing the given object to the URI template, and returns the representation found in the response.<T> T
RestOperations.postForObject
(URI url, Object request, Class<T> responseType) Create a new resource by POSTing the given object to the URL, and returns the representation found in the response.<T> T
RestTemplate.postForObject
(String url, Object request, Class<T> responseType, Object... uriVariables) <T> T
RestTemplate.postForObject
(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) <T> T
RestTemplate.postForObject
(URI url, Object request, Class<T> responseType) Modifier and TypeMethodDescriptionstatic HttpClientErrorException
HttpClientErrorException.create
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Variant ofHttpClientErrorException.create(HttpStatusCode, String, HttpHeaders, byte[], Charset)
with an optional prepared message.static HttpClientErrorException
HttpClientErrorException.create
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Variant ofHttpClientErrorException.create(HttpStatusCode, String, HttpHeaders, byte[], Charset)
with an optional prepared message.static HttpClientErrorException
HttpClientErrorException.create
(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) CreateHttpClientErrorException
or an HTTP status specific subclass.static HttpServerErrorException
HttpServerErrorException.create
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Variant ofHttpServerErrorException.create(String, HttpStatusCode, String, HttpHeaders, byte[], Charset)
with an optional prepared message.static HttpServerErrorException
HttpServerErrorException.create
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Variant ofHttpServerErrorException.create(String, HttpStatusCode, String, HttpHeaders, byte[], Charset)
with an optional prepared message.static HttpServerErrorException
HttpServerErrorException.create
(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Create anHttpServerErrorException
or an HTTP status specific subclass.protected <T> T
RestTemplate.doExecute
(URI url, String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the given method on the provided URI.protected <T> T
RestTemplate.doExecute
(URI url, String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the given method on the provided URI.protected <T> T
RestTemplate.doExecute
(URI url, String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the given method on the provided URI.protected <T> T
RestTemplate.doExecute
(URI url, String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the given method on the provided URI.protected <T> T
RestTemplate.doExecute
(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Deprecated.protected <T> T
RestTemplate.doExecute
(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Deprecated.protected <T> T
RestTemplate.doExecute
(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Deprecated.<T> ResponseEntity<T>
RestOperations.exchange
(String url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType, Object... uriVariables) Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response asResponseEntity
.<T> ResponseEntity<T>
RestOperations.exchange
(String url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType, Map<String, ?> uriVariables) Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response asResponseEntity
.<T> ResponseEntity<T>
RestOperations.exchange
(String url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Object... uriVariables) Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response asResponseEntity
.<T> ResponseEntity<T>
RestOperations.exchange
(String url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Map<String, ?> uriVariables) Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response asResponseEntity
.<T> ResponseEntity<T>
RestOperations.exchange
(URI url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType) Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response asResponseEntity
.<T> ResponseEntity<T>
RestOperations.exchange
(URI url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response asResponseEntity
.<T> ResponseEntity<T>
RestTemplate.exchange
(String url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType, Object... uriVariables) <T> ResponseEntity<T>
RestTemplate.exchange
(String url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType, Map<String, ?> uriVariables) <T> ResponseEntity<T>
RestTemplate.exchange
(String url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Object... uriVariables) <T> ResponseEntity<T>
RestTemplate.exchange
(String url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Map<String, ?> uriVariables) <T> ResponseEntity<T>
RestTemplate.exchange
(URI url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType) <T> ResponseEntity<T>
RestTemplate.exchange
(URI url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) <T> T
RestOperations.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Object... uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestOperations.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Object... uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestOperations.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Map<String, ?> uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestOperations.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Map<String, ?> uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestOperations.execute
(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the HTTP method to the given URL, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestOperations.execute
(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the HTTP method to the given URL, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestTemplate.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Object... uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestTemplate.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Object... uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestTemplate.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Map<String, ?> uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestTemplate.execute
(String uriTemplate, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Map<String, ?> uriVariables) Execute the HTTP method to the given URI template, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestTemplate.execute
(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the HTTP method to the given URL, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> T
RestTemplate.execute
(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor) Execute the HTTP method to the given URL, preparing the request with theRequestCallback
, and reading the response with aResponseExtractor
.<T> RequestCallback
RestTemplate.httpEntityCallback
(Object requestBody) Return aRequestCallback
implementation that writes the given object to the request stream.<T> RequestCallback
RestTemplate.httpEntityCallback
(Object requestBody, Type responseType) Return aRequestCallback
implementation that: Sets the requestAccept
header based on the given response type, cross-checked against the configured message converters.<T> T
RestOperations.patchForObject
(String url, Object request, Class<T> responseType, Object... uriVariables) Update a resource by PATCHing the given object to the URI template, and return the representation found in the response.<T> T
RestOperations.patchForObject
(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) Update a resource by PATCHing the given object to the URI template, and return the representation found in the response.<T> T
RestOperations.patchForObject
(URI url, Object request, Class<T> responseType) Update a resource by PATCHing the given object to the URL, and return the representation found in the response.<T> T
RestTemplate.patchForObject
(String url, Object request, Class<T> responseType, Object... uriVariables) <T> T
RestTemplate.patchForObject
(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) <T> T
RestTemplate.patchForObject
(URI url, Object request, Class<T> responseType) <T> ResponseEntity<T>
RestOperations.postForEntity
(String url, Object request, Class<T> responseType, Object... uriVariables) Create a new resource by POSTing the given object to the URI template, and returns the response asResponseEntity
.<T> ResponseEntity<T>
RestOperations.postForEntity
(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) Create a new resource by POSTing the given object to the URI template, and returns the response asHttpEntity
.<T> ResponseEntity<T>
RestOperations.postForEntity
(URI url, Object request, Class<T> responseType) Create a new resource by POSTing the given object to the URL, and returns the response asResponseEntity
.<T> ResponseEntity<T>
RestTemplate.postForEntity
(String url, Object request, Class<T> responseType, Object... uriVariables) <T> ResponseEntity<T>
RestTemplate.postForEntity
(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) <T> ResponseEntity<T>
RestTemplate.postForEntity
(URI url, Object request, Class<T> responseType) RestOperations.postForLocation
(String url, Object request, Object... uriVariables) Create a new resource by POSTing the given object to the URI template, and returns the value of theLocation
header.RestOperations.postForLocation
(String url, Object request, Map<String, ?> uriVariables) Create a new resource by POSTing the given object to the URI template, and returns the value of theLocation
header.RestOperations.postForLocation
(URI url, Object request) Create a new resource by POSTing the given object to the URL, and returns the value of theLocation
header.RestTemplate.postForLocation
(String url, Object request, Object... uriVariables) RestTemplate.postForLocation
(String url, Object request, Map<String, ?> uriVariables) RestTemplate.postForLocation
(URI url, Object request) <T> T
RestOperations.postForObject
(String url, Object request, Class<T> responseType, Object... uriVariables) Create a new resource by POSTing the given object to the URI template, and returns the representation found in the response.<T> T
RestOperations.postForObject
(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) Create a new resource by POSTing the given object to the URI template, and returns the representation found in the response.<T> T
RestOperations.postForObject
(URI url, Object request, Class<T> responseType) Create a new resource by POSTing the given object to the URL, and returns the representation found in the response.<T> T
RestTemplate.postForObject
(String url, Object request, Class<T> responseType, Object... uriVariables) <T> T
RestTemplate.postForObject
(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables) <T> T
RestTemplate.postForObject
(URI url, Object request, Class<T> responseType) void
Create or update a resource by PUTting the given object to the URI.void
Creates a new resource by PUTting the given object to URI template.void
Creates a new resource by PUTting the given object to URL.void
void
void
ModifierConstructorDescriptionHttpClientErrorException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset responseCharset) Constructor with a status code and status text, headers, and content, and a prepared message.HttpClientErrorException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset responseCharset) Constructor with a status code and status text, headers, and content, and a prepared message.HttpClientErrorException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset responseCharset) Constructor with a status code and status text, headers, and content, and a prepared message.HttpClientErrorException
(HttpStatusCode statusCode, String statusText, byte[] body, Charset responseCharset) Constructor with a status code and status text, and content.HttpClientErrorException
(HttpStatusCode statusCode, String statusText, byte[] body, Charset responseCharset) Constructor with a status code and status text, and content.HttpClientErrorException
(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset responseCharset) Constructor with a status code and status text, headers, and content.HttpClientErrorException
(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset responseCharset) Constructor with a status code and status text, headers, and content.HttpClientErrorException
(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset responseCharset) Constructor with a status code and status text, headers, and content.HttpServerErrorException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Constructor with a status code and status text, headers, content, and a prepared message.HttpServerErrorException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Constructor with a status code and status text, headers, content, and a prepared message.HttpServerErrorException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Constructor with a status code and status text, headers, content, and a prepared message.HttpServerErrorException
(HttpStatusCode statusCode, String statusText, byte[] body, Charset charset) Constructor with a status code and status text, and content.HttpServerErrorException
(HttpStatusCode statusCode, String statusText, byte[] body, Charset charset) Constructor with a status code and status text, and content.HttpServerErrorException
(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Constructor with a status code and status text, headers, and content.HttpServerErrorException
(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Constructor with a status code and status text, headers, and content.HttpServerErrorException
(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Constructor with a status code and status text, headers, and content.protected
HttpStatusCodeException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct instance with anHttpStatusCode
, status text, content, and a response charset.protected
HttpStatusCodeException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct instance with anHttpStatusCode
, status text, content, and a response charset.protected
HttpStatusCodeException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct instance with anHttpStatusCode
, status text, content, and a response charset.protected
HttpStatusCodeException
(HttpStatusCode statusCode, String statusText, byte[] responseBody, Charset responseCharset) Construct instance with anHttpStatusCode
, status text, and content.protected
HttpStatusCodeException
(HttpStatusCode statusCode, String statusText, byte[] responseBody, Charset responseCharset) Construct instance with anHttpStatusCode
, status text, and content.protected
HttpStatusCodeException
(HttpStatusCode statusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct instance with anHttpStatusCode
, status text, content, and a response charset.protected
HttpStatusCodeException
(HttpStatusCode statusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct instance with anHttpStatusCode
, status text, content, and a response charset.protected
HttpStatusCodeException
(HttpStatusCode statusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct instance with anHttpStatusCode
, status text, content, and a response charset.RestClientResponseException
(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset responseCharset) Construct a new instance of with the given response data.RestClientResponseException
(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset responseCharset) Construct a new instance of with the given response data.RestClientResponseException
(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset responseCharset) Construct a new instance of with the given response data.RestClientResponseException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset responseCharset) Construct a new instance of with the given response data.RestClientResponseException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset responseCharset) Construct a new instance of with the given response data.RestClientResponseException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset responseCharset) Construct a new instance of with the given response data.UnknownHttpStatusCodeException
(int rawStatusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct a new instance ofHttpStatusCodeException
based on a status code, status text, and response body content.UnknownHttpStatusCodeException
(int rawStatusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct a new instance ofHttpStatusCodeException
based on a status code, status text, and response body content.UnknownHttpStatusCodeException
(int rawStatusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct a new instance ofHttpStatusCodeException
based on a status code, status text, and response body content.UnknownHttpStatusCodeException
(String message, int rawStatusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct a new instance ofHttpStatusCodeException
based on a status code, status text, and response body content.UnknownHttpStatusCodeException
(String message, int rawStatusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct a new instance ofHttpStatusCodeException
based on a status code, status text, and response body content.UnknownHttpStatusCodeException
(String message, int rawStatusCode, String statusText, HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) Construct a new instance ofHttpStatusCodeException
based on a status code, status text, and response body content. -
Uses of Nullable in org.springframework.web.context
Modifier and TypeMethodDescriptionprotected abstract WebApplicationContext
AbstractContextLoaderInitializer.createRootApplicationContext()
Create the "root" application context to be provided to theContextLoaderListener
.String[]
ConfigurableWebApplicationContext.getConfigLocations()
Return the config locations for this web application context, ornull
if none specified.static WebApplicationContext
ContextLoader.getCurrentWebApplicationContext()
Obtain the Spring root web application context for the current thread (i.e.ConfigurableWebApplicationContext.getNamespace()
Return the namespace for this web application context, if any.protected ApplicationContextInitializer<?>[]
AbstractContextLoaderInitializer.getRootApplicationContextInitializers()
Specify application context initializers to be applied to the root application context that theContextLoaderListener
is being created with.ConfigurableWebApplicationContext.getServletConfig()
Return the ServletConfig for this web application context, if any.WebApplicationContext.getServletContext()
Return the standard Servlet API ServletContext for this application.protected ApplicationContext
ContextLoader.loadParentContext
(ServletContext servletContext) Template method with default implementation (which may be overridden by a subclass), to load or obtain an ApplicationContext instance which will be used as the parent context of the root WebApplicationContext.Modifier and TypeMethodDescriptionvoid
ConfigurableWebEnvironment.initPropertySources
(ServletContext servletContext, ServletConfig servletConfig) Replace any stub property source instances acting as placeholders with real servlet context/config property sources using the given parameters.void
ConfigurableWebEnvironment.initPropertySources
(ServletContext servletContext, ServletConfig servletConfig) Replace any stub property source instances acting as placeholders with real servlet context/config property sources using the given parameters.void
ContextLoader.setContextInitializers
(ApplicationContextInitializer<?>... initializers) Specify whichApplicationContextInitializer
instances should be used to initialize the application context used by thisContextLoader
.void
ConfigurableWebApplicationContext.setNamespace
(String namespace) Set the namespace for this web application context, to be used for building a default context config location.void
ConfigurableWebApplicationContext.setServletConfig
(ServletConfig servletConfig) Set the ServletConfig for this web application context.void
ConfigurableWebApplicationContext.setServletContext
(ServletContext servletContext) Set the ServletContext for this web application context. -
Uses of Nullable in org.springframework.web.context.request
Modifier and TypeMethodDescriptionRequestAttributes.getAttribute
(String name, int scope) Return the value for the scoped attribute of the given name, if any.RequestScope.getConversationId()
There is no conversation id concept for a request, so this method returnsnull
.Return the request header of the given name, ornull
if none.String[]
FacesWebRequest.getHeaderValues
(String headerName) String[]
ServletWebRequest.getHeaderValues
(String headerName) String[]
WebRequest.getHeaderValues
(String headerName) Return the request header values for the given header name, ornull
if none.<T> T
NativeWebRequest.getNativeRequest
(Class<T> requiredType) Return the underlying native request object, if available.NativeWebRequest.getNativeResponse()
Return the underlying native response object, if any.<T> T
NativeWebRequest.getNativeResponse
(Class<T> requiredType) Return the underlying native response object, if available.FacesWebRequest.getParameter
(String paramName) ServletWebRequest.getParameter
(String paramName) WebRequest.getParameter
(String paramName) Return the request parameter of the given name, ornull
if none.String[]
FacesWebRequest.getParameterValues
(String paramName) String[]
ServletWebRequest.getParameterValues
(String paramName) String[]
WebRequest.getParameterValues
(String paramName) Return the request parameter values for the given parameter name, ornull
if none.FacesWebRequest.getRemoteUser()
ServletWebRequest.getRemoteUser()
WebRequest.getRemoteUser()
Return the remote user for this request, if any.static RequestAttributes
RequestContextHolder.getRequestAttributes()
Return the RequestAttributes currently bound to the thread.final HttpServletResponse
ServletRequestAttributes.getResponse()
Exposes the nativeHttpServletResponse
that we're wrapping (if any).protected final HttpSession
ServletRequestAttributes.getSession
(boolean allowCreate) Exposes theHttpSession
that we're wrapping.FacesWebRequest.getUserPrincipal()
ServletWebRequest.getUserPrincipal()
WebRequest.getUserPrincipal()
Return the user principal for this request, if any.AbstractRequestAttributesScope.resolveContextualObject
(String key) RequestAttributes.resolveReference
(String key) Resolve the contextual reference for the given key, if any.Modifier and TypeMethodDescriptionvoid
WebRequestInterceptor.afterCompletion
(WebRequest request, Exception ex) Callback after completion of request processing, that is, after rendering the view.boolean
FacesWebRequest.checkNotModified
(String eTag) boolean
FacesWebRequest.checkNotModified
(String etag, long lastModifiedTimestamp) boolean
ServletWebRequest.checkNotModified
(String eTag, long lastModifiedTimestamp) boolean
WebRequest.checkNotModified
(String etag, long lastModifiedTimestamp) Check whether the requested resource has been modified given the suppliedETag
(entity tag) and last-modified timestamp, as determined by the application.<T> T
FacesWebRequest.getNativeRequest
(Class<T> requiredType) <T> T
NativeWebRequest.getNativeRequest
(Class<T> requiredType) Return the underlying native request object, if available.<T> T
ServletWebRequest.getNativeRequest
(Class<T> requiredType) <T> T
FacesWebRequest.getNativeResponse
(Class<T> requiredType) <T> T
NativeWebRequest.getNativeResponse
(Class<T> requiredType) Return the underlying native response object, if available.<T> T
ServletWebRequest.getNativeResponse
(Class<T> requiredType) protected boolean
ServletRequestAttributes.isImmutableSessionAttribute
(String name, Object value) Determine whether the given value is to be considered as an immutable session attribute, that is, doesn't have to be re-set viasession.setAttribute
since its value cannot meaningfully change internally.void
WebRequestInterceptor.postHandle
(WebRequest request, ModelMap model) Intercept the execution of a request handler after its successful invocation, right before view rendering (if any).static void
RequestContextHolder.setRequestAttributes
(RequestAttributes attributes) Bind the given RequestAttributes to the current thread, not exposing it as inheritable for child threads.static void
RequestContextHolder.setRequestAttributes
(RequestAttributes attributes, boolean inheritable) Bind the given RequestAttributes to the current thread.ModifierConstructorDescriptionServletRequestAttributes
(HttpServletRequest request, HttpServletResponse response) Create a new ServletRequestAttributes instance for the given request.ServletWebRequest
(HttpServletRequest request, HttpServletResponse response) Create a new ServletWebRequest instance for the given request/response pair. -
Uses of Nullable in org.springframework.web.context.request.async
Modifier and TypeMethodDescriptionWebAsyncManager.getCallableInterceptor
(Object key) Get theCallableProcessingInterceptor
registered under the given key.Object[]
WebAsyncManager.getConcurrentResultContext()
Provides access to additional processing context saved at the start of concurrent handling.WebAsyncManager.getDeferredResultInterceptor
(Object key) Get theDeferredResultProcessingInterceptor
registered under the given key.WebAsyncTask.getExecutor()
Return the AsyncTaskExecutor to use for concurrent handling, ornull
if none specified.DeferredResult.getResult()
Return the result, ornull
if the result wasn't set.WebAsyncTask.getTimeout()
Return the timeout value in milliseconds, ornull
if no timeout is set.Modifier and TypeMethodDescriptionvoid
DeferredResult.DeferredResultHandler.handleResult
(Object result) default <T> void
CallableProcessingInterceptor.postProcess
(NativeWebRequest request, Callable<T> task, Object concurrentResult) Invoked after theCallable
has produced a result in the async thread in which theCallable
is executed.default <T> void
DeferredResultProcessingInterceptor.postProcess
(NativeWebRequest request, DeferredResult<T> deferredResult, Object concurrentResult) Invoked after aDeferredResult
has been set, viaDeferredResult.setResult(Object)
orDeferredResult.setErrorResult(Object)
, and is also ready to handle the concurrent result.void
AsyncWebRequest.setTimeout
(Long timeout) Set the time required for concurrent handling to complete.ModifierConstructorDescriptionDeferredResult
(Long timeoutValue, Object timeoutResult) Create a DeferredResult with a timeout value and a default result to use in case of timeout.DeferredResult
(Long timeoutValue, Supplier<?> timeoutResult) Variant ofDeferredResult(Long, Object)
that accepts a dynamic fallback value based on aSupplier
.WebAsyncTask
(Long timeout, String executorName, Callable<V> callable) Create aWebAsyncTask
with a timeout value, an executor name, and aCallable
.WebAsyncTask
(Long timeout, AsyncTaskExecutor executor, Callable<V> callable) Create aWebAsyncTask
with a timeout value, an executor instance, and a Callable. -
Uses of Nullable in org.springframework.web.context.support
Modifier and TypeMethodDescriptionstatic WebApplicationContext
WebApplicationContextUtils.findWebApplicationContext
(ServletContext sc) Find a uniqueWebApplicationContext
for this web app: either the root web app context (preferred) or a uniqueWebApplicationContext
among the registeredServletContext
attributes (typically coming from a singleDispatcherServlet
in the current web application).ContextExposingHttpServletRequest.getAttribute
(String name) protected BeanNameGenerator
AnnotationConfigWebApplicationContext.getBeanNameGenerator()
Return the customBeanNameGenerator
for use withAnnotatedBeanDefinitionReader
and/orClassPathBeanDefinitionScanner
, if any.ServletContextScope.getConversationId()
RequestHandledEvent.getFailureCause()
Return the cause of failure, if any.ServletContextResource.getFilename()
This implementation returns the name of the file that this ServletContext resource refers to.AbstractRefreshableWebApplicationContext.getNamespace()
GenericWebApplicationContext.getNamespace()
StaticWebApplicationContext.getNamespace()
ServletContextAttributeFactoryBean.getObject()
ServletContextParameterFactoryBean.getObject()
GroovyWebApplicationContext.getProperty
(String property) ServletConfigPropertySource.getProperty
(String name) ServletContextPropertySource.getProperty
(String name) protected ScopeMetadataResolver
AnnotationConfigWebApplicationContext.getScopeMetadataResolver()
Return the customScopeMetadataResolver
for use withAnnotatedBeanDefinitionReader
and/orClassPathBeanDefinitionScanner
, if any.AbstractRefreshableWebApplicationContext.getServletConfig()
GenericWebApplicationContext.getServletConfig()
protected ServletConfig
ServletContextAwareProcessor.getServletConfig()
Returns theServletConfig
to be injected ornull
.StaticWebApplicationContext.getServletConfig()
AbstractRefreshableWebApplicationContext.getServletContext()
GenericWebApplicationContext.getServletContext()
protected ServletContext
ServletContextAwareProcessor.getServletContext()
Returns theServletContext
to be injected ornull
.StaticWebApplicationContext.getServletContext()
protected final ServletContext
WebApplicationObjectSupport.getServletContext()
Return the current ServletContext.RequestHandledEvent.getSessionId()
Return the id of the HTTP session, if any.Deprecated.Deprecated.Deprecated.RequestHandledEvent.getUserName()
Return the name of the user that was associated with the request (usually the UserPrincipal).static WebApplicationContext
WebApplicationContextUtils.getWebApplicationContext
(ServletContext sc) Find the rootWebApplicationContext
for this web app, typically loaded viaContextLoaderListener
.static WebApplicationContext
WebApplicationContextUtils.getWebApplicationContext
(ServletContext sc, String attrName) Find a customWebApplicationContext
for this web app.protected final WebApplicationContext
WebApplicationObjectSupport.getWebApplicationContext()
Return the current application context as WebApplicationContext.ServletContextScope.resolveContextualObject
(String key) Modifier and TypeMethodDescriptionboolean
This implementation compares the underlying ServletContext resource locations.void
StandardServletEnvironment.initPropertySources
(ServletContext servletContext, ServletConfig servletConfig) void
StandardServletEnvironment.initPropertySources
(ServletContext servletContext, ServletConfig servletConfig) static void
WebApplicationContextUtils.initServletPropertySources
(MutablePropertySources sources, ServletContext servletContext, ServletConfig servletConfig) ReplaceServlet
-basedstub property sources
with actual instances populated with the givenservletContext
andservletConfig
objects.static void
WebApplicationContextUtils.initServletPropertySources
(MutablePropertySources sources, ServletContext servletContext, ServletConfig servletConfig) ReplaceServlet
-basedstub property sources
with actual instances populated with the givenservletContext
andservletConfig
objects.static void
WebApplicationContextUtils.registerEnvironmentBeans
(ConfigurableListableBeanFactory bf, ServletContext sc) Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebApplicationContext.static void
WebApplicationContextUtils.registerEnvironmentBeans
(ConfigurableListableBeanFactory bf, ServletContext servletContext, ServletConfig servletConfig) Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebApplicationContext.static void
WebApplicationContextUtils.registerEnvironmentBeans
(ConfigurableListableBeanFactory bf, ServletContext servletContext, ServletConfig servletConfig) Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebApplicationContext.static void
WebApplicationContextUtils.registerWebApplicationScopes
(ConfigurableListableBeanFactory beanFactory, ServletContext sc) Register web-specific scopes ("request", "session", "globalSession", "application") with the given BeanFactory, as used by the WebApplicationContext.void
AnnotationConfigWebApplicationContext.setBeanNameGenerator
(BeanNameGenerator beanNameGenerator) Set a customBeanNameGenerator
for use withAnnotatedBeanDefinitionReader
and/orClassPathBeanDefinitionScanner
.void
AbstractRefreshableWebApplicationContext.setNamespace
(String namespace) void
GenericWebApplicationContext.setNamespace
(String namespace) void
StaticWebApplicationContext.setNamespace
(String namespace) void
AnnotationConfigWebApplicationContext.setScopeMetadataResolver
(ScopeMetadataResolver scopeMetadataResolver) Set a customScopeMetadataResolver
for use withAnnotatedBeanDefinitionReader
and/orClassPathBeanDefinitionScanner
.void
AbstractRefreshableWebApplicationContext.setServletConfig
(ServletConfig servletConfig) void
GenericWebApplicationContext.setServletConfig
(ServletConfig servletConfig) void
StaticWebApplicationContext.setServletConfig
(ServletConfig servletConfig) void
AbstractRefreshableWebApplicationContext.setServletContext
(ServletContext servletContext) void
GenericWebApplicationContext.setServletContext
(ServletContext servletContext) Set theServletContext
that thisWebApplicationContext
runs in.void
StaticWebApplicationContext.setServletContext
(ServletContext servletContext) Set the ServletContext that this WebApplicationContext runs in.ModifierConstructorDescriptionContextExposingHttpServletRequest
(HttpServletRequest originalRequest, WebApplicationContext context, Set<String> exposedContextBeanNames) Create a new ContextExposingHttpServletRequest for the given request.RequestHandledEvent
(Object source, String sessionId, String userName, long processingTimeMillis) Create a new RequestHandledEvent with session information.RequestHandledEvent
(Object source, String sessionId, String userName, long processingTimeMillis) Create a new RequestHandledEvent with session information.RequestHandledEvent
(Object source, String sessionId, String userName, long processingTimeMillis, Throwable failureCause) Create a new RequestHandledEvent with session information.RequestHandledEvent
(Object source, String sessionId, String userName, long processingTimeMillis, Throwable failureCause) Create a new RequestHandledEvent with session information.RequestHandledEvent
(Object source, String sessionId, String userName, long processingTimeMillis, Throwable failureCause) Create a new RequestHandledEvent with session information.ServletContextAwareProcessor
(ServletContext servletContext, ServletConfig servletConfig) Create a new ServletContextAwareProcessor for the given context and config.ServletContextAwareProcessor
(ServletContext servletContext, ServletConfig servletConfig) Create a new ServletContextAwareProcessor for the given context and config.ServletRequestHandledEvent
(Object source, String requestUrl, String clientAddress, String method, String servletName, String sessionId, String userName, long processingTimeMillis) Create a new ServletRequestHandledEvent.ServletRequestHandledEvent
(Object source, String requestUrl, String clientAddress, String method, String servletName, String sessionId, String userName, long processingTimeMillis) Create a new ServletRequestHandledEvent.ServletRequestHandledEvent
(Object source, String requestUrl, String clientAddress, String method, String servletName, String sessionId, String userName, long processingTimeMillis, Throwable failureCause) Create a new ServletRequestHandledEvent.ServletRequestHandledEvent
(Object source, String requestUrl, String clientAddress, String method, String servletName, String sessionId, String userName, long processingTimeMillis, Throwable failureCause) Create a new ServletRequestHandledEvent.ServletRequestHandledEvent
(Object source, String requestUrl, String clientAddress, String method, String servletName, String sessionId, String userName, long processingTimeMillis, Throwable failureCause) Create a new ServletRequestHandledEvent.ServletRequestHandledEvent
(Object source, String requestUrl, String clientAddress, String method, String servletName, String sessionId, String userName, long processingTimeMillis, Throwable failureCause, int statusCode) Create a new ServletRequestHandledEvent.ServletRequestHandledEvent
(Object source, String requestUrl, String clientAddress, String method, String servletName, String sessionId, String userName, long processingTimeMillis, Throwable failureCause, int statusCode) Create a new ServletRequestHandledEvent.ServletRequestHandledEvent
(Object source, String requestUrl, String clientAddress, String method, String servletName, String sessionId, String userName, long processingTimeMillis, Throwable failureCause, int statusCode) Create a new ServletRequestHandledEvent. -
Uses of Nullable in org.springframework.web.cors
Modifier and TypeMethodDescriptionCorsConfiguration.checkHeaders
(List<String> requestHeaders) Check the supplied request headers (or the headers listed in theAccess-Control-Request-Headers
of a pre-flight request) against the configured allowed headers.DefaultCorsProcessor.checkHeaders
(CorsConfiguration config, List<String> requestHeaders) Check the headers and determine the headers for the response of a pre-flight request.CorsConfiguration.checkHttpMethod
(HttpMethod requestMethod) Check the HTTP request method (or the method from theAccess-Control-Request-Method
header on a pre-flight request) against the configured allowed methods.protected List<HttpMethod>
DefaultCorsProcessor.checkMethods
(CorsConfiguration config, HttpMethod requestMethod) Check the HTTP method and determine the methods for the response of a pre-flight request.CorsConfiguration.checkOrigin
(String origin) Check the origin of the request against the configured allowed origins.protected String
DefaultCorsProcessor.checkOrigin
(CorsConfiguration config, String requestOrigin) Check the origin and determine the origin for the response.CorsConfiguration.getAllowCredentials()
Return the configuredallowCredentials
flag, ornull
if none.CorsConfiguration.getAllowedHeaders()
Return the allowed actual request headers, ornull
if none.CorsConfiguration.getAllowedMethods()
Return the allowed HTTP methods, ornull
in which case only"GET"
and"HEAD"
allowed.CorsConfiguration.getAllowedOriginPatterns()
Return the configured origins patterns to allow, ornull
if none.CorsConfiguration.getAllowedOrigins()
Return the configured origins to allow, ornull
if none.CorsConfigurationSource.getCorsConfiguration
(HttpServletRequest request) Return aCorsConfiguration
based on the incoming request.UrlBasedCorsConfigurationSource.getCorsConfiguration
(HttpServletRequest request) CorsConfiguration.getExposedHeaders()
Return the configured response headers to expose, ornull
if none.CorsConfiguration.getMaxAge()
Return the configuredmaxAge
value, ornull
if none.Modifier and TypeMethodDescriptionvoid
CorsConfiguration.addAllowedOrigin
(String origin) Variant ofCorsConfiguration.setAllowedOrigins(java.util.List<java.lang.String>)
for adding one origin at a time.void
CorsConfiguration.addAllowedOriginPattern
(String originPattern) Variant ofCorsConfiguration.setAllowedOriginPatterns(java.util.List<java.lang.String>)
for adding one origin at a time.CorsConfiguration.checkHeaders
(List<String> requestHeaders) Check the supplied request headers (or the headers listed in theAccess-Control-Request-Headers
of a pre-flight request) against the configured allowed headers.CorsConfiguration.checkHttpMethod
(HttpMethod requestMethod) Check the HTTP request method (or the method from theAccess-Control-Request-Method
header on a pre-flight request) against the configured allowed methods.protected List<HttpMethod>
DefaultCorsProcessor.checkMethods
(CorsConfiguration config, HttpMethod requestMethod) Check the HTTP method and determine the methods for the response of a pre-flight request.CorsConfiguration.checkOrigin
(String origin) Check the origin of the request against the configured allowed origins.protected String
DefaultCorsProcessor.checkOrigin
(CorsConfiguration config, String requestOrigin) Check the origin and determine the origin for the response.CorsConfiguration.combine
(CorsConfiguration other) Combine the non-null properties of the suppliedCorsConfiguration
with this one.boolean
CorsProcessor.processRequest
(CorsConfiguration configuration, HttpServletRequest request, HttpServletResponse response) Process a request given aCorsConfiguration
.boolean
DefaultCorsProcessor.processRequest
(CorsConfiguration config, HttpServletRequest request, HttpServletResponse response) void
CorsConfiguration.setAllowCredentials
(Boolean allowCredentials) Whether user credentials are supported.void
CorsConfiguration.setAllowedHeaders
(List<String> allowedHeaders) Set the list of headers that a pre-flight request can list as allowed for use during an actual request.void
CorsConfiguration.setAllowedMethods
(List<String> allowedMethods) Set the HTTP methods to allow, e.g.CorsConfiguration.setAllowedOriginPatterns
(List<String> allowedOriginPatterns) Alternative toCorsConfiguration.setAllowedOrigins(java.util.List<java.lang.String>)
that supports more flexible origins patterns with "*" anywhere in the host name in addition to port lists.void
CorsConfiguration.setAllowedOrigins
(List<String> origins) A list of origins for which cross-origin requests are allowed where each value may be one of the following: a specific domain, e.g.void
UrlBasedCorsConfigurationSource.setCorsConfigurations
(Map<String, CorsConfiguration> corsConfigurations) Set the CORS configuration mappings.void
CorsConfiguration.setExposedHeaders
(List<String> exposedHeaders) Set the list of response headers other than simple headers (i.e.void
Configure how long, in seconds, the response from a pre-flight request can be cached by clients. -
Uses of Nullable in org.springframework.web.cors.reactive
Modifier and TypeMethodDescriptionDefaultCorsProcessor.checkHeaders
(CorsConfiguration config, List<String> requestHeaders) Check the headers and determine the headers for the response of a pre-flight request.protected List<HttpMethod>
DefaultCorsProcessor.checkMethods
(CorsConfiguration config, HttpMethod requestMethod) Check the HTTP method and determine the methods for the response of a pre-flight request.protected String
DefaultCorsProcessor.checkOrigin
(CorsConfiguration config, String requestOrigin) Check the origin and determine the origin for the response.CorsConfigurationSource.getCorsConfiguration
(ServerWebExchange exchange) Return aCorsConfiguration
based on the incoming request.UrlBasedCorsConfigurationSource.getCorsConfiguration
(ServerWebExchange exchange) Modifier and TypeMethodDescriptionprotected List<HttpMethod>
DefaultCorsProcessor.checkMethods
(CorsConfiguration config, HttpMethod requestMethod) Check the HTTP method and determine the methods for the response of a pre-flight request.protected String
DefaultCorsProcessor.checkOrigin
(CorsConfiguration config, String requestOrigin) Check the origin and determine the origin for the response.boolean
CorsProcessor.process
(CorsConfiguration configuration, ServerWebExchange exchange) Process a request using the givenCorsConfiguration
.boolean
DefaultCorsProcessor.process
(CorsConfiguration config, ServerWebExchange exchange) void
UrlBasedCorsConfigurationSource.setCorsConfigurations
(Map<String, CorsConfiguration> configMap) Set CORS configuration based on URL patterns. -
Uses of Nullable in org.springframework.web.filter
Modifier and TypeMethodDescriptionprotected WebApplicationContext
DelegatingFilterProxy.findWebApplicationContext()
Return theWebApplicationContext
passed in at construction time, if available.DelegatingFilterProxy.getContextAttribute()
Return the name of the ServletContext attribute which should be used to retrieve theWebApplicationContext
from which to load the delegateFilter
bean.CharacterEncodingFilter.getEncoding()
Return the configured encoding for requests and/or responses.GenericFilterBean.getFilterConfig()
Make the FilterConfig of this filter available, if any.protected String
GenericFilterBean.getFilterName()
Make the name of this filter available to subclasses.AbstractRequestLoggingFilter.getHeaderPredicate()
The configuredheaderPredicate
.protected String
AbstractRequestLoggingFilter.getMessagePayload
(HttpServletRequest request) Extracts the message payload portion of the message created byAbstractRequestLoggingFilter.createMessage(HttpServletRequest, String, String)
whenAbstractRequestLoggingFilter.isIncludePayload()
returns true.protected String
DelegatingFilterProxy.getTargetBeanName()
Return the name of the target bean in the Spring application context.Modifier and TypeMethodDescriptionvoid
DelegatingFilterProxy.setContextAttribute
(String contextAttribute) Set the name of the ServletContext attribute which should be used to retrieve theWebApplicationContext
from which to load the delegateFilter
bean.void
CharacterEncodingFilter.setEncoding
(String encoding) Set the encoding to use for requests.void
AbstractRequestLoggingFilter.setHeaderPredicate
(Predicate<String> headerPredicate) Configure a predicate for selecting which headers should be logged ifAbstractRequestLoggingFilter.setIncludeHeaders(boolean)
is set totrue
.void
DelegatingFilterProxy.setTargetBeanName
(String targetBeanName) Set the name of the target bean in the Spring application context.ModifierConstructorDescriptionDelegatingFilterProxy
(String targetBeanName, WebApplicationContext wac) Create a newDelegatingFilterProxy
that will retrieve the named target bean from the given SpringWebApplicationContext
. -
Uses of Nullable in org.springframework.web.jsf
Modifier and TypeMethodDescriptionfinal NavigationHandler
DecoratingNavigationHandler.getDecoratedNavigationHandler()
Return the fixed original NavigationHandler decorated by this handler, if any (that is, if passed in through the constructor).static Object
FacesContextUtils.getSessionMutex
(FacesContext fc) Return the best available mutex for the given session: that is, an object to synchronize on for the given session.static WebApplicationContext
FacesContextUtils.getWebApplicationContext
(FacesContext fc) Find the rootWebApplicationContext
for this web app, typically loaded viaContextLoaderListener
.Modifier and TypeMethodDescriptionprotected final void
DecoratingNavigationHandler.callNextHandlerInChain
(FacesContext facesContext, String fromAction, String outcome, NavigationHandler originalNavigationHandler) Method to be called by subclasses when intending to delegate to the next handler in the NavigationHandler chain.protected final void
DecoratingNavigationHandler.callNextHandlerInChain
(FacesContext facesContext, String fromAction, String outcome, NavigationHandler originalNavigationHandler) Method to be called by subclasses when intending to delegate to the next handler in the NavigationHandler chain.protected final void
DecoratingNavigationHandler.callNextHandlerInChain
(FacesContext facesContext, String fromAction, String outcome, NavigationHandler originalNavigationHandler) Method to be called by subclasses when intending to delegate to the next handler in the NavigationHandler chain.abstract void
DecoratingNavigationHandler.handleNavigation
(FacesContext facesContext, String fromAction, String outcome, NavigationHandler originalNavigationHandler) SpecialhandleNavigation
variant with explicit NavigationHandler argument.abstract void
DecoratingNavigationHandler.handleNavigation
(FacesContext facesContext, String fromAction, String outcome, NavigationHandler originalNavigationHandler) SpecialhandleNavigation
variant with explicit NavigationHandler argument.abstract void
DecoratingNavigationHandler.handleNavigation
(FacesContext facesContext, String fromAction, String outcome, NavigationHandler originalNavigationHandler) SpecialhandleNavigation
variant with explicit NavigationHandler argument. -
Uses of Nullable in org.springframework.web.jsf.el
Modifier and TypeMethodDescriptionSpringBeanFacesELResolver.getFeatureDescriptors
(ELContext elContext, Object base) WebApplicationContextFacesELResolver.getFeatureDescriptors
(ELContext elContext, Object base) Class<?>
Class<?>
protected WebApplicationContext
WebApplicationContextFacesELResolver.getWebApplicationContext
(ELContext elContext) Retrieve theWebApplicationContext
reference to expose.Modifier and TypeMethodDescriptionClass<?>
SpringBeanFacesELResolver.getCommonPropertyType
(ELContext elContext, Object base) SpringBeanFacesELResolver.getFeatureDescriptors
(ELContext elContext, Object base) Class<?>
Class<?>
boolean
SpringBeanFacesELResolver.isReadOnly
(ELContext elContext, Object base, Object property) void
-
Uses of Nullable in org.springframework.web.method
Modifier and TypeMethodDescriptionClass<?>
ControllerAdviceBean.getBeanType()
Return the type of the contained bean.HandlerMethod.getResolvedFromHandlerMethod()
Return the HandlerMethod from which this HandlerMethod instance was resolved viaHandlerMethod.createWithResolvedBean()
.protected HttpStatusCode
HandlerMethod.getResponseStatus()
Return the specified response status, if any.protected String
HandlerMethod.getResponseStatusReason()
Return the associated response status reason, if any.Modifier and TypeMethodDescriptionboolean
boolean
boolean
ControllerAdviceBean.isApplicableToBeanType
(Class<?> beanType) Check whether the given bean type should be advised by thisControllerAdviceBean
.boolean
ModifierConstructorDescriptionControllerAdviceBean
(String beanName, BeanFactory beanFactory, ControllerAdvice controllerAdvice) Create aControllerAdviceBean
using the given bean name,BeanFactory
, and@ControllerAdvice
annotation.protected
HandlerMethod
(Object bean, Method method, MessageSource messageSource) Variant ofHandlerMethod(Object, Method)
that also accepts aMessageSource
for use from subclasses.HandlerMethod
(String beanName, BeanFactory beanFactory, MessageSource messageSource, Method method) Variant ofHandlerMethod(String, BeanFactory, Method)
that also accepts aMessageSource
. -
Uses of Nullable in org.springframework.web.method.annotation
Modifier and TypeMethodDescriptionprotected Object
ModelAttributeMethodProcessor.createAttribute
(String attributeName, MethodParameter parameter, WebDataBinderFactory binderFactory, NativeWebRequest request) Extension point to create the model attribute if not found in the model, with subsequent parameter binding through bean properties (unless suppressed).protected String
RequestParamMethodArgumentResolver.formatUriValue
(ConversionService cs, TypeDescriptor sourceType, Object value) static MethodValidator
HandlerMethodValidator.from
(WebBindingInitializer initializer, ParameterNameDiscoverer paramNameDiscoverer, Predicate<MethodParameter> modelAttribitePredicate, Predicate<MethodParameter> requestParamPredicate) Static factory method to create aHandlerMethodValidator
when Bean Validation is enabled for use viaConfigurableWebBindingInitializer
, for example in Spring MVC or WebFlux config.final Object
AbstractNamedValueMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) AbstractWebArgumentResolverAdapter.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Delegate to theWebArgumentResolver
instance.ErrorsMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) MapMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) final Object
ModelAttributeMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Resolve the argument from the model or if not found instantiate it with its default if it is available.ModelMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) ExceptionHandlerMethodResolver.resolveMethod
(Exception exception) Find aMethod
to handle the given exception.ExceptionHandlerMethodResolver.resolveMethodByExceptionType
(Class<? extends Throwable> exceptionType) Find aMethod
to handle the given exception type.ExceptionHandlerMethodResolver.resolveMethodByThrowable
(Throwable exception) Find aMethod
to handle the given Throwable.protected abstract Object
AbstractNamedValueMethodArgumentResolver.resolveName
(String name, MethodParameter parameter, NativeWebRequest request) Resolve the given parameter type and value name into an argument value.protected Object
ExpressionValueMethodArgumentResolver.resolveName
(String name, MethodParameter parameter, NativeWebRequest webRequest) protected Object
RequestHeaderMethodArgumentResolver.resolveName
(String name, MethodParameter parameter, NativeWebRequest request) protected Object
RequestParamMethodArgumentResolver.resolveName
(String name, MethodParameter parameter, NativeWebRequest request) Modifier and TypeMethodDescriptionvoid
HandlerMethodValidator.applyArgumentValidation
(Object target, Method method, MethodParameter[] parameters, Object[] arguments, Class<?>[] groups) void
HandlerMethodValidator.applyReturnValueValidation
(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups) void
HandlerMethodValidator.applyReturnValueValidation
(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups) void
RequestParamMethodArgumentResolver.contributeMethodArgument
(MethodParameter parameter, Object value, UriComponentsBuilder builder, Map<String, Object> uriVariables, ConversionService conversionService) protected String
RequestParamMethodArgumentResolver.formatUriValue
(ConversionService cs, TypeDescriptor sourceType, Object value) protected String
RequestParamMethodArgumentResolver.formatUriValue
(ConversionService cs, TypeDescriptor sourceType, Object value) protected String
RequestParamMethodArgumentResolver.formatUriValue
(ConversionService cs, TypeDescriptor sourceType, Object value) static MethodValidator
HandlerMethodValidator.from
(WebBindingInitializer initializer, ParameterNameDiscoverer paramNameDiscoverer, Predicate<MethodParameter> modelAttribitePredicate, Predicate<MethodParameter> requestParamPredicate) Static factory method to create aHandlerMethodValidator
when Bean Validation is enabled for use viaConfigurableWebBindingInitializer
, for example in Spring MVC or WebFlux config.static MethodValidator
HandlerMethodValidator.from
(WebBindingInitializer initializer, ParameterNameDiscoverer paramNameDiscoverer, Predicate<MethodParameter> modelAttribitePredicate, Predicate<MethodParameter> requestParamPredicate) Static factory method to create aHandlerMethodValidator
when Bean Validation is enabled for use viaConfigurableWebBindingInitializer
, for example in Spring MVC or WebFlux config.static String
ModelFactory.getNameForReturnValue
(Object returnValue, MethodParameter returnType) Derive the model attribute name for the given return value.protected void
AbstractNamedValueMethodArgumentResolver.handleResolvedValue
(Object arg, String name, MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) Invoked after a value is resolved.protected void
AbstractNamedValueMethodArgumentResolver.handleResolvedValue
(Object arg, String name, MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) Invoked after a value is resolved.void
MapMethodProcessor.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
ModelAttributeMethodProcessor.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) Add non-null return values to theModelAndViewContainer
.void
ModelMethodProcessor.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
HandlerMethodValidationException.Visitor.modelAttribute
(ModelAttribute modelAttribute, ParameterErrors errors) Handle results for@ModelAttribute
method parameters.void
HandlerMethodValidationException.Visitor.requestParam
(RequestParam requestParam, ParameterValidationResult result) Handle results for@RequestParam
method parameters.final Object
AbstractNamedValueMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) final Object
AbstractNamedValueMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) AbstractWebArgumentResolverAdapter.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Delegate to theWebArgumentResolver
instance.AbstractWebArgumentResolverAdapter.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Delegate to theWebArgumentResolver
instance.ErrorsMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) ErrorsMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) MapMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) MapMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) final Object
ModelAttributeMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Resolve the argument from the model or if not found instantiate it with its default if it is available.final Object
ModelAttributeMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Resolve the argument from the model or if not found instantiate it with its default if it is available.ModelMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) ModelMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) RequestHeaderMapMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) RequestHeaderMapMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) RequestParamMapMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) RequestParamMapMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) SessionStatusMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) SessionStatusMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) HandlerMethodValidator.validateArguments
(Object target, Method method, MethodParameter[] parameters, Object[] arguments, Class<?>[] groups) HandlerMethodValidator.validateReturnValue
(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups) HandlerMethodValidator.validateReturnValue
(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups) ModifierConstructorDescriptionCrate a newAbstractCookieValueMethodArgumentResolver
instance.Create a newAbstractNamedValueMethodArgumentResolver
instance.Create a newExpressionValueMethodArgumentResolver
instance.InitBinderDataBinderFactory
(List<InvocableHandlerMethod> binderMethods, WebBindingInitializer initializer) Create a new InitBinderDataBinderFactory instance.InitBinderDataBinderFactory
(List<InvocableHandlerMethod> binderMethods, WebBindingInitializer initializer) Create a new InitBinderDataBinderFactory instance.MethodArgumentConversionNotSupportedException
(Object value, Class<?> requiredType, String name, MethodParameter param, Throwable cause) MethodArgumentConversionNotSupportedException
(Object value, Class<?> requiredType, String name, MethodParameter param, Throwable cause) MethodArgumentTypeMismatchException
(Object value, Class<?> requiredType, String name, MethodParameter param, Throwable cause) MethodArgumentTypeMismatchException
(Object value, Class<?> requiredType, String name, MethodParameter param, Throwable cause) ModelFactory
(List<InvocableHandlerMethod> handlerMethods, WebDataBinderFactory binderFactory, SessionAttributesHandler attributeHandler) Create a new instance with the given@ModelAttribute
methods.NamedValueInfo
(String name, boolean required, String defaultValue) Create a newRequestHeaderMethodArgumentResolver
instance.RequestParamMethodArgumentResolver
(ConfigurableBeanFactory beanFactory, boolean useDefaultResolution) Create a newRequestParamMethodArgumentResolver
instance. -
Uses of Nullable in org.springframework.web.method.support
Modifier and TypeMethodDescriptionprotected Object
Invoke the handler method with the given argument values.HandlerMethodArgumentResolverComposite.getArgumentResolver
(MethodParameter parameter) Find a registeredHandlerMethodArgumentResolver
that supports the given method parameter.ModelAndViewContainer.getStatus()
Return the configured HTTP status, if any.ModelAndViewContainer.getView()
Return the View object, ornull
if we are using a view name to be resolved by the DispatcherServlet via a ViewResolver.ModelAndViewContainer.getViewName()
Return the view name to be resolved by the DispatcherServlet via a ViewResolver, ornull
if a View object is set.InvocableHandlerMethod.invokeForRequest
(NativeWebRequest request, ModelAndViewContainer mavContainer, Object... providedArgs) Invoke the method after resolving its argument values in the context of the given request.HandlerMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Resolves a method parameter into an argument value from a given request.HandlerMethodArgumentResolverComposite.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Iterate over registeredHandlerMethodArgumentResolvers
and invoke the one that supports it.Modifier and TypeMethodDescriptionModelAndViewContainer.addAllAttributes
(Map<String, ?> attributes) Copy all attributes to the underlying model.ModelAndViewContainer.addAttribute
(String name, Object value) Add the supplied attribute to the underlying model.HandlerMethodReturnValueHandlerComposite.addHandlers
(List<? extends HandlerMethodReturnValueHandler> handlers) Add the givenHandlerMethodReturnValueHandlers
.HandlerMethodArgumentResolverComposite.addResolvers
(List<? extends HandlerMethodArgumentResolver> resolvers) Add the givenHandlerMethodArgumentResolvers
.HandlerMethodArgumentResolverComposite.addResolvers
(HandlerMethodArgumentResolver... resolvers) Add the givenHandlerMethodArgumentResolvers
.protected Object[]
InvocableHandlerMethod.getMethodArgumentValues
(NativeWebRequest request, ModelAndViewContainer mavContainer, Object... providedArgs) Get the method argument values for the current request, checking the provided argument values and falling back to the configured argument resolvers.void
HandlerMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) Handle the given return value by adding attributes to the model and setting a view or setting theModelAndViewContainer.setRequestHandled(boolean)
flag totrue
to indicate the response has been handled directly.void
HandlerMethodReturnValueHandlerComposite.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) Iterate over registeredHandlerMethodReturnValueHandlers
and invoke the one that supports it.InvocableHandlerMethod.invokeForRequest
(NativeWebRequest request, ModelAndViewContainer mavContainer, Object... providedArgs) Invoke the method after resolving its argument values in the context of the given request.boolean
AsyncHandlerMethodReturnValueHandler.isAsyncReturnValue
(Object returnValue, MethodParameter returnType) Whether the given return value represents asynchronous computation.ModelAndViewContainer.mergeAttributes
(Map<String, ?> attributes) Copy attributes in the suppliedMap
with existing objects of the same name taking precedence (i.e.ModelAndViewContainer.removeAttributes
(Map<String, ?> attributes) Remove the given attributes from the model.HandlerMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Resolves a method parameter into an argument value from a given request.HandlerMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Resolves a method parameter into an argument value from a given request.HandlerMethodArgumentResolverComposite.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Iterate over registeredHandlerMethodArgumentResolvers
and invoke the one that supports it.HandlerMethodArgumentResolverComposite.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Iterate over registeredHandlerMethodArgumentResolvers
and invoke the one that supports it.void
InvocableHandlerMethod.setMethodValidator
(MethodValidator methodValidator) Set theMethodValidator
to perform method validation with if the controller methodHandlerMethod.shouldValidateArguments()
orHandlerMethod.shouldValidateReturnValue()
.void
ModelAndViewContainer.setStatus
(HttpStatusCode status) Provide an HTTP status that will be passed on to with theModelAndView
used for view rendering purposes.void
Set a View object to be used by the DispatcherServlet.void
ModelAndViewContainer.setViewName
(String viewName) Set a view name to be resolved by the DispatcherServlet via a ViewResolver.ModifierConstructorDescriptionCompositeUriComponentsContributor
(Collection<?> contributors, ConversionService cs) Create an instance from a collection ofUriComponentsContributors
orHandlerMethodArgumentResolvers
.CompositeUriComponentsContributor
(Collection<?> contributors, ConversionService cs) Create an instance from a collection ofUriComponentsContributors
orHandlerMethodArgumentResolvers
.protected
InvocableHandlerMethod
(Object bean, Method method, MessageSource messageSource) Variant ofInvocableHandlerMethod(Object, Method)
that also accepts aMessageSource
, for use in subclasses. -
Uses of Nullable in org.springframework.web.multipart
Modifier and TypeMethodDescriptionMultipartFile.getContentType()
Return the content type of the file.Return the contents plus description of an uploaded file in this request, ornull
if it does not exist.MultipartRequest.getMultipartContentType
(String paramOrFileName) Determine the content type of the specified request part.MultipartHttpServletRequest.getMultipartHeaders
(String paramOrFileName) Return the headers for the specified part of the multipart request.MultipartFile.getOriginalFilename()
Return the original filename in the client's filesystem.ModifierConstructorDescriptionMaxUploadSizeExceededException
(long maxUploadSize, Throwable ex) Constructor for MaxUploadSizeExceededException.MultipartException
(String msg, Throwable cause) Constructor for MultipartException. -
Uses of Nullable in org.springframework.web.multipart.support
Modifier and TypeMethodDescriptionDefaultMultipartHttpServletRequest.getParameter
(String name) static Object
MultipartResolutionDelegate.resolveMultipartArgument
(String name, MethodParameter parameter, HttpServletRequest request) static MultipartRequest
MultipartResolutionDelegate.resolveMultipartRequest
(NativeWebRequest webRequest) -
Uses of Nullable in org.springframework.web.reactive
Modifier and TypeMethodDescriptionHandlerResult.getExceptionHandler()
Return theconfigured
exception handler.final List<HandlerMapping>
DispatcherHandler.getHandlerMappings()
HandlerResult.getReturnValue()
Return the value returned from the handler, if any.Modifier and TypeMethodDescriptionBindingContext.createDataBinder
(ServerWebExchange exchange, Object target, String name) Create a binder with a target object.BindingContext.createDataBinder
(ServerWebExchange exchange, Object target, String name, ResolvableType targetType) Create a binder with a target object and atargetType
.BindingContext.createDataBinder
(ServerWebExchange exchange, Object target, String name, ResolvableType targetType) Create a binder with a target object and atargetType
.ModifierConstructorDescriptionBindingContext
(WebBindingInitializer initializer) Create an instance with the given initializer, which may benull
.BindingContext
(WebBindingInitializer initializer, ReactiveAdapterRegistry registry) Create an instance with the given initializer andReactiveAdapterRegistry
.HandlerResult
(Object handler, Object returnValue, MethodParameter returnType) Create a newHandlerResult
.HandlerResult
(Object handler, Object returnValue, MethodParameter returnType, BindingContext context) Create a newHandlerResult
.HandlerResult
(Object handler, Object returnValue, MethodParameter returnType, BindingContext context) Create a newHandlerResult
. -
Uses of Nullable in org.springframework.web.reactive.config
Modifier and TypeMethodDescriptionfinal ApplicationContext
WebFluxConfigurationSupport.getApplicationContext()
protected Predicate<HandlerMethod>
BlockingExecutionConfigurer.getBlockingControllerMethodPredicate()
protected AsyncTaskExecutor
BlockingExecutionConfigurer.getExecutor()
protected AbstractUrlHandlerMapping
ResourceHandlerRegistry.getHandlerMapping()
Return a handler mapping with the mapped resource handlers; ornull
in case of no registrations.protected MessageCodesResolver
WebFluxConfigurationSupport.getMessageCodesResolver()
Override this method to provide a customMessageCodesResolver
.default MessageCodesResolver
WebFluxConfigurer.getMessageCodesResolver()
Provide a customMessageCodesResolver
to use for data binding in annotated controller method arguments instead of the one created by default inDataBinder
.PathMatchConfigurer.getPathPrefixes()
protected Validator
WebFluxConfigurationSupport.getValidator()
Override this method to provide a customValidator
.default Validator
WebFluxConfigurer.getValidator()
Provide a customValidator
.protected WebSocketService
WebFluxConfigurationSupport.getWebSocketService()
default WebSocketService
WebFluxConfigurer.getWebSocketService()
Provide theWebSocketService
to createWebSocketHandlerAdapter
with.WebFluxConfigurerComposite.getWebSocketService()
protected Boolean
PathMatchConfigurer.isUseCaseSensitiveMatch()
protected Boolean
PathMatchConfigurer.isUseTrailingSlashMatch()
Deprecated.Modifier and TypeMethodDescriptionvoid
WebFluxConfigurationSupport.setApplicationContext
(ApplicationContext applicationContext) void
ResourceHandlerRegistry.setResourceUrlProvider
(ResourceUrlProvider resourceUrlProvider) Configure theResourceUrlProvider
that can be used byResourceTransformer
instances.ModifierConstructorDescriptionResourceChainRegistration
(boolean cacheResources, Cache cache) ViewResolverRegistry
(ApplicationContext applicationContext) -
Uses of Nullable in org.springframework.web.reactive.function
Modifier and TypeMethodDescriptionUnsupportedMediaTypeException.getBodyType()
Return the body type in the context of which this exception was generated.UnsupportedMediaTypeException.getContentType()
Return the request Content-Type header if it was parsed successfully, ornull
otherwise.ModifierConstructorDescriptionUnsupportedMediaTypeException
(MediaType contentType, List<MediaType> supportedTypes) Constructor for when the Content-Type can be parsed but is not supported.UnsupportedMediaTypeException
(MediaType contentType, List<MediaType> supportedTypes, ResolvableType bodyType) Constructor for when trying to encode from or decode to a specific Java type.UnsupportedMediaTypeException
(MediaType contentType, List<MediaType> supportedTypes, ResolvableType bodyType) Constructor for when trying to encode from or decode to a specific Java type. -
Uses of Nullable in org.springframework.web.reactive.function.client
Modifier and TypeMethodDescriptionClientRequestObservationContext.getRequest()
Return the immutable client request.WebClientResponseException.getRequest()
Return the corresponding request.<E> E
WebClientResponseException.getResponseBodyAs
(Class<E> targetType) Decode the error content to the specified type.<E> E
WebClientResponseException.getResponseBodyAs
(ParameterizedTypeReference<E> targetType) ClientRequestObservationContext.getUriTemplate()
Return the URI template used for the current client exchange,null
if none was used.ClientRequest.httpRequest()
Return consumer(s) configured to access to theClientHttpRequest
.Modifier and TypeMethodDescriptionstatic WebClientResponseException
WebClientResponseException.create
(int statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) CreateWebClientResponseException
or an HTTP status specific subclass.static WebClientResponseException
WebClientResponseException.create
(int statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) CreateWebClientResponseException
or an HTTP status specific subclass.static WebClientResponseException
WebClientResponseException.create
(int statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) CreateWebClientResponseException
or an HTTP status specific subclass.static WebClientResponseException
WebClientResponseException.create
(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) CreateWebClientResponseException
or an HTTP status specific subclass.static WebClientResponseException
WebClientResponseException.create
(HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) CreateWebClientResponseException
or an HTTP status specific subclass.boolean
Deprecated.void
ClientRequestObservationContext.setUriTemplate
(String uriTemplate) Set the URI template used for the current client exchange.ModifierConstructorDescriptionUnknownHttpStatusCodeException
(int statusCode, HttpHeaders headers, byte[] responseBody, Charset responseCharset, HttpRequest request) Create a new instance of theUnknownHttpStatusCodeException
with the given parameters.UnknownHttpStatusCodeException
(int statusCode, HttpHeaders headers, byte[] responseBody, Charset responseCharset, HttpRequest request) Create a new instance of theUnknownHttpStatusCodeException
with the given parameters.UnknownHttpStatusCodeException
(HttpStatusCode statusCode, HttpHeaders headers, byte[] responseBody, Charset responseCharset, HttpRequest request) Create a new instance of theUnknownHttpStatusCodeException
with the given parameters.UnknownHttpStatusCodeException
(HttpStatusCode statusCode, HttpHeaders headers, byte[] responseBody, Charset responseCharset, HttpRequest request) Create a new instance of theUnknownHttpStatusCodeException
with the given parameters.WebClientResponseException
(int statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Constructor with response data only, and a default message.WebClientResponseException
(int statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Constructor with response data only, and a default message.WebClientResponseException
(int statusCode, String statusText, HttpHeaders headers, byte[] body, Charset charset) Constructor with response data only, and a default message.WebClientResponseException
(int status, String reasonPhrase, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) Constructor with response data only, and a default message.WebClientResponseException
(int status, String reasonPhrase, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) Constructor with response data only, and a default message.WebClientResponseException
(int status, String reasonPhrase, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) Constructor with response data only, and a default message.WebClientResponseException
(int status, String reasonPhrase, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) Constructor with response data only, and a default message.WebClientResponseException
(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset) Constructor with a prepared message.WebClientResponseException
(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset) Constructor with a prepared message.WebClientResponseException
(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset) Constructor with a prepared message.WebClientResponseException
(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset, HttpRequest request) Constructor with a prepared message.WebClientResponseException
(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset, HttpRequest request) Constructor with a prepared message.WebClientResponseException
(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset, HttpRequest request) Constructor with a prepared message.WebClientResponseException
(String message, int statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset, HttpRequest request) Constructor with a prepared message.WebClientResponseException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset, HttpRequest request) Constructor with a prepared message.WebClientResponseException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset, HttpRequest request) Constructor with a prepared message.WebClientResponseException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset, HttpRequest request) Constructor with a prepared message.WebClientResponseException
(String message, HttpStatusCode statusCode, String statusText, HttpHeaders headers, byte[] responseBody, Charset charset, HttpRequest request) Constructor with a prepared message.WebClientResponseException
(HttpStatusCode statusCode, String reasonPhrase, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) Constructor with response data only, and a default message.WebClientResponseException
(HttpStatusCode statusCode, String reasonPhrase, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) Constructor with response data only, and a default message.WebClientResponseException
(HttpStatusCode statusCode, String reasonPhrase, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) Constructor with response data only, and a default message.WebClientResponseException
(HttpStatusCode statusCode, String reasonPhrase, HttpHeaders headers, byte[] body, Charset charset, HttpRequest request) Constructor with response data only, and a default message. -
Uses of Nullable in org.springframework.web.reactive.function.server
Modifier and TypeMethodDescriptiondefault String
ServerRequest.Headers.firstHeader
(String headerName) Get the first header value, if any, for the header with the given name.ServerRequest.Headers.host()
Get the value of theHost
header, if available.Modifier and TypeMethodDescriptionServerRequest.Builder.contextPath
(String contextPath) Set the context path of the request.RenderingResponse.Builder.modelAttribute
(String name, Object value) Add the supplied attribute value under the supplied name. -
Uses of Nullable in org.springframework.web.reactive.function.server.support
Modifier and TypeMethodDescriptionRouterFunctionMapping.getRouterFunction()
Return the configuredRouterFunction
. -
Uses of Nullable in org.springframework.web.reactive.handler
Modifier and TypeMethodDescriptionprotected CorsConfiguration
AbstractHandlerMapping.getCorsConfiguration
(Object handler, ServerWebExchange exchange) Retrieve the CORS configuration for the given handler.protected Object
AbstractUrlHandlerMapping.lookupHandler
(PathContainer lookupPath, ServerWebExchange exchange) Look up a handler instance for the given URL lookup path. -
Uses of Nullable in org.springframework.web.reactive.resource
Modifier and TypeMethodDescriptionVersionStrategy.extractVersion
(String requestPath) Extract the resource version from the request path.protected String
WebJarsResourceResolver.findWebJarResourcePath
(String path) Resource[]
PathResourceResolver.getAllowedLocations()
ResourceWebHandler.getCacheControl()
Return theCacheControl
instance to build the Cache-Control HTTP response header.TransformedResource.getFilename()
ResourceWebHandler.getResourceHttpMessageWriter()
Return the configured resource message writer.ResourceTransformerSupport.getResourceUrlProvider()
Return the configuredResourceUrlProvider
.protected VersionStrategy
VersionResourceResolver.getStrategyForPath
(String requestPath) Find aVersionStrategy
for the request path of the requested resource.Modifier and TypeMethodDescriptionprotected String
CachingResourceResolver.computeKey
(ServerWebExchange exchange, String requestPath) reactor.core.publisher.Mono<Resource>
AbstractResourceResolver.resolveResource
(ServerWebExchange exchange, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) reactor.core.publisher.Mono<Resource>
ResourceResolver.resolveResource
(ServerWebExchange exchange, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) Resolve the supplied request and request path to aResource
that exists under one of the given resource locations.reactor.core.publisher.Mono<Resource>
ResourceResolverChain.resolveResource
(ServerWebExchange exchange, String requestPath, List<? extends Resource> locations) Resolve the supplied request and request path to aResource
that exists under one of the given resource locations.protected abstract reactor.core.publisher.Mono<Resource>
AbstractResourceResolver.resolveResourceInternal
(ServerWebExchange exchange, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected reactor.core.publisher.Mono<Resource>
CachingResourceResolver.resolveResourceInternal
(ServerWebExchange exchange, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected reactor.core.publisher.Mono<Resource>
EncodedResourceResolver.resolveResourceInternal
(ServerWebExchange exchange, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected reactor.core.publisher.Mono<Resource>
PathResourceResolver.resolveResourceInternal
(ServerWebExchange exchange, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected reactor.core.publisher.Mono<Resource>
VersionResourceResolver.resolveResourceInternal
(ServerWebExchange exchange, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected reactor.core.publisher.Mono<Resource>
WebJarsResourceResolver.resolveResourceInternal
(ServerWebExchange exchange, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) void
PathResourceResolver.setAllowedLocations
(Resource... locations) By default, when a Resource is found, the path of the resolved resource is compared to ensure it's under the input location where it was found.void
ResourceWebHandler.setCacheControl
(CacheControl cacheControl) Set theCacheControl
instance to build the Cache-Control HTTP response header.protected void
ResourceWebHandler.setHeaders
(ServerWebExchange exchange, Resource resource, MediaType mediaType) Set headers on the response.void
ResourceWebHandler.setLocations
(List<Resource> locations) Set theList
ofResource
paths to use as sources for serving static resources.void
ResourceWebHandler.setResourceHttpMessageWriter
(ResourceHttpMessageWriter httpMessageWriter) Configure theResourceHttpMessageWriter
to use.void
ResourceWebHandler.setResourceResolvers
(List<ResourceResolver> resourceResolvers) Configure the list ofResourceResolvers
to use.void
ResourceWebHandler.setResourceTransformers
(List<ResourceTransformer> resourceTransformers) Configure the list ofResourceTransformers
to use.void
ResourceTransformerSupport.setResourceUrlProvider
(ResourceUrlProvider resourceUrlProvider) Configure aResourceUrlProvider
to use when resolving the public URL of links in a transformed resource (e.g. -
Uses of Nullable in org.springframework.web.reactive.result
Modifier and TypeMethodDescriptionprotected ReactiveAdapter
HandlerResultHandlerSupport.getAdapter
(HandlerResult result) Get aReactiveAdapter
for the top-level return value type.protected MediaType
HandlerResultHandlerSupport.selectMediaType
(ServerWebExchange exchange, Supplier<List<MediaType>> producibleTypesSupplier) Select the best media type for the current request through a content negotiation algorithm.protected MediaType
HandlerResultHandlerSupport.selectMediaType
(ServerWebExchange exchange, Supplier<List<MediaType>> producibleTypesSupplier, List<MediaType> acceptableTypes) Variant ofHandlerResultHandlerSupport.selectMediaType(ServerWebExchange, Supplier)
with a given list of requested (acceptable) media types. -
Uses of Nullable in org.springframework.web.reactive.result.condition
Modifier and TypeMethodDescriptionRequestConditionHolder.getCondition()
Return the held request condition, ornull
if not holding one.CompositeRequestCondition.getMatchingCondition
(ServerWebExchange exchange) Delegate to all contained conditions to match the request and return the resulting "matching" condition instances.ConsumesRequestCondition.getMatchingCondition
(ServerWebExchange exchange) Checks if any of the contained media type expressions match the given request 'Content-Type' header and returns an instance that is guaranteed to contain matching expressions only.HeadersRequestCondition.getMatchingCondition
(ServerWebExchange exchange) Returns "this" instance if the request matches all expressions; ornull
otherwise.ParamsRequestCondition.getMatchingCondition
(ServerWebExchange exchange) Returns "this" instance if the request matches all param expressions; ornull
otherwise.PatternsRequestCondition.getMatchingCondition
(ServerWebExchange exchange) Checks if any of the patterns match the given request and returns an instance that is guaranteed to contain matching patterns, sorted.ProducesRequestCondition.getMatchingCondition
(ServerWebExchange exchange) Checks if any of the contained media type expressions match the given request 'Content-Type' header and returns an instance that is guaranteed to contain matching expressions only.RequestCondition.getMatchingCondition
(ServerWebExchange exchange) Check if the condition matches the request returning a potentially new instance created for the current request.RequestConditionHolder.getMatchingCondition
(ServerWebExchange exchange) Get the matching condition for the held request condition wrap it in a new RequestConditionHolder instance.RequestMethodsRequestCondition.getMatchingCondition
(ServerWebExchange exchange) Check if any of the HTTP request methods match the given request and return an instance that contains the matching HTTP request method only.NameValueExpression.getValue()
ModifierConstructorDescriptionRequestConditionHolder
(RequestCondition<?> requestCondition) Create a new holder to wrap the given request condition. -
Uses of Nullable in org.springframework.web.reactive.result.method
Modifier and TypeMethodDescriptionRequestMappingInfo.BuilderConfiguration.getContentTypeResolver()
RequestMappingInfo.getCustomCondition()
Returns the "custom" condition of thisRequestMappingInfo
; ornull
.protected abstract T
AbstractHandlerMethodMapping.getMappingForMethod
(Method method, Class<?> handlerType) Provide the mapping for a handler method.RequestMappingInfo.getMatchingCondition
(ServerWebExchange exchange) Checks if all conditions in this request mapping info match the provided request and returns a potentially new request mapping info with conditions tailored to the current request.protected abstract T
AbstractHandlerMethodMapping.getMatchingMapping
(T mapping, ServerWebExchange exchange) Check if a mapping matches the current request and return a (potentially new) mapping with conditions relevant to the current request.RequestMappingInfo.getName()
Return the name for this mapping, ornull
.RequestMappingInfo.BuilderConfiguration.getPatternParser()
protected HandlerMethod
AbstractHandlerMethodMapping.handleNoMatch
(Set<T> mappings, ServerWebExchange exchange) Invoked when no matching mapping is not found.protected CorsConfiguration
AbstractHandlerMethodMapping.initCorsConfiguration
(Object handler, Method method, T mapping) Extract and return the CORS configuration for the mapping.SyncInvocableHandlerMethod.invokeForHandlerResult
(ServerWebExchange exchange, BindingContext bindingContext, Object... providedArgs) Invoke the method for the given exchange.protected HandlerMethod
AbstractHandlerMethodMapping.lookupHandlerMethod
(ServerWebExchange exchange) Look up the best-matching handler method for the current request.SyncHandlerMethodArgumentResolver.resolveArgumentValue
(MethodParameter parameter, BindingContext bindingContext, ServerWebExchange exchange) Resolve the value for the method parameter synchronously.Modifier and TypeMethodDescriptionboolean
void
InvocableHandlerMethod.setMethodValidator
(MethodValidator methodValidator) Set theMethodValidator
to perform method validation with if the controller methodHandlerMethod.shouldValidateArguments()
orHandlerMethod.shouldValidateReturnValue()
.ModifierConstructorDescriptionRequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3.4 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(RequestMappingInfo info, RequestCondition<?> customRequestCondition) Deprecated.since 5.3.4 in favor of using aRequestMappingInfo.Builder
viaRequestMappingInfo.mutate()
. -
Uses of Nullable in org.springframework.web.reactive.result.method.annotation
Modifier and TypeMethodDescriptionRequestMappingHandlerAdapter.getArgumentResolverConfigurer()
Return the configured resolvers for controller method arguments.protected RequestCondition<?>
RequestMappingHandlerMapping.getCustomMethodCondition
(Method method) Protected method to provide a custom method-level request condition.protected RequestCondition<?>
RequestMappingHandlerMapping.getCustomTypeCondition
(Class<?> handlerType) Protected method to provide a custom type-level request condition.protected RequestMappingInfo
RequestMappingHandlerMapping.getMappingForMethod
(Method method, Class<?> handlerType) Uses method and type-level @RequestMapping
annotations to create the RequestMappingInfo.protected MessageSource
ResponseEntityExceptionHandler.getMessageSource()
Get theMessageSource
that this exception handler uses.RequestMappingHandlerAdapter.getReactiveAdapterRegistry()
Return the configured registry for adapting reactive types.RequestMappingHandlerAdapter.getWebBindingInitializer()
Return the configured WebBindingInitializer, ornull
if none.MatrixVariableMapMethodArgumentResolver.resolveArgumentValue
(MethodParameter parameter, BindingContext bindingContext, ServerWebExchange exchange) SessionStatusMethodArgumentResolver.resolveArgumentValue
(MethodParameter parameter, BindingContext bindingContext, ServerWebExchange exchange) protected abstract Object
AbstractNamedValueSyncArgumentResolver.resolveNamedValue
(String name, MethodParameter param, ServerWebExchange exchange) Actually resolve the value synchronously.protected Object
MatrixVariableMethodArgumentResolver.resolveNamedValue
(String name, MethodParameter param, ServerWebExchange exchange) Modifier and TypeMethodDescriptionprotected ProblemDetail
ResponseEntityExceptionHandler.createProblemDetail
(Exception ex, HttpStatusCode status, String defaultDetail, String detailMessageCode, Object[] detailMessageArguments, ServerWebExchange exchange) Convenience method to create aProblemDetail
for any exception that doesn't implementErrorResponse
, also performing aMessageSource
lookup for the "detail" field.protected ProblemDetail
ResponseEntityExceptionHandler.createProblemDetail
(Exception ex, HttpStatusCode status, String defaultDetail, String detailMessageCode, Object[] detailMessageArguments, ServerWebExchange exchange) Convenience method to create aProblemDetail
for any exception that doesn't implementErrorResponse
, also performing aMessageSource
lookup for the "detail" field.protected RequestMappingInfo
RequestMappingHandlerMapping.createRequestMappingInfo
(RequestMapping requestMapping, RequestCondition<?> customCondition) Create aRequestMappingInfo
from the supplied@RequestMapping
annotation, or meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.protected RequestMappingInfo
RequestMappingHandlerMapping.createRequestMappingInfo
(HttpExchange httpExchange, RequestCondition<?> customCondition) Create aRequestMappingInfo
from the supplied@HttpExchange
annotation, or meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.protected reactor.core.publisher.Mono<ResponseEntity<Object>>
ResponseEntityExceptionHandler.createResponseEntity
(Object body, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange) Create theResponseEntity
to use from the given body, headers, and statusCode.protected reactor.core.publisher.Mono<ResponseEntity<Object>>
ResponseEntityExceptionHandler.createResponseEntity
(Object body, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange) Create theResponseEntity
to use from the given body, headers, and statusCode.reactor.core.publisher.Flux<Part>
RequestPartMethodArgumentResolver.getPartValues
(MethodParameter parameter, RequestPart requestPart, boolean isRequired, ServerWebExchange exchange) protected reactor.core.publisher.Mono<ResponseEntity<Object>>
ResponseEntityExceptionHandler.handleExceptionInternal
(Exception ex, Object body, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange) Internal handler method that all others in this class delegate to, for common handling, and for the creation of aResponseEntity
.protected reactor.core.publisher.Mono<ResponseEntity<Object>>
ResponseEntityExceptionHandler.handleExceptionInternal
(Exception ex, Object body, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange) Internal handler method that all others in this class delegate to, for common handling, and for the creation of aResponseEntity
.protected void
AbstractNamedValueArgumentResolver.handleResolvedValue
(Object arg, String name, MethodParameter parameter, Model model, ServerWebExchange exchange) Invoked after a value is resolved.protected void
PathVariableMethodArgumentResolver.handleResolvedValue
(Object arg, String name, MethodParameter parameter, Model model, ServerWebExchange exchange) protected reactor.core.publisher.Mono<Object>
AbstractMessageReaderArgumentResolver.readBody
(MethodParameter bodyParam, MethodParameter actualParam, boolean isBodyRequired, BindingContext bindingContext, ServerWebExchange exchange) Read the body from a method argument withHttpMessageReader
.void
RequestMappingHandlerAdapter.setArgumentResolverConfigurer
(ArgumentResolverConfigurer configurer) Configure resolvers for controller method arguments.void
RequestMappingHandlerAdapter.setBlockingExecutor
(Executor executor) Configure an executor to invoke blocking controller methods with.void
RequestMappingHandlerAdapter.setReactiveAdapterRegistry
(ReactiveAdapterRegistry registry) Configure the registry for adapting various reactive types.void
RequestMappingHandlerAdapter.setWebBindingInitializer
(WebBindingInitializer webBindingInitializer) Provide a WebBindingInitializer with "global" initialization to apply to every DataBinder instance.protected reactor.core.publisher.Mono<Void>
AbstractMessageWriterResultHandler.writeBody
(Object body, MethodParameter bodyParameter, MethodParameter actualParam, ServerWebExchange exchange) Write a given body to the response withHttpMessageWriter
.protected reactor.core.publisher.Mono<Void>
AbstractMessageWriterResultHandler.writeBody
(Object body, MethodParameter bodyParameter, MethodParameter actualParam, ServerWebExchange exchange) Write a given body to the response withHttpMessageWriter
.protected reactor.core.publisher.Mono<Void>
AbstractMessageWriterResultHandler.writeBody
(Object body, MethodParameter bodyParameter, ServerWebExchange exchange) Write a given body to the response withHttpMessageWriter
.ModifierConstructorDescriptionAbstractNamedValueArgumentResolver
(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry) Create a newAbstractNamedValueArgumentResolver
instance.protected
AbstractNamedValueSyncArgumentResolver
(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry) Create a newAbstractNamedValueSyncArgumentResolver
.CookieValueMethodArgumentResolver
(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry) Create a newCookieValueMethodArgumentResolver
instance.ExpressionValueMethodArgumentResolver
(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry) Create a newExpressionValueMethodArgumentResolver
instance.MatrixVariableMethodArgumentResolver
(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry) NamedValueInfo
(String name, boolean required, String defaultValue) PathVariableMethodArgumentResolver
(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry) Create a newPathVariableMethodArgumentResolver
.RequestAttributeMethodArgumentResolver
(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry) Create a newRequestAttributeMethodArgumentResolver
instance.RequestHeaderMethodArgumentResolver
(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry) Create a newRequestHeaderMethodArgumentResolver
instance.RequestParamMethodArgumentResolver
(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry, boolean useDefaultResolution) Class constructor with a default resolution mode flag. -
Uses of Nullable in org.springframework.web.reactive.result.view
Modifier and TypeMethodDescriptionBindStatus.findEditor
(Class<?> valueClass) Find a PropertyEditor for the given value class, associated with the property that this bound status is currently bound to.BindStatus.getActualValue()
Return the actual value of the field, i.e.AbstractView.getApplicationContext()
UrlBasedViewResolver.getApplicationContext()
Return the containingApplicationContext
, if any.AbstractView.getBeanName()
Get the view's name.RequestContext.getDefaultHtmlEscape()
Return the default HTML escape setting, differentiating between no default specified and an explicit value.BindStatus.getEditor()
Return the PropertyEditor for the property that this bind status is currently bound to.BindStatus.getErrors()
Return the Errors instance (typically a BindingResult) that this bind status is currently associated with.Retrieve the Errors instance for the given bind object, using the "defaultHtmlEscape" setting.Retrieve the Errors instance for the given bind object.BindStatus.getExpression()
Return a bind expression that can be used in HTML forms as input name for the respective field, ornull
if not field-specific.RequestDataValueProcessor.getExtraHiddenFields
(ServerWebExchange exchange) Invoked after all form fields have been rendered.String[]
RedirectView.getHosts()
Return the configured application hosts.RequestContext.getModel()
Return the model Map that this RequestContext encapsulates, if any.protected <T> T
RequestContext.getModelObject
(String modelName) Retrieve the model object for the given model name, either from the model or from the request attributes.AbstractView.getRequestContextAttribute()
Get the name of theRequestContext
attribute for this view, if any.protected String
UrlBasedViewResolver.getRequestContextAttribute()
Return the name of theRequestContext
attribute for all views, if any.protected RequestDataValueProcessor
AbstractView.getRequestDataValueProcessor()
Get theRequestDataValueProcessor
to use.RequestContext.getRequestDataValueProcessor()
Return theRequestDataValueProcessor
instance to apply to in form tag libraries and to redirect URLs.AbstractUrlBasedView.getUrl()
Return the URL of the resource that this view wraps.BindStatus.getValue()
Return the current value of the field, i.e.Class<?>
BindStatus.getValueType()
Get the 'Class
' type of the field.protected Class<?>
UrlBasedViewResolver.getViewClass()
Return the view class to be used to create views.protected String[]
UrlBasedViewResolver.getViewNames()
Return the view names (or name patterns) that can be handled by thisViewResolver
.Rendering.status()
Return the HTTP status to set the response to.Rendering.view()
Modifier and TypeMethodDescriptionRequestContext.getMessage
(String code, Object[] args) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.RequestContext.getMessage
(String code, Object[] args, boolean htmlEscape) Retrieve the message for the given code.RequestContext.getMessage
(String code, Object[] args, String defaultMessage) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.RequestContext.getMessage
(String code, Object[] args, String defaultMessage, boolean htmlEscape) Retrieve the message for the given code.RequestContext.getMessage
(String code, List<?> args) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.RequestContext.getMessage
(String code, List<?> args, String defaultMessage) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.AbstractView.getModelAttributes
(Map<String, ?> model, ServerWebExchange exchange) Prepare the model to use for rendering.reactor.core.publisher.Mono<Void>
AbstractView.render
(Map<String, ?> model, MediaType contentType, ServerWebExchange exchange) Prepare the model to render.reactor.core.publisher.Mono<Void>
AbstractView.render
(Map<String, ?> model, MediaType contentType, ServerWebExchange exchange) Prepare the model to render.reactor.core.publisher.Mono<Void>
HttpMessageWriterView.render
(Map<String, ?> model, MediaType contentType, ServerWebExchange exchange) reactor.core.publisher.Mono<Void>
HttpMessageWriterView.render
(Map<String, ?> model, MediaType contentType, ServerWebExchange exchange) reactor.core.publisher.Mono<Void>
View.render
(Map<String, ?> model, MediaType contentType, ServerWebExchange exchange) Render the view based on the givenHandlerResult
.reactor.core.publisher.Mono<Void>
View.render
(Map<String, ?> model, MediaType contentType, ServerWebExchange exchange) Render the view based on the givenHandlerResult
.protected abstract reactor.core.publisher.Mono<Void>
AbstractView.renderInternal
(Map<String, Object> renderAttributes, MediaType contentType, ServerWebExchange exchange) Subclasses must implement this method to actually render the view.protected reactor.core.publisher.Mono<Void>
RedirectView.renderInternal
(Map<String, Object> model, MediaType contentType, ServerWebExchange exchange) Convert model to request parameters and redirect to the given URL.void
AbstractView.setApplicationContext
(ApplicationContext applicationContext) void
UrlBasedViewResolver.setApplicationContext
(ApplicationContext applicationContext) Accept the containingApplicationContext
, if any.void
AbstractView.setBeanName
(String beanName) Set the view's name.void
ViewResolutionResultHandler.setDefaultViews
(List<View> defaultViews) Set the default views to consider always when resolving view names and trying to satisfy the best matching content type.void
Configure one or more hosts associated with the application.void
HttpMessageWriterView.setModelKeys
(Set<String> modelKeys) Set the attributes in the model that should be rendered by this view.void
Set the prefix that gets prepended to view names when building a URL.void
AbstractView.setRequestContextAttribute
(String requestContextAttribute) Set the name of theRequestContext
attribute for this view.void
UrlBasedViewResolver.setRequestContextAttribute
(String requestContextAttribute) Set the name of theRequestContext
attribute for all views.void
Set the suffix that gets appended to view names when building a URL.void
Set the URL of the resource that this view wraps.void
UrlBasedViewResolver.setViewClass
(Class<?> viewClass) Set the view class that should be used to create views.void
UrlBasedViewResolver.setViewNames
(String... viewNames) Set the view names (or name patterns) that can be handled by thisViewResolver
.ModifierConstructorDescriptionRequestContext
(ServerWebExchange exchange, Map<String, Object> model, MessageSource messageSource, RequestDataValueProcessor dataValueProcessor) -
Uses of Nullable in org.springframework.web.reactive.result.view.freemarker
Modifier and TypeMethodDescriptionprotected freemarker.template.Configuration
FreeMarkerView.getConfiguration()
Get the FreeMarkerConfiguration
used by this view.protected String
FreeMarkerView.getEncoding()
Get the encoding for the FreeMarker template.Modifier and TypeMethodDescriptionFreeMarkerView.getModelAttributes
(Map<String, ?> model, ServerWebExchange exchange) Prepare the model to use for rendering by potentially exposing aRequestContext
for use in Spring FreeMarker macros and then delegating to the inherited implementation of this method.protected reactor.core.publisher.Mono<Void>
FreeMarkerView.renderInternal
(Map<String, Object> renderAttributes, MediaType contentType, ServerWebExchange exchange) void
FreeMarkerView.setConfiguration
(freemarker.template.Configuration configuration) Set the FreeMarkerConfiguration
to be used by this view.void
FreeMarkerView.setEncoding
(String encoding) Set the encoding of the FreeMarker template file. -
Uses of Nullable in org.springframework.web.reactive.result.view.script
Modifier and TypeMethodDescriptionScriptTemplateConfig.getCharset()
Return the charset used to read script and template files.ScriptTemplateConfigurer.getCharset()
ScriptTemplateConfig.getEngine()
Return theScriptEngine
to use by the views.ScriptTemplateConfigurer.getEngine()
ScriptTemplateConfig.getEngineName()
Return the engine name that will be used to instantiate theScriptEngine
.ScriptTemplateConfigurer.getEngineName()
ScriptTemplateConfig.getEngineSupplier()
Return the engine supplier that will be used to instantiate theScriptEngine
.ScriptTemplateConfigurer.getEngineSupplier()
ScriptTemplateConfig.getRenderFunction()
Return the render function name (optional).ScriptTemplateConfigurer.getRenderFunction()
ScriptTemplateConfig.getRenderObject()
Return the object where the render function belongs (optional).ScriptTemplateConfigurer.getRenderObject()
protected Resource
ScriptTemplateView.getResource
(String location) ScriptTemplateConfig.getResourceLoaderPath()
Return the resource loader path(s) via a Spring resource location.ScriptTemplateConfigurer.getResourceLoaderPath()
String[]
ScriptTemplateConfig.getScripts()
Return the scripts to be loaded by the script engine (library or user provided).String[]
ScriptTemplateConfigurer.getScripts()
ScriptTemplateConfig.isSharedEngine()
Return whether to use a shared engine for all threads or whether to create thread-local engine instances for each thread.ScriptTemplateConfigurer.isSharedEngine()
Modifier and TypeMethodDescriptionprotected reactor.core.publisher.Mono<Void>
ScriptTemplateView.renderInternal
(Map<String, Object> model, MediaType contentType, ServerWebExchange exchange) void
ScriptTemplateView.setApplicationContext
(ApplicationContext context) void
ScriptTemplateConfigurer.setCharset
(Charset charset) Set the charset used to read script and template files.void
ScriptTemplateConfigurer.setEngine
(ScriptEngine engine) Set theScriptEngine
to use by the view.void
ScriptTemplateConfigurer.setEngineName
(String engineName) Set the engine name that will be used to instantiate theScriptEngine
.void
ScriptTemplateConfigurer.setEngineSupplier
(Supplier<ScriptEngine> engineSupplier) Set theScriptEngine
supplier to use by the view, usually used withScriptTemplateConfigurer.setSharedEngine(Boolean)
set tofalse
.void
ScriptTemplateConfigurer.setRenderFunction
(String renderFunction) Set the render function name (optional).void
ScriptTemplateConfigurer.setRenderObject
(String renderObject) Set the object where the render function belongs (optional).void
ScriptTemplateConfigurer.setResourceLoaderPath
(String resourceLoaderPath) Set the resource loader path(s) via a Spring resource location.void
ScriptTemplateConfigurer.setScripts
(String... scriptNames) Set the scripts to be loaded by the script engine (library or user provided).void
ScriptTemplateConfigurer.setSharedEngine
(Boolean sharedEngine) When set tofalse
, a newScriptEngine
instance will be created for each request, else the same instance will be reused. -
Uses of Nullable in org.springframework.web.reactive.socket
Modifier and TypeMethodDescriptionHandshakeInfo.getLogPrefix()
A log prefix used in the handshake to correlate log messages, if any.<T> T
WebSocketMessage.getNativeMessage()
Return the message from the API of the underlying WebSocket library.CloseStatus.getReason()
Return the reason, ornull
if none.HandshakeInfo.getRemoteAddress()
For a server session this is the remote address where the handshake request came from.HandshakeInfo.getSubProtocol()
The sub-protocol negotiated at handshake time, ornull
if none.Modifier and TypeMethodDescriptionstatic CloseStatus
Return a constant for the given code, or create a new instance if the code does not match or there is a reason.boolean
boolean
ModifierConstructorDescriptionCloseStatus
(int code, String reason) Create a newCloseStatus
instance.HandshakeInfo
(URI uri, HttpHeaders headers, MultiValueMap<String, HttpCookie> cookies, reactor.core.publisher.Mono<Principal> principal, String protocol, InetSocketAddress remoteAddress, Map<String, Object> attributes, String logPrefix) Constructor targeting server-side use with extra information such as the cookies, remote address, attributes, and a log prefix.HandshakeInfo
(URI uri, HttpHeaders headers, MultiValueMap<String, HttpCookie> cookies, reactor.core.publisher.Mono<Principal> principal, String protocol, InetSocketAddress remoteAddress, Map<String, Object> attributes, String logPrefix) Constructor targeting server-side use with extra information such as the cookies, remote address, attributes, and a log prefix.HandshakeInfo
(URI uri, HttpHeaders headers, MultiValueMap<String, HttpCookie> cookies, reactor.core.publisher.Mono<Principal> principal, String protocol, InetSocketAddress remoteAddress, Map<String, Object> attributes, String logPrefix) Constructor targeting server-side use with extra information such as the cookies, remote address, attributes, and a log prefix.HandshakeInfo
(URI uri, HttpHeaders headers, reactor.core.publisher.Mono<Principal> principal, String protocol) Constructor with basic information about the handshake.HandshakeInfo
(URI uri, HttpHeaders headers, reactor.core.publisher.Mono<Principal> principal, String protocol, InetSocketAddress remoteAddress, Map<String, Object> attributes, String logPrefix) Deprecated.as of 5.3.5 in favor ofHandshakeInfo(URI, HttpHeaders, MultiValueMap, Mono, String, InetSocketAddress, Map, String)
HandshakeInfo
(URI uri, HttpHeaders headers, reactor.core.publisher.Mono<Principal> principal, String protocol, InetSocketAddress remoteAddress, Map<String, Object> attributes, String logPrefix) Deprecated.as of 5.3.5 in favor ofHandshakeInfo(URI, HttpHeaders, MultiValueMap, Mono, String, InetSocketAddress, Map, String)
HandshakeInfo
(URI uri, HttpHeaders headers, reactor.core.publisher.Mono<Principal> principal, String protocol, InetSocketAddress remoteAddress, Map<String, Object> attributes, String logPrefix) Deprecated.as of 5.3.5 in favor ofHandshakeInfo(URI, HttpHeaders, MultiValueMap, Mono, String, InetSocketAddress, Map, String)
WebSocketMessage
(WebSocketMessage.Type type, DataBuffer payload, Object nativeMessage) Constructor for an inbound message with access to the underlying message. -
Uses of Nullable in org.springframework.web.reactive.socket.adapter
ModifierConstructorDescriptionAbstractListenerWebSocketSession
(T delegate, String id, HandshakeInfo info, DataBufferFactory bufferFactory, reactor.core.publisher.Sinks.Empty<Void> handlerCompletionSink) Alternative constructor with completion sink to use to signal when the handling of the session is complete, with success or error.JettyWebSocketSession
(org.eclipse.jetty.websocket.api.Session session, HandshakeInfo info, DataBufferFactory factory, reactor.core.publisher.Sinks.Empty<Void> completionSink) StandardWebSocketSession
(Session session, HandshakeInfo info, DataBufferFactory factory, reactor.core.publisher.Sinks.Empty<Void> completionSink) UndertowWebSocketSession
(io.undertow.websockets.core.WebSocketChannel channel, HandshakeInfo info, DataBufferFactory factory, reactor.core.publisher.Sinks.Empty<Void> completionSink) -
Uses of Nullable in org.springframework.web.reactive.socket.server
Modifier and TypeMethodDescriptionreactor.core.publisher.Mono<Void>
RequestUpgradeStrategy.upgrade
(ServerWebExchange exchange, WebSocketHandler webSocketHandler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory) Upgrade to a WebSocket session and handle it with the given handler. -
Uses of Nullable in org.springframework.web.reactive.socket.server.support
Modifier and TypeMethodDescriptionHandshakeWebSocketService.getSessionAttributePredicate()
Return the configured predicate for initialization WebSocket session attributes fromWebSession
attributes.Modifier and TypeMethodDescriptionvoid
HandshakeWebSocketService.setSessionAttributePredicate
(Predicate<String> predicate) Configure a predicate to use to extractWebSession
attributes and use them to initialize the WebSocket session with. -
Uses of Nullable in org.springframework.web.reactive.socket.server.upgrade
Modifier and TypeMethodDescriptionStandardWebSocketUpgradeStrategy.getAsyncSendTimeout()
StandardWebSocketUpgradeStrategy.getMaxBinaryMessageBufferSize()
StandardWebSocketUpgradeStrategy.getMaxSessionIdleTimeout()
StandardWebSocketUpgradeStrategy.getMaxTextMessageBufferSize()
Modifier and TypeMethodDescriptionreactor.core.publisher.Mono<Void>
JettyRequestUpgradeStrategy.upgrade
(ServerWebExchange exchange, WebSocketHandler handler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory) reactor.core.publisher.Mono<Void>
ReactorNetty2RequestUpgradeStrategy.upgrade
(ServerWebExchange exchange, WebSocketHandler handler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory) reactor.core.publisher.Mono<Void>
ReactorNettyRequestUpgradeStrategy.upgrade
(ServerWebExchange exchange, WebSocketHandler handler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory) reactor.core.publisher.Mono<Void>
StandardWebSocketUpgradeStrategy.upgrade
(ServerWebExchange exchange, WebSocketHandler handler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory) reactor.core.publisher.Mono<Void>
UndertowRequestUpgradeStrategy.upgrade
(ServerWebExchange exchange, WebSocketHandler handler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory) -
Uses of Nullable in org.springframework.web.server
Modifier and TypeMethodDescriptionServerWebExchange.getApplicationContext()
Return theApplicationContext
associated with the web application, if it was initialized with one viaWebHttpHandlerBuilder.applicationContext(ApplicationContext)
.default <T> T
ServerWebExchange.getAttribute
(String name) Return the request attribute value if present.default <T> T
WebSession.getAttribute
(String name) Return the session attribute value if present.UnsupportedMediaTypeStatusException.getBodyType()
Return the body type in the context of which this exception was generated.UnsupportedMediaTypeStatusException.getContentType()
Return the request Content-Type header if it was parsed successfully, ornull
otherwise.ServerErrorException.getHandlerMethod()
Return the handler method associated with the error, if any.ServerErrorException.getMethodParameter()
Return the specific method parameter associated with the error, if any.ServerWebInputException.getMethodParameter()
Return theMethodParameter
associated with this error, if any.ResponseStatusException.getReason()
The reason explaining the exception (potentiallynull
or empty).Modifier and TypeMethodDescriptionboolean
ServerWebExchange.checkNotModified
(String etag, Instant lastModified) Check whether the requested resource has been modified given the suppliedETag
(entity tag) and last-modified timestamp as determined by the application.boolean
ServerWebExchangeDecorator.checkNotModified
(String etag, Instant lastModified) ModifierConstructorDescriptionMethodNotAllowedException
(String method, Collection<HttpMethod> supportedMethods) ResponseStatusException
(int rawStatusCode, String reason, Throwable cause) Constructor with a response status and a reason to add to the exception message as explanation, as well as a nested exception.ResponseStatusException
(int rawStatusCode, String reason, Throwable cause) Constructor with a response status and a reason to add to the exception message as explanation, as well as a nested exception.ResponseStatusException
(HttpStatusCode status, String reason) Constructor with a response status and a reason to add to the exception message as explanation.ResponseStatusException
(HttpStatusCode status, String reason, Throwable cause) Constructor with a response status and a reason to add to the exception message as explanation, as well as a nested exception.ResponseStatusException
(HttpStatusCode status, String reason, Throwable cause) Constructor with a response status and a reason to add to the exception message as explanation, as well as a nested exception.protected
ResponseStatusException
(HttpStatusCode status, String reason, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a message code and arguments for resolving the error "detail" viaMessageSource
.protected
ResponseStatusException
(HttpStatusCode status, String reason, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a message code and arguments for resolving the error "detail" viaMessageSource
.protected
ResponseStatusException
(HttpStatusCode status, String reason, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a message code and arguments for resolving the error "detail" viaMessageSource
.protected
ResponseStatusException
(HttpStatusCode status, String reason, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a message code and arguments for resolving the error "detail" viaMessageSource
.ServerErrorException
(String reason, Method handlerMethod, Throwable cause) Constructor for a 500 error with a handlerMethod
and an optional cause.ServerErrorException
(String reason, Throwable cause) Constructor for a 500 error with a reason and an optional cause.ServerErrorException
(String reason, MethodParameter parameter, Throwable cause) Constructor for a 500 error with aMethodParameter
and an optional cause.ServerWebInputException
(String reason, MethodParameter parameter) Constructor for a 400 error linked to a specificMethodParameter
.ServerWebInputException
(String reason, MethodParameter parameter, Throwable cause) Constructor for a 400 error with a root cause.ServerWebInputException
(String reason, MethodParameter parameter, Throwable cause) Constructor for a 400 error with a root cause.protected
ServerWebInputException
(String reason, MethodParameter parameter, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a message code and arguments for resolving the error "detail" viaMessageSource
.protected
ServerWebInputException
(String reason, MethodParameter parameter, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a message code and arguments for resolving the error "detail" viaMessageSource
.protected
ServerWebInputException
(String reason, MethodParameter parameter, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a message code and arguments for resolving the error "detail" viaMessageSource
.protected
ServerWebInputException
(String reason, MethodParameter parameter, Throwable cause, String messageDetailCode, Object[] messageDetailArguments) Constructor with a message code and arguments for resolving the error "detail" viaMessageSource
.Constructor for when the specified Content-Type is invalid.UnsupportedMediaTypeStatusException
(String reason, List<MediaType> supportedTypes) Constructor for when the specified Content-Type is invalid.UnsupportedMediaTypeStatusException
(MediaType contentType, List<MediaType> supportedTypes) Constructor for when the Content-Type can be parsed but is not supported.UnsupportedMediaTypeStatusException
(MediaType contentType, List<MediaType> supportedTypes, ResolvableType bodyType) Constructor for when trying to encode from or decode to a specific Java type.UnsupportedMediaTypeStatusException
(MediaType contentType, List<MediaType> supportedTypes, ResolvableType bodyType) Constructor for when trying to encode from or decode to a specific Java type.UnsupportedMediaTypeStatusException
(MediaType contentType, List<MediaType> supportedTypes, ResolvableType bodyType, HttpMethod method) Constructor for when trying to encode from or decode to a specific Java type.UnsupportedMediaTypeStatusException
(MediaType contentType, List<MediaType> supportedTypes, ResolvableType bodyType, HttpMethod method) Constructor for when trying to encode from or decode to a specific Java type.UnsupportedMediaTypeStatusException
(MediaType contentType, List<MediaType> supportedTypes, ResolvableType bodyType, HttpMethod method) Constructor for when trying to encode from or decode to a specific Java type.UnsupportedMediaTypeStatusException
(MediaType contentType, List<MediaType> supportedTypes, HttpMethod method) Constructor that provides the HTTP method.UnsupportedMediaTypeStatusException
(MediaType contentType, List<MediaType> supportedTypes, HttpMethod method) Constructor that provides the HTTP method. -
Uses of Nullable in org.springframework.web.server.adapter
Modifier and TypeMethodDescriptionDefaultServerWebExchange.getApplicationContext()
HttpWebHandlerAdapter.getApplicationContext()
Return the configuredApplicationContext
, if any.HttpWebHandlerAdapter.getForwardedHeaderTransformer()
Return the configuredForwardedHeaderTransformer
.Modifier and TypeMethodDescriptionboolean
DefaultServerWebExchange.checkNotModified
(String eTag, Instant lastModified) void
HttpWebHandlerAdapter.setForwardedHeaderTransformer
(ForwardedHeaderTransformer transformer) Enable processing of forwarded headers, either extracting and removing, or remove only. -
Uses of Nullable in org.springframework.web.server.handler
Modifier and TypeMethodDescriptionprotected HttpStatusCode
ResponseStatusExceptionHandler.determineStatus
(Throwable ex) Determine the HTTP status for the given exception. -
Uses of Nullable in org.springframework.web.server.i18n
Modifier and TypeMethodDescriptionAcceptHeaderLocaleContextResolver.getDefaultLocale()
The configured default locale, if any.Modifier and TypeMethodDescriptionvoid
AcceptHeaderLocaleContextResolver.setDefaultLocale
(Locale defaultLocale) Configure a fixed default locale to fall back on if the request does not have an "Accept-Language" header (not set by default).void
AcceptHeaderLocaleContextResolver.setLocaleContext
(ServerWebExchange exchange, LocaleContext locale) void
FixedLocaleContextResolver.setLocaleContext
(ServerWebExchange exchange, LocaleContext localeContext) void
LocaleContextResolver.setLocaleContext
(ServerWebExchange exchange, LocaleContext localeContext) Set the current locale context to the given one, potentially including a locale with associated time zone information.ModifierConstructorDescriptionFixedLocaleContextResolver
(Locale locale, TimeZone timeZone) Create a FixedLocaleResolver that exposes the given locale and time zone. -
Uses of Nullable in org.springframework.web.service.invoker
Modifier and TypeMethodDescriptionprotected abstract AbstractNamedValueArgumentResolver.NamedValueInfo
AbstractNamedValueArgumentResolver.createNamedValueInfo
(MethodParameter parameter) Return information about the request value, ornull
if the parameter does not represent a request value of interest.<T> T
HttpExchangeAdapter.exchangeForBody
(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType) Perform the given request and decode the response content to the given type.AbstractReactorHttpExchangeAdapter.getBlockTimeout()
ReactorHttpExchangeAdapter.getBlockTimeout()
Return the configured time to block for the response from an HTTP service method with a synchronous (blocking) method signature.Publisher<?>
HttpRequestValues.getBody()
Deprecated, for removal: This API element is subject to removal in a future version.in favor ofReactiveHttpRequestValues.getBodyPublisher()
; to be removed in 6.2Publisher<?>
ReactiveHttpRequestValues.getBody()
Return the request body as a Publisher.HttpRequestValues.getBodyElementType()
Deprecated, for removal: This API element is subject to removal in a future version.in favor ofReactiveHttpRequestValues.getBodyPublisherElementType()
; to be removed in 6.2ReactiveHttpRequestValues.getBodyElementType()
Return the element type for a Publisher body.Publisher<?>
ReactiveHttpRequestValues.getBodyPublisher()
Return aPublisher
that will produce for the request body.ReactiveHttpRequestValues.getBodyPublisherElementType()
Return the element type for a Publisher body.HttpRequestValues.getBodyValue()
Return the request body as a value to be serialized, if set.HttpRequestValues.getHttpMethod()
Return the HTTP method to use for the request.HttpRequestValues.getUri()
Return the URL to use.HttpRequestValues.getUriTemplate()
Return the URL template for the request.Modifier and TypeMethodDescriptionHttpServiceProxyFactory.Builder.blockTimeout
(Duration blockTimeout) Deprecated, for removal: This API element is subject to removal in a future version.in favor of setting the same directly on theHttpExchangeAdapter
protected HttpRequestValues
HttpRequestValues.Builder.createRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) protected HttpRequestValues
HttpRequestValues.Builder.createRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) protected HttpRequestValues
HttpRequestValues.Builder.createRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) protected HttpRequestValues
HttpRequestValues.Builder.createRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) protected ReactiveHttpRequestValues
ReactiveHttpRequestValues.Builder.createRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) protected ReactiveHttpRequestValues
ReactiveHttpRequestValues.Builder.createRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) protected ReactiveHttpRequestValues
ReactiveHttpRequestValues.Builder.createRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) protected ReactiveHttpRequestValues
ReactiveHttpRequestValues.Builder.createRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) boolean
AbstractNamedValueArgumentResolver.resolve
(Object argument, MethodParameter parameter, HttpRequestValues.Builder requestValues) boolean
HttpMethodArgumentResolver.resolve
(Object argument, MethodParameter parameter, HttpRequestValues.Builder requestValues) boolean
HttpServiceArgumentResolver.resolve
(Object argument, MethodParameter parameter, HttpRequestValues.Builder requestValues) Resolve the argument value.boolean
RequestBodyArgumentResolver.resolve
(Object argument, MethodParameter parameter, HttpRequestValues.Builder requestValues) boolean
UrlArgumentResolver.resolve
(Object argument, MethodParameter parameter, HttpRequestValues.Builder requestValues) void
AbstractReactorHttpExchangeAdapter.setBlockTimeout
(Duration blockTimeout) Configure how long to block for the response of an HTTP service method as described inAbstractReactorHttpExchangeAdapter.getBlockTimeout()
.AbstractNamedValueArgumentResolver.NamedValueInfo.update
(String name, boolean required, String defaultValue) ModifierConstructorDescriptionprotected
HttpRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVariables, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) protected
HttpRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVariables, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) protected
HttpRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVariables, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) protected
HttpRequestValues
(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String, String> uriVariables, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue) NamedValueInfo
(String name, boolean required, String defaultValue, String label, boolean multiValued) Create an instance. -
Uses of Nullable in org.springframework.web.servlet
Modifier and TypeMethodDescriptionprotected LocaleContext
FrameworkServlet.buildLocaleContext
(HttpServletRequest request) Build a LocaleContext for the given request, exposing the request's primary locale as current locale.protected ServletRequestAttributes
FrameworkServlet.buildRequestAttributes
(HttpServletRequest request, HttpServletResponse response, RequestAttributes previousAttributes) Build ServletRequestAttributes for the given request (potentially also holding a reference to the response), taking pre-bound attributes (and their type) into consideration.protected WebApplicationContext
FrameworkServlet.findWebApplicationContext()
default String
View.getContentType()
Return the content type of the view, if predetermined.FrameworkServlet.getContextAttribute()
Return the name of the ServletContext attribute which should be used to retrieve theWebApplicationContext
that this servlet is supposed to use.FrameworkServlet.getContextConfigLocation()
Return the explicit context config location, if any.FrameworkServlet.getContextId()
Return the custom WebApplicationContext id, if any.protected String
DispatcherServlet.getDefaultViewName
(HttpServletRequest request) Translate the supplied request into a default view name.protected HandlerExecutionChain
DispatcherServlet.getHandler
(HttpServletRequest request) Return the HandlerExecutionChain for this request.HandlerMapping.getHandler
(HttpServletRequest request) Return a handler and any interceptors for this request.final List<HandlerMapping>
DispatcherServlet.getHandlerMappings()
Return the configuredHandlerMapping
beans that were detected by type in theWebApplicationContext
or initialized based on the default set of strategies from DispatcherServlet.properties.HandlerExecutionChain.getInterceptors()
Return the array of interceptors to apply (in the given order).ModelAndView.getModelInternal()
Return the model map.final MultipartResolver
DispatcherServlet.getMultipartResolver()
Obtain this servlet's MultipartResolver, if any.HttpServletBean.getServletName()
Overridden method that simply returnsnull
when no ServletConfig set yet.ModelAndView.getStatus()
Return the configured HTTP status for the response, if any.FlashMap.getTargetRequestPath()
Return the target URL path (ornull
if none specified).final ThemeSource
DispatcherServlet.getThemeSource()
Deprecated.protected String
FrameworkServlet.getUsernameForRequest
(HttpServletRequest request) Determine the username for the given request.ModelAndView.getView()
Return the View object, ornull
if we are using a view name to be resolved by the DispatcherServlet via a ViewResolver.ModelAndView.getViewName()
Return the view name to be resolved by the DispatcherServlet via a ViewResolver, ornull
if we are using a View object.RequestToViewNameTranslator.getViewName
(HttpServletRequest request) Translate the givenHttpServletRequest
into a view name.final WebApplicationContext
FrameworkServlet.getWebApplicationContext()
Return this servlet's WebApplicationContext.HandlerAdapter.handle
(HttpServletRequest request, HttpServletResponse response, Object handler) Use the given handler to handle this request.protected ModelAndView
DispatcherServlet.processHandlerException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Determine an error ModelAndView via the registered HandlerExceptionResolvers.HandlerExceptionResolver.resolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Try to resolve the given exception that got thrown during handler execution, returning aModelAndView
that represents a specific error page if appropriate.protected View
DispatcherServlet.resolveViewName
(String viewName, Map<String, Object> model, Locale locale, HttpServletRequest request) Resolve the given view name into a View object (to be rendered).ViewResolver.resolveViewName
(String viewName, Locale locale) Resolve the given view by name.FlashMapManager.retrieveAndUpdate
(HttpServletRequest request, HttpServletResponse response) Find a FlashMap saved by a previous request that matches to the current request, remove it from underlying storage, and also remove other expired FlashMap instances.Modifier and TypeMethodDescriptionModelAndView.addAllObjects
(Map<String, ?> modelMap) Add all attributes contained in the provided Map to the model.Add an attribute to the model.FlashMap.addTargetRequestParams
(MultiValueMap<String, String> params) Provide request parameters identifying the request for this FlashMap.default void
HandlerInterceptor.afterCompletion
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Callback after completion of request processing, that is, after rendering the view.protected ServletRequestAttributes
FrameworkServlet.buildRequestAttributes
(HttpServletRequest request, HttpServletResponse response, RequestAttributes previousAttributes) Build ServletRequestAttributes for the given request (potentially also holding a reference to the response), taking pre-bound attributes (and their type) into consideration.protected ServletRequestAttributes
FrameworkServlet.buildRequestAttributes
(HttpServletRequest request, HttpServletResponse response, RequestAttributes previousAttributes) Build ServletRequestAttributes for the given request (potentially also holding a reference to the response), taking pre-bound attributes (and their type) into consideration.protected WebApplicationContext
FrameworkServlet.createWebApplicationContext
(ApplicationContext parent) Instantiate the WebApplicationContext for this servlet, either a defaultXmlWebApplicationContext
or acustom context class
, if set.protected WebApplicationContext
FrameworkServlet.createWebApplicationContext
(WebApplicationContext parent) Instantiate the WebApplicationContext for this servlet, either a defaultXmlWebApplicationContext
or acustom context class
, if set.boolean
default void
HandlerInterceptor.postHandle
(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) Interception point after successful execution of a handler.protected ModelAndView
DispatcherServlet.processHandlerException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Determine an error ModelAndView via the registered HandlerExceptionResolvers.void
View.render
(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Render the view given the specified model.HandlerExceptionResolver.resolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Try to resolve the given exception that got thrown during handler execution, returning aModelAndView
that represents a specific error page if appropriate.protected View
DispatcherServlet.resolveViewName
(String viewName, Map<String, Object> model, Locale locale, HttpServletRequest request) Resolve the given view name into a View object (to be rendered).void
FrameworkServlet.setContextAttribute
(String contextAttribute) Set the name of the ServletContext attribute which should be used to retrieve theWebApplicationContext
that this servlet is supposed to use.void
FrameworkServlet.setContextConfigLocation
(String contextConfigLocation) Set the context config location explicitly, instead of relying on the default location built from the namespace.void
FrameworkServlet.setContextId
(String contextId) Specify a custom WebApplicationContext id, to be used as serialization id for the underlying BeanFactory.void
FrameworkServlet.setContextInitializers
(ApplicationContextInitializer<?>... initializers) Specify whichApplicationContextInitializer
instances should be used to initialize the application context used by thisFrameworkServlet
.default void
LocaleContextResolver.setLocale
(HttpServletRequest request, HttpServletResponse response, Locale locale) Default implementation ofLocaleResolver.setLocale(HttpServletRequest, HttpServletResponse, Locale)
that delegates toLocaleContextResolver.setLocaleContext(HttpServletRequest, HttpServletResponse, LocaleContext)
, using aSimpleLocaleContext
.default void
LocaleContextResolver.setLocale
(HttpServletRequest request, HttpServletResponse response, Locale locale) Default implementation ofLocaleResolver.setLocale(HttpServletRequest, HttpServletResponse, Locale)
that delegates toLocaleContextResolver.setLocaleContext(HttpServletRequest, HttpServletResponse, LocaleContext)
, using aSimpleLocaleContext
.void
LocaleResolver.setLocale
(HttpServletRequest request, HttpServletResponse response, Locale locale) Set the current locale to the given one.void
LocaleResolver.setLocale
(HttpServletRequest request, HttpServletResponse response, Locale locale) Set the current locale to the given one.void
LocaleContextResolver.setLocaleContext
(HttpServletRequest request, HttpServletResponse response, LocaleContext localeContext) Set the current locale context to the given one, potentially including a locale with associated time zone information.void
LocaleContextResolver.setLocaleContext
(HttpServletRequest request, HttpServletResponse response, LocaleContext localeContext) Set the current locale context to the given one, potentially including a locale with associated time zone information.void
ModelAndView.setStatus
(HttpStatusCode status) Set the HTTP status to use for the response.void
FlashMap.setTargetRequestPath
(String path) Provide a URL path to help identify the target request for this FlashMap.void
ThemeResolver.setThemeName
(HttpServletRequest request, HttpServletResponse response, String themeName) Deprecated.Set the current theme name to the given one.void
ThemeResolver.setThemeName
(HttpServletRequest request, HttpServletResponse response, String themeName) Deprecated.Set the current theme name to the given one.void
Set a View object for this ModelAndView.void
ModelAndView.setViewName
(String viewName) Set a view name for this ModelAndView, to be resolved by the DispatcherServlet via a ViewResolver.ModifierConstructorDescriptionHandlerExecutionChain
(Object handler, HandlerInterceptor... interceptors) Create a new HandlerExecutionChain.ModelAndView
(String viewName, Map<String, ?> model) Create a new ModelAndView given a view name and a model.ModelAndView
(String viewName, Map<String, ?> model, HttpStatusCode status) Create a new ModelAndView given a view name, model, and HTTP status.ModelAndView
(String viewName, Map<String, ?> model, HttpStatusCode status) Create a new ModelAndView given a view name, model, and HTTP status.ModelAndView
(String viewName, Map<String, ?> model, HttpStatusCode status) Create a new ModelAndView given a view name, model, and HTTP status.ModelAndView
(View view, Map<String, ?> model) Create a new ModelAndView given a View object and a model. -
Uses of Nullable in org.springframework.web.servlet.config
Modifier and TypeMethodDescriptionstatic Object
MvcNamespaceUtils.getContentNegotiationManager
(ParserContext context) Find theContentNegotiationManager
bean created by or registered with theannotation-driven
element.CorsBeanDefinitionParser.parse
(Element element, ParserContext parserContext) Modifier and TypeMethodDescriptionstatic RuntimeBeanReference
MvcNamespaceUtils.registerCorsConfigurations
(Map<String, CorsConfiguration> corsConfigurations, ParserContext context, Object source) Registers aMap<String, CorsConfiguration>
(mappedCorsConfiguration
s) under a well-known name unless already registered.static RuntimeBeanReference
MvcNamespaceUtils.registerCorsConfigurations
(Map<String, CorsConfiguration> corsConfigurations, ParserContext context, Object source) Registers aMap<String, CorsConfiguration>
(mappedCorsConfiguration
s) under a well-known name unless already registered.static void
MvcNamespaceUtils.registerDefaultComponents
(ParserContext context, Object source) static RuntimeBeanReference
MvcNamespaceUtils.registerPathMatcher
(RuntimeBeanReference pathMatcherRef, ParserContext context, Object source) Adds an alias to an existing well-known name or registers a new instance of aPathMatcher
under that well-known name, unless already registered.static RuntimeBeanReference
MvcNamespaceUtils.registerPathMatcher
(RuntimeBeanReference pathMatcherRef, ParserContext context, Object source) Adds an alias to an existing well-known name or registers a new instance of aPathMatcher
under that well-known name, unless already registered.static RuntimeBeanReference
MvcNamespaceUtils.registerUrlPathHelper
(RuntimeBeanReference urlPathHelperRef, ParserContext context, Object source) Adds an alias to an existing well-known name or registers a new instance of aUrlPathHelper
under that well-known name, unless already registered.static RuntimeBeanReference
MvcNamespaceUtils.registerUrlPathHelper
(RuntimeBeanReference urlPathHelperRef, ParserContext context, Object source) Adds an alias to an existing well-known name or registers a new instance of aUrlPathHelper
under that well-known name, unless already registered. -
Uses of Nullable in org.springframework.web.servlet.config.annotation
Modifier and TypeMethodDescriptionprotected SimpleUrlHandlerMapping
DefaultServletHandlerConfigurer.buildHandlerMapping()
Return a handler mapping instance ordered atOrdered.LOWEST_PRECEDENCE
containing theDefaultServletHttpRequestHandler
instance mapped to"/**"
; ornull
if default servlet handling was not enabled.protected SimpleUrlHandlerMapping
ViewControllerRegistry.buildHandlerMapping()
Return theHandlerMapping
that contains the registered view controller mappings, ornull
for no registrations.WebMvcConfigurationSupport.defaultServletHandlerMapping()
Return a handler mapping ordered at Integer.MAX_VALUE with a mapped default servlet handler.final ApplicationContext
WebMvcConfigurationSupport.getApplicationContext()
Return the associated SpringApplicationContext
.protected AbstractHandlerMapping
ResourceHandlerRegistry.getHandlerMapping()
Return a handler mapping with the mapped resource handlers; ornull
in case of no registrations.protected MessageCodesResolver
DelegatingWebMvcConfiguration.getMessageCodesResolver()
protected MessageCodesResolver
WebMvcConfigurationSupport.getMessageCodesResolver()
Override this method to provide a customMessageCodesResolver
.default MessageCodesResolver
WebMvcConfigurer.getMessageCodesResolver()
Provide a customMessageCodesResolver
for building message codes from data binding and validation error codes.PathMatchConfigurer.getPathMatcher()
PathMatchConfigurer.getPathPrefixes()
PathMatchConfigurer.getPatternParser()
Return thePathPatternParser
to use, if configured.final ServletContext
WebMvcConfigurationSupport.getServletContext()
Return the associatedServletContext
.protected AsyncTaskExecutor
AsyncSupportConfigurer.getTaskExecutor()
protected Long
AsyncSupportConfigurer.getTimeout()
PathMatchConfigurer.getUrlPathHelper()
protected Validator
DelegatingWebMvcConfiguration.getValidator()
protected Validator
WebMvcConfigurationSupport.getValidator()
Override this method to provide a customValidator
.default Validator
WebMvcConfigurer.getValidator()
Provide a customValidator
instead of the one created by default.PathMatchConfigurer.isUseRegisteredSuffixPatternMatch()
Deprecated.as of 5.2.4, see deprecation note onPathMatchConfigurer.setUseRegisteredSuffixPatternMatch(Boolean)
.PathMatchConfigurer.isUseSuffixPatternMatch()
Deprecated.as of 5.2.4, see deprecation note onPathMatchConfigurer.setUseSuffixPatternMatch(Boolean)
.PathMatchConfigurer.isUseTrailingSlashMatch()
Deprecated.WebMvcConfigurationSupport.resourceHandlerMapping
(ContentNegotiationManager contentNegotiationManager, FormattingConversionService conversionService, ResourceUrlProvider resourceUrlProvider) Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers.WebMvcConfigurationSupport.viewControllerHandlerMapping
(FormattingConversionService conversionService, ResourceUrlProvider resourceUrlProvider) Return a handler mapping ordered at 1 to map URL paths directly to view names.Modifier and TypeMethodDescriptionvoid
Enable forwarding to the "default" Servlet identified by the given name.ContentNegotiationConfigurer.mediaTypes
(Map<String, MediaType> mediaTypes) protected void
RedirectViewControllerRegistration.setApplicationContext
(ApplicationContext applicationContext) protected void
ViewControllerRegistration.setApplicationContext
(ApplicationContext applicationContext) void
WebMvcConfigurationSupport.setApplicationContext
(ApplicationContext applicationContext) Set the SpringApplicationContext
, e.g.PathMatchConfigurer.setPatternParser
(PathPatternParser patternParser) Set thePathPatternParser
to parsepatterns
with for URL path matching.void
WebMvcConfigurationSupport.setServletContext
(ServletContext servletContext) Set theServletContext
, e.g.PathMatchConfigurer.setUseRegisteredSuffixPatternMatch
(Boolean registeredSuffixPatternMatch) Deprecated.as of 5.2.4.PathMatchConfigurer.setUseSuffixPatternMatch
(Boolean suffixPatternMatch) Deprecated.as of 5.2.4.void
ContentNegotiationConfigurer.strategies
(List<ContentNegotiationStrategy> strategies) Set the exact list of strategies to use.ModifierConstructorDescriptionContentNegotiationConfigurer
(ServletContext servletContext) Class constructor withServletContext
.ResourceChainRegistration
(boolean cacheResources, Cache cache) ResourceHandlerRegistry
(ApplicationContext applicationContext, ServletContext servletContext, ContentNegotiationManager contentNegotiationManager) Create a new resource handler registry for the given application context.ResourceHandlerRegistry
(ApplicationContext applicationContext, ServletContext servletContext, ContentNegotiationManager contentNegotiationManager, UrlPathHelper pathHelper) A variant ofResourceHandlerRegistry(ApplicationContext, ServletContext, ContentNegotiationManager)
that also accepts theUrlPathHelper
used for mapping requests to static resources.ResourceHandlerRegistry
(ApplicationContext applicationContext, ServletContext servletContext, ContentNegotiationManager contentNegotiationManager, UrlPathHelper pathHelper) A variant ofResourceHandlerRegistry(ApplicationContext, ServletContext, ContentNegotiationManager)
that also accepts theUrlPathHelper
used for mapping requests to static resources.ViewControllerRegistry
(ApplicationContext applicationContext) Class constructor withApplicationContext
.ViewResolverRegistry
(ContentNegotiationManager contentNegotiationManager, ApplicationContext context) Class constructor withContentNegotiationManager
andApplicationContext
. -
Uses of Nullable in org.springframework.web.servlet.function
Modifier and TypeMethodDescriptiondefault String
ServerRequest.Headers.firstHeader
(String headerName) Get the first header value, if any, for the header for the given name.ServerRequest.Headers.host()
Get the value of theHost
header, if available.ServerResponse.HeadersBuilder.WriteFunction.write
(HttpServletRequest servletRequest, HttpServletResponse servletResponse) Write to the givenservletResponse
, or return aModelAndView
to be rendered.ServerResponse.writeTo
(HttpServletRequest request, HttpServletResponse response, ServerResponse.Context context) Write this response to the given servlet response.Modifier and TypeMethodDescriptionRenderingResponse.Builder.modelAttribute
(String name, Object value) Add the supplied attribute value under the supplied name. -
Uses of Nullable in org.springframework.web.servlet.function.support
Modifier and TypeMethodDescriptionprotected Object
RouterFunctionMapping.getHandlerInternal
(HttpServletRequest servletRequest) RouterFunctionMapping.getRouterFunction()
Return the configuredRouterFunction
.HandlerFunctionAdapter.handle
(HttpServletRequest servletRequest, HttpServletResponse servletResponse, Object handler) Modifier and TypeMethodDescriptionvoid
RouterFunctionMapping.setRouterFunction
(RouterFunction<?> routerFunction) Set the router function to map to. -
Uses of Nullable in org.springframework.web.servlet.handler
Modifier and TypeMethodDescriptionprotected Integer
SimpleMappingExceptionResolver.determineStatusCode
(HttpServletRequest request, String viewName) Determine the HTTP status code to apply for the given error view.protected String
SimpleMappingExceptionResolver.determineViewName
(Exception ex, HttpServletRequest request) Determine the view name for the given exception, first checking against the"excludedExecptions"
, then searching the"exceptionMappings"
, and finally using the"defaultErrorView"
as a fallback.protected abstract ModelAndView
AbstractHandlerExceptionResolver.doResolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Actually resolve the given exception that got thrown during handler execution, returning aModelAndView
that represents a specific error page if appropriate.protected final ModelAndView
AbstractHandlerMethodExceptionResolver.doResolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) protected ModelAndView
SimpleMappingExceptionResolver.doResolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Actually resolve the given exception that got thrown during on handler execution, returning a ModelAndView that represents a specific error page if appropriate.protected abstract ModelAndView
AbstractHandlerMethodExceptionResolver.doResolveHandlerMethodException
(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod, Exception ex) Actually resolve the given exception that got thrown during on handler execution, returning a ModelAndView that represents a specific error page if appropriate.protected String
SimpleMappingExceptionResolver.findMatchingViewName
(Properties exceptionMappings, Exception ex) Find a matching view name in the given exception mappings.final HandlerInterceptor[]
AbstractHandlerMapping.getAdaptedInterceptors()
Return all configured interceptors adapted toHandlerInterceptor
.protected CorsConfiguration
AbstractHandlerMapping.getCorsConfiguration
(Object handler, HttpServletRequest request) Retrieve the CORS configuration for the given handler.HandlerMappingIntrospector.getCorsConfiguration
(HttpServletRequest request) AbstractHandlerMapping.getCorsConfigurationSource()
Return theconfigured
CorsConfigurationSource
, if any.AbstractHandlerMapping.getDefaultHandler()
Return the default handler for this handler mapping, ornull
if none.String[]
MappedInterceptor.getExcludePathPatterns()
Get the exclude path patterns this interceptor is mapped to.final HandlerExecutionChain
AbstractHandlerMapping.getHandler
(HttpServletRequest request) Look up a handler for the given request, falling back to the default handler if no specific one is found.protected abstract Object
AbstractHandlerMapping.getHandlerInternal
(HttpServletRequest request) Look up a handler for the given request, returningnull
if no specific one is found.protected HandlerMethod
AbstractHandlerMethodMapping.getHandlerInternal
(HttpServletRequest request) Look up a handler method for the given request.protected Object
AbstractUrlHandlerMapping.getHandlerInternal
(HttpServletRequest request) Look up a handler for the URL path of the given request.AbstractHandlerMethodMapping.getHandlerMethodsForMappingName
(String mappingName) Return the handler methods for the given mapping name.String[]
MappedInterceptor.getIncludePathPatterns()
Get the include path patterns this interceptor is mapped to.protected Class<?>[]
AbstractHandlerExceptionResolver.getMappedHandlerClasses()
Return theconfigured
mapped handler classes.protected final MappedInterceptor[]
AbstractHandlerMapping.getMappedInterceptors()
Return all configuredMappedInterceptor
s as an array.protected abstract T
AbstractHandlerMethodMapping.getMappingForMethod
(Method method, Class<?> handlerType) Provide the mapping for a handler method.HandlerMappingIntrospector.getMatchableHandlerMapping
(HttpServletRequest request) Find theHandlerMapping
that would handle the given request and return aMatchableHandlerMapping
to use for path matching.protected abstract T
AbstractHandlerMethodMapping.getMatchingMapping
(T mapping, HttpServletRequest request) Check if a mapping matches the current request and return a (potentially new) mapping with conditions relevant to the current request.AbstractHandlerMethodMapping.getNamingStrategy()
Return the configured naming strategy ornull
.String[]
MappedInterceptor.getPathPatterns()
Deprecated, for removal: This API element is subject to removal in a future version.since 6.1 in favor ofMappedInterceptor.getIncludePathPatterns()
AbstractHandlerMapping.getPatternParser()
Return theconfigured
PathPatternParser
, ornull
otherwise which indicates that String pattern matching withAntPathMatcher
is enabled instead.default PathPatternParser
MatchableHandlerMapping.getPatternParser()
Return the parser of thisHandlerMapping
, if configured in which case pre-parsed patterns are used.AbstractUrlHandlerMapping.getRootHandler()
Return the root handler for this handler mapping (registered for "/"), ornull
if none.SimpleServletHandlerAdapter.handle
(HttpServletRequest request, HttpServletResponse response, Object handler) protected HandlerMethod
AbstractHandlerMethodMapping.handleNoMatch
(Set<T> mappings, String lookupPath, HttpServletRequest request) Invoked when no matching mapping is not found.protected CorsConfiguration
AbstractHandlerMethodMapping.initCorsConfiguration
(Object handler, Method method, T mapping) Extract and return the CORS configuration for the mapping.protected Object
AbstractUrlHandlerMapping.lookupHandler
(String lookupPath, HttpServletRequest request) Look up a handler instance for the given URL path.protected Object
AbstractUrlHandlerMapping.lookupHandler
(RequestPath path, String lookupPath, HttpServletRequest request) Look up a handler instance for the given URL path.protected HandlerMethod
AbstractHandlerMethodMapping.lookupHandlerMethod
(String lookupPath, HttpServletRequest request) Look up the best-matching handler method for the current request.AbstractUrlHandlerMapping.match
(HttpServletRequest request, String pattern) MatchableHandlerMapping.match
(HttpServletRequest request, String pattern) Determine whether the request matches the given pattern.AbstractHandlerExceptionResolver.resolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Check whether this resolver is supposed to apply (i.e.HandlerExceptionResolverComposite.resolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Resolve the exception by iterating over the list of configured exception resolvers.Modifier and TypeMethodDescriptionvoid
MappedInterceptor.afterCompletion
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) void
WebRequestHandlerInterceptorAdapter.afterCompletion
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) protected Object
AbstractUrlHandlerMapping.buildPathExposingHandler
(Object rawHandler, String bestMatchingPattern, String pathWithinMapping, Map<String, String> uriTemplateVariables) Build a handler object for the given raw handler, exposing the actual handler, theHandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE
, as well as theHandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE
before executing the handler.protected abstract ModelAndView
AbstractHandlerExceptionResolver.doResolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Actually resolve the given exception that got thrown during handler execution, returning aModelAndView
that represents a specific error page if appropriate.protected final ModelAndView
AbstractHandlerMethodExceptionResolver.doResolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) protected ModelAndView
SimpleMappingExceptionResolver.doResolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Actually resolve the given exception that got thrown during on handler execution, returning a ModelAndView that represents a specific error page if appropriate.protected abstract ModelAndView
AbstractHandlerMethodExceptionResolver.doResolveHandlerMethodException
(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod, Exception ex) Actually resolve the given exception that got thrown during on handler execution, returning a ModelAndView that represents a specific error page if appropriate.protected HandlerExecutionChain
AbstractHandlerMapping.getCorsHandlerExecutionChain
(HttpServletRequest request, HandlerExecutionChain chain, CorsConfiguration config) Update the HandlerExecutionChain for CORS-related handling.void
MappedInterceptor.postHandle
(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) void
WebRequestHandlerInterceptorAdapter.postHandle
(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) AbstractHandlerExceptionResolver.resolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Check whether this resolver is supposed to apply (i.e.HandlerExceptionResolverComposite.resolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Resolve the exception by iterating over the list of configured exception resolvers.void
AbstractHandlerMapping.setDefaultHandler
(Object defaultHandler) Set the default handler for this handler mapping.void
SimpleMappingExceptionResolver.setExceptionAttribute
(String exceptionAttribute) Set the name of the model attribute as which the exception should be exposed.void
AbstractHandlerMapping.setPatternParser
(PathPatternParser patternParser) Set thePathPatternParser
to parsepatterns
with for URL path matching.void
AbstractHandlerMethodMapping.setPatternParser
(PathPatternParser patternParser) void
AbstractUrlHandlerMapping.setPatternParser
(PathPatternParser patternParser) void
AbstractUrlHandlerMapping.setRootHandler
(Object rootHandler) Set the root handler for this handler mapping, that is, the handler to be registered for the root path ("/").protected boolean
AbstractHandlerExceptionResolver.shouldApplyTo
(HttpServletRequest request, Object handler) Check whether this resolver is supposed to apply to the given handler.protected boolean
AbstractHandlerMethodExceptionResolver.shouldApplyTo
(HttpServletRequest request, Object handler) Checks if the handler is aHandlerMethod
and then delegates to the base class implementation of#shouldApplyTo(HttpServletRequest, Object)
passing the bean of theHandlerMethod
.ModifierConstructorDescriptionMappedInterceptor
(String[] includePatterns, String[] excludePatterns, WebRequestInterceptor interceptor) Variant ofMappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
with aWebRequestInterceptor
as the target.MappedInterceptor
(String[] includePatterns, String[] excludePatterns, WebRequestInterceptor interceptor) Variant ofMappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
with aWebRequestInterceptor
as the target.MappedInterceptor
(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor) Variant ofMappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
without a provided parser.MappedInterceptor
(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor) Variant ofMappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
without a provided parser.MappedInterceptor
(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor, PathPatternParser parser) Create an instance with the given include and exclude patterns along with the target interceptor for the mappings.MappedInterceptor
(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor, PathPatternParser parser) Create an instance with the given include and exclude patterns along with the target interceptor for the mappings.MappedInterceptor
(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor, PathPatternParser parser) Create an instance with the given include and exclude patterns along with the target interceptor for the mappings.MappedInterceptor
(String[] includePatterns, WebRequestInterceptor interceptor) Variant ofMappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
with aWebRequestInterceptor
as the target.MappedInterceptor
(String[] includePatterns, HandlerInterceptor interceptor) Variant ofMappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)
with include patterns only. -
Uses of Nullable in org.springframework.web.servlet.i18n
Modifier and TypeMethodDescriptionprotected TimeZone
CookieLocaleResolver.determineDefaultTimeZone
(HttpServletRequest request) Deprecated.as of 6.0, in favor ofCookieLocaleResolver.setDefaultTimeZoneFunction(Function)
protected TimeZone
SessionLocaleResolver.determineDefaultTimeZone
(HttpServletRequest request) Deprecated.as of 6.0, in favor ofSessionLocaleResolver.setDefaultTimeZoneFunction(Function)
protected Locale
AbstractLocaleResolver.getDefaultLocale()
Get the defaultLocale
that this resolver is supposed to fall back to, if any.AbstractLocaleContextResolver.getDefaultTimeZone()
Get the defaultTimeZone
that this resolver is supposed to fall back to, if any.String[]
LocaleChangeInterceptor.getHttpMethods()
Return the configured HTTP methods.protected Locale
CookieLocaleResolver.parseLocaleValue
(String localeValue) Parse the given locale value coming from an incoming cookie.protected Locale
LocaleChangeInterceptor.parseLocaleValue
(String localeValue) Parse the given locale value as coming from a request parameter.Modifier and TypeMethodDescriptionvoid
CookieLocaleResolver.setCookieDomain
(String cookieDomain) Set the cookie "Domain" attribute.void
CookieLocaleResolver.setCookieMaxAge
(Integer cookieMaxAge) Deprecated.as of 6.0 in favor ofCookieLocaleResolver.setCookieMaxAge(Duration)
void
CookieLocaleResolver.setCookiePath
(String cookiePath) Set the cookie "Path" attribute.void
AbstractLocaleResolver.setDefaultLocale
(Locale defaultLocale) Set a defaultLocale
that this resolver will return if no other locale is found.void
AbstractLocaleContextResolver.setDefaultTimeZone
(TimeZone defaultTimeZone) Set a defaultTimeZone
that this resolver will return if no other time zone is found.void
LocaleChangeInterceptor.setHttpMethods
(String... httpMethods) Configure the HTTP method(s) over which the locale can be changed.void
AcceptHeaderLocaleResolver.setLocale
(HttpServletRequest request, HttpServletResponse response, Locale locale) void
AcceptHeaderLocaleResolver.setLocale
(HttpServletRequest request, HttpServletResponse response, Locale locale) void
CookieLocaleResolver.setLocaleContext
(HttpServletRequest request, HttpServletResponse response, LocaleContext localeContext) void
CookieLocaleResolver.setLocaleContext
(HttpServletRequest request, HttpServletResponse response, LocaleContext localeContext) void
FixedLocaleResolver.setLocaleContext
(HttpServletRequest request, HttpServletResponse response, LocaleContext localeContext) void
FixedLocaleResolver.setLocaleContext
(HttpServletRequest request, HttpServletResponse response, LocaleContext localeContext) void
SessionLocaleResolver.setLocaleContext
(HttpServletRequest request, HttpServletResponse response, LocaleContext localeContext) void
SessionLocaleResolver.setLocaleContext
(HttpServletRequest request, HttpServletResponse response, LocaleContext localeContext) -
Uses of Nullable in org.springframework.web.servlet.mvc
Modifier and TypeMethodDescriptionParameterizableViewController.getStatusCode()
Return the configured HTTP status code ornull
.ParameterizableViewController.getView()
Return the View object, ornull
if we are using a view name to be resolved by the DispatcherServlet via a ViewResolver.ParameterizableViewController.getViewName()
Return the name of the view to delegate to, ornull
if using a View instance.HttpRequestHandlerAdapter.handle
(HttpServletRequest request, HttpServletResponse response, Object handler) SimpleControllerHandlerAdapter.handle
(HttpServletRequest request, HttpServletResponse response, Object handler) AbstractController.handleRequest
(HttpServletRequest request, HttpServletResponse response) Controller.handleRequest
(HttpServletRequest request, HttpServletResponse response) Process the request and return a ModelAndView object which the DispatcherServlet will render.protected abstract ModelAndView
AbstractController.handleRequestInternal
(HttpServletRequest request, HttpServletResponse response) Template method.protected CacheControl
WebContentInterceptor.lookupCacheControl
(String lookupPath) Find aCacheControl
instance for the given String lookupPath.protected CacheControl
WebContentInterceptor.lookupCacheControl
(PathContainer path) Find aCacheControl
instance for the given parsedpath
.protected Integer
WebContentInterceptor.lookupCacheSeconds
(String lookupPath) Find a cacheSeconds instance for the given String lookupPath.protected Integer
WebContentInterceptor.lookupCacheSeconds
(PathContainer path) Find a cacheSeconds value for the given parsedpath
.Modifier and TypeMethodDescriptionvoid
WebContentInterceptor.afterCompletion
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) This implementation is empty.void
WebContentInterceptor.postHandle
(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) This implementation is empty.void
Set the prefix to prepend to the request URL filename to build a view name.void
ParameterizableViewController.setStatusCode
(HttpStatusCode statusCode) Configure the HTTP status code that this controller should set on the response.void
Set the suffix to append to the request URL filename to build a view name.void
ParameterizableViewController.setViewName
(String viewName) Set a view name for the ModelAndView to return, to be resolved by the DispatcherServlet via a ViewResolver. -
Uses of Nullable in org.springframework.web.servlet.mvc.annotation
Modifier and TypeMethodDescriptionprotected ModelAndView
ResponseStatusExceptionResolver.doResolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Modifier and TypeMethodDescriptionprotected ModelAndView
ResponseStatusExceptionResolver.applyStatusAndReason
(int statusCode, String reason, HttpServletResponse response) Apply the resolved status code and reason to the response.protected ModelAndView
ResponseStatusExceptionResolver.doResolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) ModelAndViewResolver.resolveModelAndView
(Method handlerMethod, Class<?> handlerType, Object returnValue, ExtendedModelMap implicitModel, NativeWebRequest webRequest) protected ModelAndView
ResponseStatusExceptionResolver.resolveResponseStatus
(ResponseStatus responseStatus, HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Template method that handles the@ResponseStatus
annotation.protected ModelAndView
ResponseStatusExceptionResolver.resolveResponseStatusException
(ResponseStatusException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Template method that handles anResponseStatusException
. -
Uses of Nullable in org.springframework.web.servlet.mvc.condition
Modifier and TypeMethodDescriptionRequestConditionHolder.getCondition()
Return the held request condition, ornull
if not holding one.CompositeRequestCondition.getMatchingCondition
(HttpServletRequest request) Delegate to all contained conditions to match the request and return the resulting "matching" condition instances.ConsumesRequestCondition.getMatchingCondition
(HttpServletRequest request) Checks if any of the contained media type expressions match the given request 'Content-Type' header and returns an instance that is guaranteed to contain matching expressions only.HeadersRequestCondition.getMatchingCondition
(HttpServletRequest request) Returns "this" instance if the request matches all expressions; ornull
otherwise.ParamsRequestCondition.getMatchingCondition
(HttpServletRequest request) Returns "this" instance if the request matches all param expressions; ornull
otherwise.PathPatternsRequestCondition.getMatchingCondition
(HttpServletRequest request) Checks if any of the patterns match the given request and returns an instance that is guaranteed to contain matching patterns, sorted.PatternsRequestCondition.getMatchingCondition
(HttpServletRequest request) Checks if any of the patterns match the given request and returns an instance that is guaranteed to contain matching patterns, sorted viaPathMatcher.getPatternComparator(String)
.ProducesRequestCondition.getMatchingCondition
(HttpServletRequest request) Checks if any of the contained media type expressions match the given request 'Content-Type' header and returns an instance that is guaranteed to contain matching expressions only.RequestCondition.getMatchingCondition
(HttpServletRequest request) Check if the condition matches the request returning a potentially new instance created for the current request.RequestConditionHolder.getMatchingCondition
(HttpServletRequest request) Get the matching condition for the held request condition wrap it in a new RequestConditionHolder instance.RequestMethodsRequestCondition.getMatchingCondition
(HttpServletRequest request) Check if any of the HTTP request methods match the given request and return an instance that contains the matching HTTP request method only.NameValueExpression.getValue()
ModifierConstructorDescriptionConsumesRequestCondition
(String[] consumes, String[] headers) Creates a new instance with "consumes" and "header" expressions.PatternsRequestCondition
(String[] patterns, boolean useTrailingSlashMatch, PathMatcher pathMatcher) Variant ofPatternsRequestCondition(String...)
with aPathMatcher
and flag for matching trailing slashes.PatternsRequestCondition
(String[] patterns, UrlPathHelper urlPathHelper, PathMatcher pathMatcher, boolean useTrailingSlashMatch) Deprecated.as of 5.3 in favor ofPatternsRequestCondition(String[], boolean, PathMatcher)
.PatternsRequestCondition
(String[] patterns, UrlPathHelper urlPathHelper, PathMatcher pathMatcher, boolean useTrailingSlashMatch) Deprecated.as of 5.3 in favor ofPatternsRequestCondition(String[], boolean, PathMatcher)
.PatternsRequestCondition
(String[] patterns, UrlPathHelper urlPathHelper, PathMatcher pathMatcher, boolean useSuffixPatternMatch, boolean useTrailingSlashMatch) Deprecated.as of 5.2.4.PatternsRequestCondition
(String[] patterns, UrlPathHelper urlPathHelper, PathMatcher pathMatcher, boolean useSuffixPatternMatch, boolean useTrailingSlashMatch) Deprecated.as of 5.2.4.PatternsRequestCondition
(String[] patterns, UrlPathHelper urlPathHelper, PathMatcher pathMatcher, boolean useSuffixPatternMatch, boolean useTrailingSlashMatch, List<String> fileExtensions) Deprecated.as of 5.2.4.PatternsRequestCondition
(String[] patterns, UrlPathHelper urlPathHelper, PathMatcher pathMatcher, boolean useSuffixPatternMatch, boolean useTrailingSlashMatch, List<String> fileExtensions) Deprecated.as of 5.2.4.PatternsRequestCondition
(String[] patterns, UrlPathHelper urlPathHelper, PathMatcher pathMatcher, boolean useSuffixPatternMatch, boolean useTrailingSlashMatch, List<String> fileExtensions) Deprecated.as of 5.2.4.ProducesRequestCondition
(String[] produces, String[] headers) Creates a new instance with "produces" and "header" expressions.ProducesRequestCondition
(String[] produces, String[] headers, ContentNegotiationManager manager) Same asProducesRequestCondition(String[], String[])
but also accepting aContentNegotiationManager
.ProducesRequestCondition
(String[] produces, String[] headers, ContentNegotiationManager manager) Same asProducesRequestCondition(String[], String[])
but also accepting aContentNegotiationManager
.RequestConditionHolder
(RequestCondition<?> requestCondition) Create a new holder to wrap the given request condition. -
Uses of Nullable in org.springframework.web.servlet.mvc.method
Modifier and TypeMethodDescriptionRequestMappingInfo.BuilderConfiguration.getContentNegotiationManager()
Return the ContentNegotiationManager to use for the ProducesRequestCondition, if any.RequestMappingInfo.getCustomCondition()
Return the "custom" condition of thisRequestMappingInfo
, ornull
.RequestMappingInfo.BuilderConfiguration.getFileExtensions()
Deprecated.as of 5.2.4.protected HandlerMethod
RequestMappingInfoHandlerMapping.getHandlerInternal
(HttpServletRequest request) RequestMappingInfo.getMatchingCondition
(HttpServletRequest request) Checks if all conditions in this request mapping info match the provided request and returns a potentially new request mapping info with conditions tailored to the current request.RequestMappingInfo.getName()
Return the name for this mapping, ornull
.RequestMappingInfo.BuilderConfiguration.getPathMatcher()
Return a custom PathMatcher to use for the PatternsRequestCondition, if any.RequestMappingInfo.getPathPatternsCondition()
Return the patterns condition in use when parsed patterns areenabled
.RequestMappingInfo.BuilderConfiguration.getPatternParser()
RequestMappingInfo.getPatternsCondition()
Return the patterns condition when String pattern matching viaPathMatcher
is in use.RequestMappingInfo.BuilderConfiguration.getUrlPathHelper()
Deprecated.as of 5.3, the path is resolved externally and obtained withServletRequestPathUtils.getCachedPathValue(ServletRequest)
; this method always returnsUrlPathHelper.defaultInstance
.final ModelAndView
AbstractHandlerMethodAdapter.handle
(HttpServletRequest request, HttpServletResponse response, Object handler) This implementation expects the handler to be anHandlerMethod
.protected abstract ModelAndView
AbstractHandlerMethodAdapter.handleInternal
(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) Use the given handler method to handle the request.Modifier and TypeMethodDescriptionboolean
void
RequestMappingInfo.BuilderConfiguration.setPathMatcher
(PathMatcher pathMatcher) Set a custom PathMatcher to use for the PatternsRequestCondition.void
RequestMappingInfo.BuilderConfiguration.setPatternParser
(PathPatternParser patternParser) Enable use of parsedPathPattern
s as described inAbstractHandlerMapping.setPatternParser(PathPatternParser)
.void
RequestMappingInfo.BuilderConfiguration.setUrlPathHelper
(UrlPathHelper urlPathHelper) Deprecated.as of 5.3, the path is resolved externally and obtained withServletRequestPathUtils.getCachedPathValue(ServletRequest)
ModifierConstructorDescriptionRequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated.as of 5.3 in favor usingRequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
.RequestMappingInfo
(RequestMappingInfo info, RequestCondition<?> customRequestCondition) Deprecated.since 5.3 in favor of usingRequestMappingInfo.addCustomCondition(RequestCondition)
. -
Uses of Nullable in org.springframework.web.servlet.mvc.method.annotation
Modifier and TypeMethodDescriptionprotected Object
AbstractMessageConverterMethodArgumentResolver.adaptArgumentIfNecessary
(Object arg, MethodParameter parameter) Adapt the given argument against the method parameter, if necessary.final Object
AbstractMappingJacksonResponseBodyAdvice.beforeBodyWrite
(Object body, MethodParameter returnType, MediaType contentType, Class<? extends HttpMessageConverter<?>> converterType, ServerHttpRequest request, ServerHttpResponse response) ResponseBodyAdvice.beforeBodyWrite
(T body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) Invoked after anHttpMessageConverter
is selected and just before its write method is invoked.protected Object
ServletModelAttributeMethodProcessor.createAttributeFromRequestValue
(String sourceValue, String attributeName, MethodParameter parameter, WebDataBinderFactory binderFactory, NativeWebRequest request) Create a model attribute from a String request value (e.g.protected ModelAndView
ExceptionHandlerExceptionResolver.doResolveHandlerMethodException
(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod, Exception exception) Find an@ExceptionHandler
method and invoke it to handle the raised exception.protected String
PathVariableMethodArgumentResolver.formatUriValue
(ConversionService cs, TypeDescriptor sourceType, Object value) ExceptionHandlerExceptionResolver.getApplicationContext()
ExceptionHandlerExceptionResolver.getArgumentResolvers()
Return the configured argument resolvers, or possiblynull
if not initialized yet viaExceptionHandlerExceptionResolver.afterPropertiesSet()
.RequestMappingHandlerAdapter.getArgumentResolvers()
Return the configured argument resolvers, or possiblynull
if not initialized yet viaRequestMappingHandlerAdapter.afterPropertiesSet()
.protected ConfigurableBeanFactory
RequestMappingHandlerAdapter.getBeanFactory()
Return the owning factory of this bean instance, ornull
if none.ExceptionHandlerExceptionResolver.getCustomArgumentResolvers()
Return the custom argument resolvers, ornull
.RequestMappingHandlerAdapter.getCustomArgumentResolvers()
Return the custom argument resolvers, ornull
.protected RequestCondition<?>
RequestMappingHandlerMapping.getCustomMethodCondition
(Method method) Provide a custom method-level request condition.ExceptionHandlerExceptionResolver.getCustomReturnValueHandlers()
Return the custom return value handlers, ornull
.RequestMappingHandlerAdapter.getCustomReturnValueHandlers()
Return the custom return value handlers, ornull
.protected RequestCondition<?>
RequestMappingHandlerMapping.getCustomTypeCondition
(Class<?> handlerType) Provide a custom type-level request condition.protected ServletInvocableHandlerMethod
ExceptionHandlerExceptionResolver.getExceptionHandlerMethod
(HandlerMethod handlerMethod, Exception exception) Find an@ExceptionHandler
method for the given exception.RequestMappingHandlerMapping.getFileExtensions()
Deprecated.as of 5.2.4.RequestMappingHandlerAdapter.getInitBinderArgumentResolvers()
Return the argument resolvers for@InitBinder
methods, or possiblynull
if not initialized yet viaRequestMappingHandlerAdapter.afterPropertiesSet()
.protected RequestMappingInfo
RequestMappingHandlerMapping.getMappingForMethod
(Method method, Class<?> handlerType) Uses method and type-level @RequestMapping
annotations to create the RequestMappingInfo.ResponseBodyEmitter.DataWithMediaType.getMediaType()
protected MessageSource
ResponseEntityExceptionHandler.getMessageSource()
Get theMessageSource
that this exception handler uses.RequestMappingHandlerAdapter.getModelAndViewResolvers()
Return the configuredModelAndViewResolvers
, ornull
.String[]
ModelAndViewMethodReturnValueHandler.getRedirectPatterns()
Return the configured redirect patterns, if any.String[]
ViewNameMethodReturnValueHandler.getRedirectPatterns()
The configured redirect patterns, if any.protected String
ServletModelAttributeMethodProcessor.getRequestValueForAttribute
(String attributeName, NativeWebRequest request) Obtain a value from the request that may be used to instantiate the model attribute through type conversion from String to the target type.ExceptionHandlerExceptionResolver.getReturnValueHandlers()
Return the configured handlers, or possiblynull
if not initialized yet viaExceptionHandlerExceptionResolver.afterPropertiesSet()
.RequestMappingHandlerAdapter.getReturnValueHandlers()
Return the configured handlers, or possiblynull
if not initialized yet viaRequestMappingHandlerAdapter.afterPropertiesSet()
.ResponseBodyEmitter.getTimeout()
Return the configured timeout value, if any.RequestMappingHandlerAdapter.getWebBindingInitializer()
Return the configured WebBindingInitializer, ornull
if none.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleAsyncRequestTimeoutException
(AsyncRequestTimeoutException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofAsyncRequestTimeoutException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleBindException
(BindException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 sinceModelAttributeMethodProcessor
now raises theMethodArgumentNotValidException
subclass instead.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleConversionNotSupported
(ConversionNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofConversionNotSupportedException
.RequestBodyAdvice.handleEmptyBody
(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) Invoked second (and last) if the body is empty.RequestBodyAdviceAdapter.handleEmptyBody
(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) The default implementation returns the body that was passed in.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleErrorResponseException
(ErrorResponseException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling of anyErrorResponseException
.final ResponseEntity<Object>
ResponseEntityExceptionHandler.handleException
(Exception ex, WebRequest request) Handle all exceptions raised within Spring MVC handling of the request.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleExceptionInternal
(Exception ex, Object body, HttpHeaders headers, HttpStatusCode statusCode, WebRequest request) Internal handler method that all others in this class delegate to, for common handling, and for the creation of aResponseEntity
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleHandlerMethodValidationException
(HandlerMethodValidationException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofHandlerMethodValidationException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleHttpMediaTypeNotAcceptable
(HttpMediaTypeNotAcceptableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofHttpMediaTypeNotAcceptableException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleHttpMediaTypeNotSupported
(HttpMediaTypeNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofHttpMediaTypeNotSupportedException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleHttpMessageNotReadable
(HttpMessageNotReadableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofHttpMessageNotReadableException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleHttpMessageNotWritable
(HttpMessageNotWritableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofHttpMessageNotWritableException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleHttpRequestMethodNotSupported
(HttpRequestMethodNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofHttpRequestMethodNotSupportedException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleMethodArgumentNotValid
(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofMethodArgumentNotValidException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleMethodValidationException
(MethodValidationException ex, HttpHeaders headers, HttpStatus status, WebRequest request) Customize the handling ofMethodValidationException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleMissingPathVariable
(MissingPathVariableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofMissingPathVariableException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleMissingServletRequestParameter
(MissingServletRequestParameterException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofMissingServletRequestParameterException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleMissingServletRequestPart
(MissingServletRequestPartException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofMissingServletRequestPartException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleNoHandlerFoundException
(NoHandlerFoundException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofNoHandlerFoundException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleNoResourceFoundException
(NoResourceFoundException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofNoResourceFoundException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleServletRequestBindingException
(ServletRequestBindingException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofServletRequestBindingException
.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleTypeMismatch
(TypeMismatchException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) Customize the handling ofTypeMismatchException
.protected ModelAndView
RequestMappingHandlerAdapter.invokeHandlerMethod
(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) Invoke theRequestMapping
handler method preparing aModelAndView
if view resolution is required.protected <T> Object
AbstractMessageConverterMethodArgumentResolver.readWithMessageConverters
(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType) Create the method argument value of the expected parameter type by reading from the given HttpInputMessage.protected <T> Object
AbstractMessageConverterMethodArgumentResolver.readWithMessageConverters
(NativeWebRequest webRequest, MethodParameter parameter, Type paramType) Create the method argument value of the expected parameter type by reading from the given request.HttpEntityMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) MatrixVariableMapMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest request, WebDataBinderFactory binderFactory) RequestPartMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest request, WebDataBinderFactory binderFactory) protected Object
MatrixVariableMethodArgumentResolver.resolveName
(String name, MethodParameter parameter, NativeWebRequest request) protected Object
PathVariableMethodArgumentResolver.resolveName
(String name, MethodParameter parameter, NativeWebRequest request) protected Object
RequestAttributeMethodArgumentResolver.resolveName
(String name, MethodParameter parameter, NativeWebRequest request) protected Object
ServletCookieValueMethodArgumentResolver.resolveName
(String cookieName, MethodParameter parameter, NativeWebRequest webRequest) protected Object
SessionAttributeMethodArgumentResolver.resolveName
(String name, MethodParameter parameter, NativeWebRequest request) Modifier and TypeMethodDescriptionprotected Object
AbstractMessageConverterMethodArgumentResolver.adaptArgumentIfNecessary
(Object arg, MethodParameter parameter) Adapt the given argument against the method parameter, if necessary.final Object
AbstractMappingJacksonResponseBodyAdvice.beforeBodyWrite
(Object body, MethodParameter returnType, MediaType contentType, Class<? extends HttpMessageConverter<?>> converterType, ServerHttpRequest request, ServerHttpResponse response) ResponseBodyAdvice.beforeBodyWrite
(T body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) Invoked after anHttpMessageConverter
is selected and just before its write method is invoked.protected ServletRequestDataBinder
ServletRequestDataBinderFactory.createBinderInstance
(Object target, String objectName, NativeWebRequest request) Returns an instance ofExtendedServletRequestDataBinder
.protected ProblemDetail
ResponseEntityExceptionHandler.createProblemDetail
(Exception ex, HttpStatusCode status, String defaultDetail, String detailMessageCode, Object[] detailMessageArguments, WebRequest request) Convenience method to create aProblemDetail
for any exception that doesn't implementErrorResponse
, also performing aMessageSource
lookup for the "detail" field.protected ProblemDetail
ResponseEntityExceptionHandler.createProblemDetail
(Exception ex, HttpStatusCode status, String defaultDetail, String detailMessageCode, Object[] detailMessageArguments, WebRequest request) Convenience method to create aProblemDetail
for any exception that doesn't implementErrorResponse
, also performing aMessageSource
lookup for the "detail" field.protected RequestMappingInfo
RequestMappingHandlerMapping.createRequestMappingInfo
(RequestMapping requestMapping, RequestCondition<?> customCondition) Create aRequestMappingInfo
from the supplied@RequestMapping
annotation, or meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.protected RequestMappingInfo
RequestMappingHandlerMapping.createRequestMappingInfo
(HttpExchange httpExchange, RequestCondition<?> customCondition) Create aRequestMappingInfo
from the supplied@HttpExchange
annotation, or meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.createResponseEntity
(Object body, HttpHeaders headers, HttpStatusCode statusCode, WebRequest request) Create theResponseEntity
to use from the given body, headers, and statusCode.Add an SSE "data" line.protected ModelAndView
ExceptionHandlerExceptionResolver.doResolveHandlerMethodException
(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod, Exception exception) Find an@ExceptionHandler
method and invoke it to handle the raised exception.protected String
PathVariableMethodArgumentResolver.formatUriValue
(ConversionService cs, TypeDescriptor sourceType, Object value) protected String
PathVariableMethodArgumentResolver.formatUriValue
(ConversionService cs, TypeDescriptor sourceType, Object value) static UriComponentsBuilder
MvcUriComponentsBuilder.fromController
(UriComponentsBuilder builder, Class<?> controllerType) An alternative toMvcUriComponentsBuilder.fromController(Class)
that accepts aUriComponentsBuilder
representing the base URL.MvcUriComponentsBuilder.fromMappingName
(UriComponentsBuilder builder, String name) An alternative toMvcUriComponentsBuilder.fromMappingName(String)
that accepts aUriComponentsBuilder
representing the base URL.static UriComponentsBuilder
MvcUriComponentsBuilder.fromMethod
(UriComponentsBuilder baseUrl, Class<?> controllerType, Method method, Object... args) An alternative toMvcUriComponentsBuilder.fromMethod(Class, Method, Object...)
that accepts aUriComponentsBuilder
representing the base URL.protected ServletInvocableHandlerMethod
ExceptionHandlerExceptionResolver.getExceptionHandlerMethod
(HandlerMethod handlerMethod, Exception exception) Find an@ExceptionHandler
method for the given exception.AbstractMessageConverterMethodProcessor.getProducibleMediaTypes
(HttpServletRequest request, Class<?> valueClass, Type targetType) Returns the media types that can be produced.protected Class<?>
AbstractMessageConverterMethodProcessor.getReturnValueType
(Object value, MethodParameter returnType) Return the type of the value to be written to the response.protected Class<?>
HttpEntityMethodProcessor.getReturnValueType
(Object returnValue, MethodParameter returnType) RequestBodyAdvice.handleEmptyBody
(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) Invoked second (and last) if the body is empty.RequestBodyAdviceAdapter.handleEmptyBody
(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) The default implementation returns the body that was passed in.protected ResponseEntity<Object>
ResponseEntityExceptionHandler.handleExceptionInternal
(Exception ex, Object body, HttpHeaders headers, HttpStatusCode statusCode, WebRequest request) Internal handler method that all others in this class delegate to, for common handling, and for the creation of aResponseEntity
.protected void
PathVariableMethodArgumentResolver.handleResolvedValue
(Object arg, String name, MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest request) protected void
PathVariableMethodArgumentResolver.handleResolvedValue
(Object arg, String name, MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest request) void
AsyncTaskMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
CallableMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
DeferredResultMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
HttpEntityMethodProcessor.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
HttpHeadersReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
ModelAndViewMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
ModelAndViewResolverMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
RequestResponseBodyMethodProcessor.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
ResponseBodyEmitterReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
StreamingResponseBodyReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
ViewMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) void
ViewNameMethodReturnValueHandler.handleReturnValue
(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) protected boolean
AbstractMessageConverterMethodProcessor.isResourceType
(Object value, MethodParameter returnType) Return whether the returned value or the declared return type extendsResource
.ContinuationHandlerMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) ContinuationHandlerMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) HttpEntityMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) HttpEntityMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) MatrixVariableMapMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest request, WebDataBinderFactory binderFactory) MatrixVariableMapMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest request, WebDataBinderFactory binderFactory) PathVariableMapMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Return a Map with all URI template variables or an empty map.PathVariableMapMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Return a Map with all URI template variables or an empty map.PrincipalMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) PrincipalMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) RedirectAttributesMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) RedirectAttributesMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) RequestPartMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest request, WebDataBinderFactory binderFactory) RequestPartMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest request, WebDataBinderFactory binderFactory) RequestResponseBodyMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Throws MethodArgumentNotValidException if validation fails.RequestResponseBodyMethodProcessor.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Throws MethodArgumentNotValidException if validation fails.ServletRequestMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) ServletRequestMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) ServletResponseMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) SetModelAndViewContainer.setRequestHandled(boolean)
tofalse
to indicate that the method signature provides access to the response.ServletResponseMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) SetModelAndViewContainer.setRequestHandled(boolean)
tofalse
to indicate that the method signature provides access to the response.UriComponentsBuilderMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) UriComponentsBuilderMethodArgumentResolver.resolveArgument
(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) void
Overloaded variant ofResponseBodyEmitter.send(Object)
that also accepts a MediaType hint for how to serialize the given Object.void
Send the object formatted as a single SSE "data" line.void
ExceptionHandlerExceptionResolver.setApplicationContext
(ApplicationContext applicationContext) void
ExceptionHandlerExceptionResolver.setArgumentResolvers
(List<HandlerMethodArgumentResolver> argumentResolvers) Configure the complete list of supported argument types thus overriding the resolvers that would otherwise be configured by default.void
RequestMappingHandlerAdapter.setArgumentResolvers
(List<HandlerMethodArgumentResolver> argumentResolvers) Configure the complete list of supported argument types thus overriding the resolvers that would otherwise be configured by default.void
ExceptionHandlerExceptionResolver.setCustomArgumentResolvers
(List<HandlerMethodArgumentResolver> argumentResolvers) Provide resolvers for custom argument types.void
RequestMappingHandlerAdapter.setCustomArgumentResolvers
(List<HandlerMethodArgumentResolver> argumentResolvers) Provide resolvers for custom argument types.void
ExceptionHandlerExceptionResolver.setCustomReturnValueHandlers
(List<HandlerMethodReturnValueHandler> returnValueHandlers) Provide handlers for custom return value types.void
RequestMappingHandlerAdapter.setCustomReturnValueHandlers
(List<HandlerMethodReturnValueHandler> returnValueHandlers) Provide handlers for custom return value types.void
RequestMappingHandlerAdapter.setInitBinderArgumentResolvers
(List<HandlerMethodArgumentResolver> argumentResolvers) Configure the supported argument types in@InitBinder
methods.void
RequestMappingHandlerAdapter.setModelAndViewResolvers
(List<ModelAndViewResolver> modelAndViewResolvers) Provide customModelAndViewResolvers
.void
RequestMappingHandlerMapping.setPatternParser
(PathPatternParser patternParser) void
ModelAndViewMethodReturnValueHandler.setRedirectPatterns
(String... redirectPatterns) Configure one more simple patterns (as described inPatternMatchUtils.simpleMatch(java.lang.String, java.lang.String)
) to use in order to recognize custom redirect prefixes in addition to "redirect:".void
ViewNameMethodReturnValueHandler.setRedirectPatterns
(String... redirectPatterns) Configure one more simple patterns (as described inPatternMatchUtils.simpleMatch(java.lang.String, java.lang.String)
) to use in order to recognize custom redirect prefixes in addition to "redirect:".void
RequestMappingHandlerAdapter.setRequestBodyAdvice
(List<RequestBodyAdvice> requestBodyAdvice) Add one or moreRequestBodyAdvice
instances to intercept the request before it is read and converted for@RequestBody
andHttpEntity
method arguments.void
ExceptionHandlerExceptionResolver.setResponseBodyAdvice
(List<ResponseBodyAdvice<?>> responseBodyAdvice) Add one or more components to be invoked after the execution of a controller method annotated with@ResponseBody
or returningResponseEntity
but before the body is written to the response with the selectedHttpMessageConverter
.void
RequestMappingHandlerAdapter.setResponseBodyAdvice
(List<ResponseBodyAdvice<?>> responseBodyAdvice) Add one or moreResponseBodyAdvice
instances to intercept the response before@ResponseBody
orResponseEntity
return values are written to the response body.void
ExceptionHandlerExceptionResolver.setReturnValueHandlers
(List<HandlerMethodReturnValueHandler> returnValueHandlers) Configure the complete list of supported return value types thus overriding handlers that would otherwise be configured by default.void
RequestMappingHandlerAdapter.setReturnValueHandlers
(List<HandlerMethodReturnValueHandler> returnValueHandlers) Configure the complete list of supported return value types thus overriding handlers that would otherwise be configured by default.void
RequestMappingHandlerAdapter.setWebBindingInitializer
(WebBindingInitializer webBindingInitializer) Provide a WebBindingInitializer with "global" initialization to apply to every DataBinder instance.protected boolean
ExceptionHandlerExceptionResolver.shouldApplyTo
(HttpServletRequest request, Object handler) protected <T> void
AbstractMessageConverterMethodProcessor.writeWithMessageConverters
(T value, MethodParameter returnType, ServletServerHttpRequest inputMessage, ServletServerHttpResponse outputMessage) Writes the given return type to the given output message.ModifierConstructorDescriptionAbstractMessageConverterMethodArgumentResolver
(List<HttpMessageConverter<?>> converters, List<Object> requestResponseBodyAdvice) Constructor with converters andRequest~
andResponseBodyAdvice
.protected
AbstractMessageConverterMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager contentNegotiationManager) Constructor with list of converters and ContentNegotiationManager.protected
AbstractMessageConverterMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice) Constructor with list of converters and ContentNegotiationManager as well as request/response body advice instances.protected
AbstractMessageConverterMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice) Constructor with list of converters and ContentNegotiationManager as well as request/response body advice instances.AsyncTaskMethodReturnValueHandler
(BeanFactory beanFactory) DataWithMediaType
(Object data, MediaType mediaType) Create a new instance, with default object name.ExtendedServletRequestDataBinder
(Object target, String objectName) Create a new instance.HttpEntityMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice) Complete constructor for resolvingHttpEntity
and handlingResponseEntity
.MethodArgumentBuilder
(UriComponentsBuilder baseUrl, Class<?> controllerType, Method method) Create a newMvcUriComponentsBuilder.MethodArgumentBuilder
instance.ModelAndViewResolverMethodReturnValueHandler
(List<ModelAndViewResolver> mavResolvers) Create a new instance.RequestResponseBodyMethodProcessor
(List<HttpMessageConverter<?>> converters, List<Object> requestResponseBodyAdvice) Complete constructor for resolving@RequestBody
method arguments.RequestResponseBodyMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager) Basic constructor with converters andContentNegotiationManager
.RequestResponseBodyMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice) Complete constructor for resolving@RequestBody
and handling@ResponseBody
.RequestResponseBodyMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice) Complete constructor for resolving@RequestBody
and handling@ResponseBody
.ServletInvocableHandlerMethod
(Object handler, Method method, MessageSource messageSource) Variant ofServletInvocableHandlerMethod(Object, Method)
that also accepts aMessageSource
, e.g.ServletRequestDataBinderFactory
(List<InvocableHandlerMethod> binderMethods, WebBindingInitializer initializer) Create a new instance.ServletRequestDataBinderFactory
(List<InvocableHandlerMethod> binderMethods, WebBindingInitializer initializer) Create a new instance. -
Uses of Nullable in org.springframework.web.servlet.mvc.support
Modifier and TypeMethodDescriptionprotected ModelAndView
DefaultHandlerExceptionResolver.doResolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) protected ModelAndView
DefaultHandlerExceptionResolver.handleAsyncRequestTimeoutException
(AsyncRequestTimeoutException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where an async request timed out.protected ModelAndView
DefaultHandlerExceptionResolver.handleHandlerMethodValidationException
(HandlerMethodValidationException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where method validation for a controller method failed.protected ModelAndView
DefaultHandlerExceptionResolver.handleHttpMediaTypeNotAcceptable
(HttpMediaTypeNotAcceptableException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where no message converters were found that were acceptable for the client (expressed via theAccept
header).protected ModelAndView
DefaultHandlerExceptionResolver.handleHttpMediaTypeNotSupported
(HttpMediaTypeNotSupportedException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where no message converters were found for PUT or POSTed content.protected ModelAndView
DefaultHandlerExceptionResolver.handleHttpRequestMethodNotSupported
(HttpRequestMethodNotSupportedException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where no handler was found for the HTTP method.protected ModelAndView
DefaultHandlerExceptionResolver.handleMethodArgumentNotValidException
(MethodArgumentNotValidException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where an argument annotated with@Valid
such as anRequestBody
orRequestPart
argument fails validation.protected ModelAndView
DefaultHandlerExceptionResolver.handleMissingPathVariable
(MissingPathVariableException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case when a declared path variable does not match any extracted URI variable.protected ModelAndView
DefaultHandlerExceptionResolver.handleMissingServletRequestParameter
(MissingServletRequestParameterException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case when a required parameter is missing.protected ModelAndView
DefaultHandlerExceptionResolver.handleMissingServletRequestPartException
(MissingServletRequestPartException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where an @RequestPart, aMultipartFile
, or ajakarta.servlet.http.Part
argument is required but is missing.protected ModelAndView
DefaultHandlerExceptionResolver.handleNoHandlerFoundException
(NoHandlerFoundException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where no handler was found during the dispatch.protected ModelAndView
DefaultHandlerExceptionResolver.handleNoResourceFoundException
(NoResourceFoundException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where no static resource was found.protected ModelAndView
DefaultHandlerExceptionResolver.handleServletRequestBindingException
(ServletRequestBindingException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case when an unrecoverable binding exception occurs - e.g.Modifier and TypeMethodDescriptionRedirectAttributesModelMap.addAllAttributes
(Collection<?> attributeValues) Copy all attributes in the suppliedCollection
into thisMap
, using attribute name generation for each element.RedirectAttributesModelMap.addAllAttributes
(Map<String, ?> attributes) Copy all attributes in the suppliedMap
into thisMap
.RedirectAttributes.addAttribute
(String attributeName, Object attributeValue) RedirectAttributesModelMap.addAttribute
(String attributeName, Object attributeValue) Add the supplied attribute under the supplied name.RedirectAttributes.addFlashAttribute
(String attributeName, Object attributeValue) Add the given flash attribute.RedirectAttributesModelMap.addFlashAttribute
(String attributeName, Object attributeValue) protected ModelAndView
DefaultHandlerExceptionResolver.doResolveException
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) protected ModelAndView
DefaultHandlerExceptionResolver.handleAsyncRequestTimeoutException
(AsyncRequestTimeoutException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where an async request timed out.protected ModelAndView
DefaultHandlerExceptionResolver.handleBindException
(BindException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0 sinceModelAttributeMethodProcessor
now raises theMethodArgumentNotValidException
subclass instead.protected ModelAndView
DefaultHandlerExceptionResolver.handleConversionNotSupported
(ConversionNotSupportedException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case when aWebDataBinder
conversion cannot occur.protected ModelAndView
DefaultHandlerExceptionResolver.handleErrorResponse
(ErrorResponse errorResponse, HttpServletRequest request, HttpServletResponse response, Object handler) Handle anErrorResponse
exception.protected ModelAndView
DefaultHandlerExceptionResolver.handleHandlerMethodValidationException
(HandlerMethodValidationException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where method validation for a controller method failed.protected ModelAndView
DefaultHandlerExceptionResolver.handleHttpMediaTypeNotAcceptable
(HttpMediaTypeNotAcceptableException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where no message converters were found that were acceptable for the client (expressed via theAccept
header).protected ModelAndView
DefaultHandlerExceptionResolver.handleHttpMediaTypeNotSupported
(HttpMediaTypeNotSupportedException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where no message converters were found for PUT or POSTed content.protected ModelAndView
DefaultHandlerExceptionResolver.handleHttpMessageNotReadable
(HttpMessageNotReadableException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where a message converter cannot read from an HTTP request.protected ModelAndView
DefaultHandlerExceptionResolver.handleHttpMessageNotWritable
(HttpMessageNotWritableException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where a message converter cannot write to an HTTP request.protected ModelAndView
DefaultHandlerExceptionResolver.handleHttpRequestMethodNotSupported
(HttpRequestMethodNotSupportedException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where no handler was found for the HTTP method.protected ModelAndView
DefaultHandlerExceptionResolver.handleMethodArgumentNotValidException
(MethodArgumentNotValidException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where an argument annotated with@Valid
such as anRequestBody
orRequestPart
argument fails validation.protected ModelAndView
DefaultHandlerExceptionResolver.handleMethodValidationException
(MethodValidationException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where method validation failed on a component that is not a web controller, e.g.protected ModelAndView
DefaultHandlerExceptionResolver.handleMissingPathVariable
(MissingPathVariableException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case when a declared path variable does not match any extracted URI variable.protected ModelAndView
DefaultHandlerExceptionResolver.handleMissingServletRequestParameter
(MissingServletRequestParameterException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case when a required parameter is missing.protected ModelAndView
DefaultHandlerExceptionResolver.handleMissingServletRequestPartException
(MissingServletRequestPartException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where an @RequestPart, aMultipartFile
, or ajakarta.servlet.http.Part
argument is required but is missing.protected ModelAndView
DefaultHandlerExceptionResolver.handleNoHandlerFoundException
(NoHandlerFoundException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where no handler was found during the dispatch.protected ModelAndView
DefaultHandlerExceptionResolver.handleNoResourceFoundException
(NoResourceFoundException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case where no static resource was found.protected ModelAndView
DefaultHandlerExceptionResolver.handleServletRequestBindingException
(ServletRequestBindingException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case when an unrecoverable binding exception occurs - e.g.protected ModelAndView
DefaultHandlerExceptionResolver.handleTypeMismatch
(TypeMismatchException ex, HttpServletRequest request, HttpServletResponse response, Object handler) Handle the case when aWebDataBinder
conversion error occurs.RedirectAttributesModelMap.mergeAttributes
(Map<String, ?> attributes) Copy all attributes in the suppliedMap
into thisMap
, with existing objects of the same name taking precedence (i.e.void
ModifierConstructorDescriptionRedirectAttributesModelMap
(DataBinder dataBinder) Constructor with a DataBinder. -
Uses of Nullable in org.springframework.web.servlet.resource
Modifier and TypeMethodDescriptionAbstractVersionStrategy.extractVersion
(String requestPath) AbstractVersionStrategy.FileNameVersionPathStrategy.extractVersion
(String requestPath) AbstractVersionStrategy.PrefixVersionPathStrategy.extractVersion
(String requestPath) VersionPathStrategy.extractVersion
(String requestPath) Extract the resource version from the request path.protected String
WebJarsResourceResolver.findWebJarResourcePath
(String path) Resource[]
PathResourceResolver.getAllowedLocations()
ResourceHttpRequestHandler.getContentNegotiationManager()
Deprecated.as of 5.2.4ResourceHttpRequestHandler.getCorsConfiguration
(HttpServletRequest request) Return the specified CORS configuration.TransformedResource.getFilename()
final String
ResourceUrlProvider.getForLookupPath
(String lookupPath) Compare the given path against configured resource handler mappings and if a match is found use theResourceResolver
chain of the matchedResourceHttpRequestHandler
to resolve the URL path to expose for public use.final String
ResourceUrlProvider.getForRequestUrl
(HttpServletRequest request, String requestUrl) A variation onResourceUrlProvider.getForLookupPath(String)
that accepts a full request URL path (i.e.protected MediaType
ResourceHttpRequestHandler.getMediaType
(HttpServletRequest request, Resource resource) Determine the media type for the given request and the resource matched to it.protected Resource
PathResourceResolver.getResource
(String resourcePath, Resource location) Find the resource under the given location.protected Resource
ResourceHttpRequestHandler.getResource
(HttpServletRequest request) ResourceHttpRequestHandler.getResourceHttpMessageConverter()
Return the configured resource converter.ResourceHttpRequestHandler.getResourceRegionHttpMessageConverter()
Return the configured resource region converter.ResourceTransformerSupport.getResourceUrlProvider()
Return the configuredResourceUrlProvider
.protected VersionStrategy
VersionResourceResolver.getStrategyForPath
(String requestPath) Find aVersionStrategy
for the request path of the requested resource.PathResourceResolver.getUrlPathHelper()
The configuredUrlPathHelper
.ResourceHttpRequestHandler.getUrlPathHelper()
The configuredUrlPathHelper
.protected PathExtensionContentNegotiationStrategy
ResourceHttpRequestHandler.initContentNegotiationStrategy()
Deprecated.as of 5.2.4 this method returnsnull
, and if a subclass returns an actual instance, the instance is used only as a source of media type mappings, if it contains any.AbstractResourceResolver.resolveResource
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) ResourceResolver.resolveResource
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) Resolve the supplied request and request path to aResource
that exists under one of the given resource locations.ResourceResolverChain.resolveResource
(HttpServletRequest request, String requestPath, List<? extends Resource> locations) Resolve the supplied request and request path to aResource
that exists under one of the given resource locations.protected abstract Resource
AbstractResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected Resource
CachingResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected Resource
EncodedResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected Resource
PathResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected Resource
VersionResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected Resource
WebJarsResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) AbstractResourceResolver.resolveUrlPath
(String resourceUrlPath, List<? extends Resource> locations, ResourceResolverChain chain) ResourceResolver.resolveUrlPath
(String resourcePath, List<? extends Resource> locations, ResourceResolverChain chain) Resolve the externally facing public URL path for clients to use to access the resource that is located at the given internal resource path.ResourceResolverChain.resolveUrlPath
(String resourcePath, List<? extends Resource> locations) Resolve the externally facing public URL path for clients to use to access the resource that is located at the given internal resource path.protected String
ResourceTransformerSupport.resolveUrlPath
(String resourcePath, HttpServletRequest request, Resource resource, ResourceTransformerChain transformerChain) A transformer can use this method when a resource being transformed contains links to other resources.protected abstract String
AbstractResourceResolver.resolveUrlPathInternal
(String resourceUrlPath, List<? extends Resource> locations, ResourceResolverChain chain) protected String
CachingResourceResolver.resolveUrlPathInternal
(String resourceUrlPath, List<? extends Resource> locations, ResourceResolverChain chain) protected String
EncodedResourceResolver.resolveUrlPathInternal
(String resourceUrlPath, List<? extends Resource> locations, ResourceResolverChain chain) protected String
PathResourceResolver.resolveUrlPathInternal
(String resourcePath, List<? extends Resource> locations, ResourceResolverChain chain) protected String
VersionResourceResolver.resolveUrlPathInternal
(String resourceUrlPath, List<? extends Resource> locations, ResourceResolverChain chain) protected String
WebJarsResourceResolver.resolveUrlPathInternal
(String resourceUrlPath, List<? extends Resource> locations, ResourceResolverChain chain) Modifier and TypeMethodDescriptionprotected String
CachingResourceResolver.computeKey
(HttpServletRequest request, String requestPath) AbstractResourceResolver.resolveResource
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) ResourceResolver.resolveResource
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) Resolve the supplied request and request path to aResource
that exists under one of the given resource locations.ResourceResolverChain.resolveResource
(HttpServletRequest request, String requestPath, List<? extends Resource> locations) Resolve the supplied request and request path to aResource
that exists under one of the given resource locations.protected abstract Resource
AbstractResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected Resource
CachingResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected Resource
EncodedResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected Resource
PathResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected Resource
VersionResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) protected Resource
WebJarsResourceResolver.resolveResourceInternal
(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) void
PathResourceResolver.setAllowedLocations
(Resource... locations) By default, when a Resource is found, the path of the resolved resource is compared to ensure it's under the input location where it was found.void
ResourceHttpRequestHandler.setContentNegotiationManager
(ContentNegotiationManager contentNegotiationManager) Deprecated.as of 5.2.4 in favor of usingResourceHttpRequestHandler.setMediaTypes(Map)
with mappings possibly obtained fromContentNegotiationManager.getMediaTypeMappings()
.void
ResourceUrlProvider.setHandlerMap
(Map<String, ResourceHttpRequestHandler> handlerMap) Manually configure the resource mappings.protected void
ResourceHttpRequestHandler.setHeaders
(HttpServletResponse response, Resource resource, MediaType mediaType) Set headers on the given servlet response.void
ResourceHttpRequestHandler.setResourceHttpMessageConverter
(ResourceHttpMessageConverter messageConverter) Configure theResourceHttpMessageConverter
to use.void
ResourceHttpRequestHandler.setResourceRegionHttpMessageConverter
(ResourceRegionHttpMessageConverter messageConverter) Configure theResourceRegionHttpMessageConverter
to use.void
ResourceHttpRequestHandler.setResourceResolvers
(List<ResourceResolver> resourceResolvers) Configure the list ofResourceResolvers
to use.void
ResourceHttpRequestHandler.setResourceTransformers
(List<ResourceTransformer> resourceTransformers) Configure the list ofResourceTransformers
to use.void
ResourceTransformerSupport.setResourceUrlProvider
(ResourceUrlProvider resourceUrlProvider) Configure aResourceUrlProvider
to use when resolving the public URL of links in a transformed resource (e.g.void
PathResourceResolver.setUrlPathHelper
(UrlPathHelper urlPathHelper) Provide a reference to theUrlPathHelper
used to map requests to static resources.void
ResourceHttpRequestHandler.setUrlPathHelper
(UrlPathHelper urlPathHelper) Provide a reference to theUrlPathHelper
used to map requests to static resources. -
Uses of Nullable in org.springframework.web.servlet.support
Modifier and TypeMethodDescriptionprotected WebApplicationContext
AbstractAnnotationConfigDispatcherServletInitializer.createRootApplicationContext()
Create the "root" application context to be provided to theContextLoaderListener
.BindStatus.findEditor
(Class<?> valueClass) Find a PropertyEditor for the given value class, associated with the property that this bound status is currently bound to.static WebApplicationContext
RequestContextUtils.findWebApplicationContext
(HttpServletRequest request) Look for the WebApplicationContext associated with the DispatcherServlet that has initiated request processing, and for the global context if none was found associated with the current request.static WebApplicationContext
RequestContextUtils.findWebApplicationContext
(HttpServletRequest request, ServletContext servletContext) Look for the WebApplicationContext associated with the DispatcherServlet that has initiated request processing, and for the global context if none was found associated with the current request.BindStatus.getActualValue()
Return the actual value of the field, i.e.protected String
WebContentGenerator.getAllowHeader()
Return the "Allow" header value to use in response to an HTTP OPTIONS request based on the configuredsupported methods
also automatically adding "OPTIONS" to the list even if not present as a supported method.final CacheControl
WebContentGenerator.getCacheControl()
Get theCacheControl
instance that builds the Cache-Control HTTP response header.RequestContext.getDefaultHtmlEscape()
Return the default HTML escape setting, differentiating between no default specified and an explicit value.BindStatus.getEditor()
Return the PropertyEditor for the property that this bind status is currently bound to.BindStatus.getErrors()
Return the Errors instance (typically a BindingResult) that this bind status is currently associated with.Retrieve the Errors instance for the given bind object, using the "defaultHtmlEscape" setting.Retrieve the Errors instance for the given bind object.BindStatus.getExpression()
Return a bind expression that can be used in HTML forms as input name for the respective field, ornull
if not field-specific.RequestDataValueProcessor.getExtraHiddenFields
(HttpServletRequest request) Invoked after all form fields have been rendered.protected TimeZone
RequestContext.getFallbackTimeZone()
Determine the fallback time zone for this context.static FlashMapManager
RequestContextUtils.getFlashMapManager
(HttpServletRequest request) Return theFlashMapManager
instance to save flash attributes.protected Object
AbstractFlashMapManager.getFlashMapsMutex
(HttpServletRequest request) Obtain a mutex for modifying the FlashMap List as handled byAbstractFlashMapManager.retrieveFlashMaps(jakarta.servlet.http.HttpServletRequest)
andAbstractFlashMapManager.updateFlashMaps(java.util.List<org.springframework.web.servlet.FlashMap>, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
,RequestContextUtils.getInputFlashMap
(HttpServletRequest request) Return read-only "input" flash attributes from request before redirect.static LocaleResolver
RequestContextUtils.getLocaleResolver
(HttpServletRequest request) Return theLocaleResolver
that has been bound to the request by theDispatcherServlet
.RequestContext.getModel()
Return the model Map that this RequestContext encapsulates, if any.protected Object
RequestContext.getModelObject
(String modelName) Retrieve the model object for the given model name, either from the model or from the request attributes.RequestContext.getRequestDataValueProcessor()
Return the RequestDataValueProcessor instance to use obtained from the WebApplicationContext under the name"requestDataValueProcessor"
.RequestContext.getResponseEncodedHtmlEscape()
Return the default setting about use of response encoding for HTML escape setting, differentiating between no default specified and an explicit value.protected abstract Class<?>[]
AbstractAnnotationConfigDispatcherServletInitializer.getRootConfigClasses()
protected ApplicationContextInitializer<?>[]
AbstractDispatcherServletInitializer.getServletApplicationContextInitializers()
Specify application context initializers to be applied to the servlet-specific application context that theDispatcherServlet
is being created with.protected abstract Class<?>[]
AbstractAnnotationConfigDispatcherServletInitializer.getServletConfigClasses()
protected final ServletContext
RequestContext.getServletContext()
Return the underlying ServletContext.protected Filter[]
AbstractDispatcherServletInitializer.getServletFilters()
Specify filters to add and map to theDispatcherServlet
.final String[]
WebContentGenerator.getSupportedMethods()
Return the HTTP methods that this content generator supports.static Theme
RequestContextUtils.getTheme
(HttpServletRequest request) Deprecated.as of 6.0, with no direct replacementstatic ThemeResolver
RequestContextUtils.getThemeResolver
(HttpServletRequest request) Deprecated.as of 6.0, with no direct replacementstatic ThemeSource
RequestContextUtils.getThemeSource
(HttpServletRequest request) Deprecated.as of 6.0, with no direct replacementRequestContext.getTimeZone()
Return the current TimeZone (ornull
if none derivable from the request).static TimeZone
RequestContextUtils.getTimeZone
(HttpServletRequest request) Retrieve the current time zone from the given request, using theTimeZoneAwareLocaleContext
in theLocaleResolver
bound to the request by theDispatcherServlet
(if available).BindStatus.getValue()
Return the current value of the field, i.e.Class<?>
BindStatus.getValueType()
Get the 'Class
' type of the field.final String[]
WebContentGenerator.getVaryByRequestHeaders()
Return the configured request header names for the "Vary" response header.ServletUriComponentsBuilder.removePathExtension()
Remove any path extension from therequestURI
.final FlashMap
AbstractFlashMapManager.retrieveAndUpdate
(HttpServletRequest request, HttpServletResponse response) AbstractFlashMapManager.retrieveFlashMaps
(HttpServletRequest request) Retrieve saved FlashMap instances from the underlying storage.SessionFlashMapManager.retrieveFlashMaps
(HttpServletRequest request) Retrieves saved FlashMap instances from the HTTP session, if any.Modifier and TypeMethodDescriptionvoid
RequestContext.changeTheme
(Theme theme) Deprecated.as of 6.0, with no direct replacementstatic void
JstlUtils.exposeLocalizationContext
(HttpServletRequest request, MessageSource messageSource) Exposes JSTL-specific request attributes specifying locale and resource bundle for JSTL's formatting and message tags, using Spring's locale and MessageSource.static WebApplicationContext
RequestContextUtils.findWebApplicationContext
(HttpServletRequest request, ServletContext servletContext) Look for the WebApplicationContext associated with the DispatcherServlet that has initiated request processing, and for the global context if none was found associated with the current request.static MessageSource
JstlUtils.getJstlAwareMessageSource
(ServletContext servletContext, MessageSource messageSource) Checks JSTL's "jakarta.servlet.jsp.jstl.fmt.localizationContext" context-param and creates a corresponding child message source, with the provided Spring-defined MessageSource as parent.RequestContext.getMessage
(String code, Object[] args) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.RequestContext.getMessage
(String code, Object[] args, boolean htmlEscape) Retrieve the message for the given code.RequestContext.getMessage
(String code, Object[] args, String defaultMessage) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.RequestContext.getMessage
(String code, Object[] args, String defaultMessage, boolean htmlEscape) Retrieve the message for the given code.RequestContext.getMessage
(String code, List<?> args) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.RequestContext.getMessage
(String code, List<?> args, String defaultMessage) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.RequestContext.getThemeMessage
(String code, Object[] args) Deprecated.as of 6.0, with no direct replacementRequestContext.getThemeMessage
(String code, Object[] args, String defaultMessage) Deprecated.as of 6.0, with no direct replacementRequestContext.getThemeMessage
(String code, List<?> args) Deprecated.as of 6.0, with no direct replacementRequestContext.getThemeMessage
(String code, List<?> args, String defaultMessage) Deprecated.as of 6.0, with no direct replacementRequestDataValueProcessor.processFormFieldValue
(HttpServletRequest request, String name, String value, String type) Invoked when a form field value is rendered.final void
WebContentGenerator.setCacheControl
(CacheControl cacheControl) Set theCacheControl
instance to build the Cache-Control HTTP response header.final void
WebContentGenerator.setSupportedMethods
(String... methods) Set the HTTP methods that this content generator should support.final void
WebContentGenerator.setVaryByRequestHeaders
(String... varyByRequestHeaders) Configure one or more request header names (e.g.ModifierConstructorDescriptionJspAwareRequestContext
(PageContext pageContext, Map<String, Object> model) Create a new JspAwareRequestContext for the given page context, using the given model attributes for Errors retrieval.RequestContext
(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext, Map<String, Object> model) Create a new RequestContext for the given request, using the given model attributes for Errors retrieval.RequestContext
(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext, Map<String, Object> model) Create a new RequestContext for the given request, using the given model attributes for Errors retrieval.RequestContext
(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext, Map<String, Object> model) Create a new RequestContext for the given request, using the given model attributes for Errors retrieval.RequestContext
(HttpServletRequest request, ServletContext servletContext) Create a new RequestContext for the given request, using the request attributes for Errors retrieval.RequestContext
(HttpServletRequest request, Map<String, Object> model) Create a new RequestContext for the given request, using the given model attributes for Errors retrieval. -
Uses of Nullable in org.springframework.web.servlet.tags
Modifier and TypeMethodDescriptionfinal PropertyEditor
BindTag.getEditor()
EditorAwareTag.getEditor()
Retrieve the PropertyEditor for the property that this tag is currently bound to.final Errors
BindErrorsTag.getErrors()
Retrieve the Errors instance that this tag is currently bound to.final Errors
BindTag.getErrors()
Retrieve the Errors instance that this tag is currently bound to.Param.getName()
Return the raw parameter name.NestedPathTag.getPath()
Return the path that this tag applies to.final String
BindTag.getProperty()
Retrieve the property that this tag is currently bound to, ornull
if bound to an object rather than a specific property.Param.getValue()
Return the raw parameter value.protected Object[]
MessageTag.resolveArguments
(Object arguments) Resolve the given arguments Object into an arguments array.Modifier and TypeMethodDescriptionvoid
ArgumentAware.addArgument
(Object argument) Callback hook for nested spring:argument tags to pass their value to the parent tag.void
MessageTag.addArgument
(Object argument) protected Object[]
MessageTag.resolveArguments
(Object arguments) Resolve the given arguments Object into an arguments array.void
Set the raw name of the parameter.void
Set the path that this tag should apply.void
Set the raw value of the parameter. -
Uses of Nullable in org.springframework.web.servlet.tags.form
Modifier and TypeMethodDescriptionprotected String
AbstractCheckedElementTag.autogenerateId()
Return a unique ID for the bound name within the current PageContext.protected String
AbstractDataBoundFormElementTag.autogenerateId()
Autogenerate the 'id
' attribute value for this tag.protected Object
Evaluate the supplied value for the supplied attribute name.protected String
FormTag.getAcceptCharset()
Get the value of the 'acceptCharset
' attribute.protected String
AbstractHtmlInputElementTag.getAccesskey()
Get the value of the 'accesskey
' attribute.protected String
FormTag.getAction()
Get the value of the 'action
' attribute.protected String
InputTag.getAlt()
Get the value of the 'alt
' attribute.protected String
FormTag.getAutocomplete()
Get the value of the 'autocomplete
' attribute.protected String
InputTag.getAutocomplete()
Get the value of the 'autocomplete
' attribute.protected final Object
AbstractDataBoundFormElementTag.getBoundValue()
Get the bound value.protected String
TextareaTag.getCols()
Get the value of the 'cols
' attribute.protected String
AbstractHtmlElementTag.getCssClass()
Get the value of the 'class
' attribute.protected String
AbstractHtmlElementTag.getCssErrorClass()
The CSS class to use when the field bound to a particular tag has errors.protected String
AbstractHtmlElementTag.getCssStyle()
Get the value of the 'style
' attribute.AbstractMultiCheckedElementTag.getDelimiter()
Return the delimiter to be used between each 'input type="radio"
' tag.protected String
AbstractHtmlElementTag.getDir()
Get the value of the 'dir
' attribute.AbstractHtmlElementTag.getDynamicAttributes()
Get the map of dynamic attributes.final PropertyEditor
AbstractDataBoundFormElementTag.getEditor()
Exposes thePropertyEditor
forEditorAwareTag
.protected String
FormTag.getEnctype()
Get the value of the 'enctype
' attribute.protected String
LabelTag.getFor()
Get the value of the 'id
' attribute.AbstractDataBoundFormElementTag.getId()
Get the value of the 'id
' attribute.protected String
AbstractMultiCheckedElementTag.getItemLabel()
Get the value to be displayed as part of the 'input type="checkbox/radio"
' tag.protected String
OptionsTag.getItemLabel()
Get the name of the property mapped to the label (inner text) of the 'option
' tag.protected String
SelectTag.getItemLabel()
Get the value of the 'itemLabel
' attribute.protected Object
AbstractMultiCheckedElementTag.getItems()
Get theCollection
,Map
or array of objects used to generate the 'input type="checkbox/radio"
' tags.protected Object
OptionsTag.getItems()
protected Object
SelectTag.getItems()
Get the value of the 'items
' attribute.protected String
AbstractMultiCheckedElementTag.getItemValue()
Get the name of the property mapped to the 'value
' attribute of the 'input type="checkbox/radio"
' tag.protected String
OptionsTag.getItemValue()
Return the name of the property mapped to the 'value
' attribute of the 'option
' tag.protected String
SelectTag.getItemValue()
Get the value of the 'itemValue
' attribute.protected Object
AbstractSingleCheckedElementTag.getLabel()
Get the value of the 'label
' attribute.protected String
OptionTag.getLabel()
Get the text body of the rendered HTML<option>
tag.protected String
AbstractHtmlElementTag.getLang()
Get the value of the 'lang
' attribute.protected String
InputTag.getMaxlength()
Get the value of the 'maxlength
' attribute.protected Object
SelectTag.getMultiple()
Get the value of the HTML 'multiple
' attribute rendered on the final 'select
' element.protected String
AbstractDataBoundFormElementTag.getName()
Get the value for the HTML 'name
' attribute.ButtonTag.getName()
Set the value of the 'name
' attribute.protected String
ErrorsTag.getName()
Get the value for the HTML 'name
' attribute.protected String
FormTag.getName()
Get the value of the 'name
' attribute.protected String
LabelTag.getName()
Overrides#getName()
to always returnnull
, because the 'name
' attribute is not supported by the 'label
' tag.protected String
AbstractDataBoundFormElementTag.getNestedPath()
Get the value of the nested path that may have been exposed by theNestedPathTag
.protected String
AbstractHtmlInputElementTag.getOnblur()
Get the value of the 'onblur
' attribute.protected String
AbstractHtmlInputElementTag.getOnchange()
Get the value of the 'onchange
' attribute.protected String
AbstractHtmlElementTag.getOnclick()
Get the value of the 'onclick
' attribute.protected String
AbstractHtmlElementTag.getOndblclick()
Get the value of the 'ondblclick
' attribute.protected String
AbstractHtmlInputElementTag.getOnfocus()
Get the value of the 'onfocus
' attribute.protected String
AbstractHtmlElementTag.getOnkeydown()
Get the value of the 'onkeydown
' attribute.protected String
AbstractHtmlElementTag.getOnkeypress()
Get the value of the 'onkeypress
' attribute.protected String
AbstractHtmlElementTag.getOnkeyup()
Get the value of the 'onkeyup
' attribute.protected String
AbstractHtmlElementTag.getOnmousedown()
Get the value of the 'onmousedown
' attribute.protected String
AbstractHtmlElementTag.getOnmousemove()
Get the value of the 'onmousemove
' attribute.protected String
AbstractHtmlElementTag.getOnmouseout()
Get the value of the 'onmouseout
' attribute.protected String
AbstractHtmlElementTag.getOnmouseover()
Get the value of the 'onmouseover
' attribute.protected String
AbstractHtmlElementTag.getOnmouseup()
Get the value of the 'onmouseup
' attribute.protected String
FormTag.getOnreset()
Get the value of the 'onreset
' attribute.protected String
InputTag.getOnselect()
Get the value of the 'onselect
' attribute.protected String
TextareaTag.getOnselect()
Get the value of the 'onselect
' attribute.protected String
FormTag.getOnsubmit()
Get the value of the 'onsubmit
' attribute.protected PropertyEditor
AbstractDataBoundFormElementTag.getPropertyEditor()
Get thePropertyEditor
, if any, in use for value bound to this tag.protected String
TextareaTag.getRows()
Get the value of the 'rows
' attribute.protected String
FormTag.getServletRelativeAction()
Get the servlet-relative value of the 'action
' attribute.protected String
InputTag.getSize()
Get the value of the 'size
' attribute.protected String
SelectTag.getSize()
Get the value of the 'size
' attribute.protected String
AbstractHtmlElementTag.getTabindex()
Get the value of the 'tabindex
' attribute.FormTag.getTarget()
Get the value of the 'target
' attribute.protected String
AbstractHtmlElementTag.getTitle()
Get the value of the 'title
' attribute.protected Object
AbstractSingleCheckedElementTag.getValue()
Get the value of the 'value
' attribute.ButtonTag.getValue()
Get the value of the 'value
' attribute.protected Object
OptionTag.getValue()
Get the 'value' attribute of the rendered HTML<option>
tag.protected String
AbstractDataBoundFormElementTag.resolveId()
Determine the 'id
' attribute value for this tag, autogenerating one if none specified.Modifier and TypeMethodDescriptionprotected String
AbstractDataBoundFormElementTag.convertToDisplayString
(Object value) Get a display String for the given value, converted by a PropertyEditor that the BindStatus may have registered for the value's Class.protected Object
Evaluate the supplied value for the supplied attribute name.protected String
AbstractFormTag.getDisplayString
(Object value) Get the display value of the suppliedObject
, HTML escaped as required.protected String
AbstractFormTag.getDisplayString
(Object value, PropertyEditor propertyEditor) Get the display value of the suppliedObject
, HTML escaped as required.protected String
AbstractFormTag.getDisplayString
(Object value, PropertyEditor propertyEditor) Get the display value of the suppliedObject
, HTML escaped as required.protected final String
AbstractDataBoundFormElementTag.processFieldValue
(String name, String value, String type) Process the given form field through aRequestDataValueProcessor
instance if one is configured or otherwise returns the same value.protected void
AbstractCheckedElementTag.renderFromValue
(Object item, Object value, TagWriter tagWriter) Render the 'input(checkbox)
' with the supplied value, marking the 'input
' element as 'checked' if the supplied value matches the bound value.protected void
AbstractCheckedElementTag.renderFromValue
(Object item, Object value, TagWriter tagWriter) Render the 'input(checkbox)
' with the supplied value, marking the 'input
' element as 'checked' if the supplied value matches the bound value.protected void
AbstractCheckedElementTag.renderFromValue
(Object value, TagWriter tagWriter) Render the 'input(checkbox)
' with the supplied value, marking the 'input
' element as 'checked' if the supplied value matches the bound value.void
Set the value of the 'action
' attribute.void
Set the value of the 'id
' attribute.void
void
FormTag.setServletRelativeAction
(String servletRelativeAction) Set the value of the 'action
' attribute through a value that is to be appended to the current servlet path.void
Set the value of the 'value
' attribute.protected final void
AbstractFormTag.writeOptionalAttribute
(TagWriter tagWriter, String attributeName, String value) Optionally writes the supplied value under the supplied attribute name into the suppliedTagWriter
.void
TagWriter.writeOptionalAttributeValue
(String attributeName, String attributeValue) Write an HTML attribute if the supplied value is notnull
or zero length. -
Uses of Nullable in org.springframework.web.servlet.theme
Modifier and TypeMethodDescriptionvoid
CookieThemeResolver.setThemeName
(HttpServletRequest request, HttpServletResponse response, String themeName) Deprecated.void
CookieThemeResolver.setThemeName
(HttpServletRequest request, HttpServletResponse response, String themeName) Deprecated.void
FixedThemeResolver.setThemeName
(HttpServletRequest request, HttpServletResponse response, String themeName) Deprecated.void
FixedThemeResolver.setThemeName
(HttpServletRequest request, HttpServletResponse response, String themeName) Deprecated.void
SessionThemeResolver.setThemeName
(HttpServletRequest request, HttpServletResponse response, String themeName) Deprecated.void
SessionThemeResolver.setThemeName
(HttpServletRequest request, HttpServletResponse response, String themeName) Deprecated. -
Uses of Nullable in org.springframework.web.servlet.view
Modifier and TypeMethodDescriptionprotected View
AbstractCachingViewResolver.createView
(String viewName, Locale locale) Create the actual View object.AbstractView.getBeanName()
Return the view's name.ContentNegotiatingViewResolver.getContentNegotiationManager()
Return theContentNegotiationManager
to use to determine requested media types.AbstractView.getContentType()
Return the content type for this view.protected String
UrlBasedViewResolver.getContentType()
Return the content type for all views, if any.protected Boolean
UrlBasedViewResolver.getExposeContextBeansAsAttributes()
protected String[]
UrlBasedViewResolver.getExposedContextBeanNames()
protected Boolean
UrlBasedViewResolver.getExposePathVariables()
Return whether views resolved by this resolver should add path variables to the model or not.String[]
RedirectView.getHosts()
Return the configured application hosts.ContentNegotiatingViewResolver.getMediaTypes
(HttpServletRequest request) Determines the list ofMediaType
for the givenHttpServletRequest
.String[]
UrlBasedViewResolver.getRedirectHosts()
Return the configured application hosts for redirect purposes.AbstractView.getRequestContextAttribute()
Return the name of the RequestContext attribute, if any.protected String
UrlBasedViewResolver.getRequestContextAttribute()
Return the name of the RequestContext attribute for all views, if any.protected RequestDispatcher
InternalResourceView.getRequestDispatcher
(HttpServletRequest request, String path) Obtain the RequestDispatcher to use for the forward/include.AbstractUrlBasedView.getUrl()
Return the URL of the resource that this view wraps.protected Class<?>
UrlBasedViewResolver.getViewClass()
Return the view class to be used to create views.protected String[]
UrlBasedViewResolver.getViewNames()
Return the view names (or name patterns) that can be handled by thisViewResolver
.protected abstract View
Subclasses must implement this method, building a View object for the specified view.AbstractCachingViewResolver.resolveViewName
(String viewName, Locale locale) BeanNameViewResolver.resolveViewName
(String viewName, Locale locale) ContentNegotiatingViewResolver.resolveViewName
(String viewName, Locale locale) ViewResolverComposite.resolveViewName
(String viewName, Locale locale) protected String
DefaultRequestToViewNameTranslator.transformPath
(String lookupPath) Transform the request URI (in the context of the webapp) stripping slashes and extensions, and replacing the separator as required.Modifier and TypeMethodDescriptionAbstractView.createMergedOutputModel
(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Creates a combined output Map (nevernull
) that includes dynamic values and static attributes.protected boolean
RedirectView.isEligibleProperty
(String key, Object value) Determine whether the given model element should be exposed as a query property.protected boolean
RedirectView.isEligibleValue
(Object value) Determine whether the given model element value is eligible for exposure.void
AbstractView.render
(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Prepares the view given the specified model, merging it with static attributes and a RequestContext attribute, if necessary.void
AbstractView.setAttributesCSV
(String propString) Set static attributes as a CSV string.void
AbstractView.setAttributesMap
(Map<String, ?> attributes) Set static attributes for this view from a Map.void
UrlBasedViewResolver.setAttributesMap
(Map<String, ?> attributes) Set static attributes from a Map, for all views returned by this resolver.void
AbstractView.setBeanName
(String beanName) Set the view's name.void
ContentNegotiatingViewResolver.setContentNegotiationManager
(ContentNegotiationManager contentNegotiationManager) Set theContentNegotiationManager
to use to determine requested media types.void
AbstractView.setContentType
(String contentType) Set the content type for this view.void
UrlBasedViewResolver.setContentType
(String contentType) Set the content type for all views.void
UrlBasedViewResolver.setExposedContextBeanNames
(String... exposedContextBeanNames) Specify the names of beans in the context which are supposed to be exposed.void
UrlBasedViewResolver.setExposePathVariables
(Boolean exposePathVariables) Specify whether views resolved by this resolver should add path variables to the model or not.void
Configure one or more hosts associated with the application.void
Set the prefix to prepend to generated view names.void
Set the prefix that gets prepended to view names when building a URL.void
UrlBasedViewResolver.setRedirectHosts
(String... redirectHosts) Configure one or more hosts associated with the application.void
AbstractView.setRequestContextAttribute
(String requestContextAttribute) Set the name of the RequestContext attribute for this view.void
UrlBasedViewResolver.setRequestContextAttribute
(String requestContextAttribute) Set the name of the RequestContext attribute for all views.void
Set the suffix to append to generated view names.void
Set the suffix that gets appended to view names when building a URL.void
Set the URL of the resource that this view wraps.void
UrlBasedViewResolver.setViewClass
(Class<?> viewClass) Set the view class that should be used to create views.void
UrlBasedViewResolver.setViewNames
(String... viewNames) Set the view names (or name patterns) that can be handled by thisViewResolver
. -
Uses of Nullable in org.springframework.web.servlet.view.freemarker
Modifier and TypeMethodDescriptionprotected freemarker.template.Configuration
FreeMarkerView.getConfiguration()
Return the FreeMarker configuration used by this view.protected String
FreeMarkerView.getEncoding()
Return the encoding for the FreeMarker template.Modifier and TypeMethodDescriptionvoid
FreeMarkerView.setConfiguration
(freemarker.template.Configuration configuration) Set the FreeMarker Configuration to be used by this view.void
FreeMarkerView.setEncoding
(String encoding) Set the encoding of the FreeMarker template file. -
Uses of Nullable in org.springframework.web.servlet.view.json
Modifier and TypeMethodDescriptionMappingJackson2JsonView.getModelKeys()
Return the attributes in the model that should be rendered by this view.Modifier and TypeMethodDescriptionvoid
MappingJackson2JsonView.setModelKeys
(Set<String> modelKeys) Set the attributes in the model that should be rendered by this view. -
Uses of Nullable in org.springframework.web.servlet.view.script
Modifier and TypeMethodDescriptionScriptTemplateConfig.getCharset()
Return the charset used to read script and template files.ScriptTemplateConfigurer.getCharset()
ScriptTemplateConfig.getContentType()
Return the content type to use for the response.ScriptTemplateConfigurer.getContentType()
Return the content type to use for the response.ScriptTemplateConfig.getEngine()
Return theScriptEngine
to use by the views.ScriptTemplateConfigurer.getEngine()
ScriptTemplateConfig.getEngineName()
Return the engine name that will be used to instantiate theScriptEngine
.ScriptTemplateConfigurer.getEngineName()
ScriptTemplateConfig.getEngineSupplier()
Return the engine supplier that will be used to instantiate theScriptEngine
.ScriptTemplateConfigurer.getEngineSupplier()
ScriptTemplateConfig.getRenderFunction()
Return the render function name (optional).ScriptTemplateConfigurer.getRenderFunction()
ScriptTemplateConfig.getRenderObject()
Return the object where the render function belongs (optional).ScriptTemplateConfigurer.getRenderObject()
protected Resource
ScriptTemplateView.getResource
(String location) ScriptTemplateConfig.getResourceLoaderPath()
Return the resource loader path(s) via a Spring resource location.ScriptTemplateConfigurer.getResourceLoaderPath()
String[]
ScriptTemplateConfig.getScripts()
Return the scripts to be loaded by the script engine (library or user provided).String[]
ScriptTemplateConfigurer.getScripts()
ScriptTemplateConfig.isSharedEngine()
Return whether to use a shared engine for all threads or whether to create thread-local engine instances for each thread.ScriptTemplateConfigurer.isSharedEngine()
Modifier and TypeMethodDescriptionvoid
ScriptTemplateConfigurer.setCharset
(Charset charset) Set the charset used to read script and template files.void
ScriptTemplateConfigurer.setContentType
(String contentType) Set the content type to use for the response.void
ScriptTemplateConfigurer.setEngine
(ScriptEngine engine) Set theScriptEngine
to use by the view.void
ScriptTemplateConfigurer.setEngineName
(String engineName) Set the engine name that will be used to instantiate theScriptEngine
.void
ScriptTemplateConfigurer.setEngineSupplier
(Supplier<ScriptEngine> engineSupplier) Set theScriptEngine
supplier to use by the view, usually used withScriptTemplateConfigurer.setSharedEngine(Boolean)
set tofalse
.void
ScriptTemplateConfigurer.setRenderFunction
(String renderFunction) Set the render function name (optional).void
ScriptTemplateConfigurer.setRenderObject
(String renderObject) Set the object where the render function belongs (optional).void
ScriptTemplateConfigurer.setResourceLoaderPath
(String resourceLoaderPath) Set the resource loader path(s) via a Spring resource location.void
ScriptTemplateConfigurer.setScripts
(String... scriptNames) Set the scripts to be loaded by the script engine (library or user provided).void
ScriptTemplateConfigurer.setSharedEngine
(Boolean sharedEngine) When set tofalse
, use thread-localScriptEngine
instances instead of one single shared instance. -
Uses of Nullable in org.springframework.web.servlet.view.xml
Modifier and TypeMethodDescriptionprotected Object
MarshallingView.locateToBeMarshalled
(Map<String, Object> model) Locate the object to be marshalled. -
Uses of Nullable in org.springframework.web.servlet.view.xslt
Modifier and TypeMethodDescriptionprotected Source
XsltView.locateSource
(Map<String, Object> model) Locate theSource
object in the supplied model, converting objects as required.Modifier and TypeMethodDescriptionprotected TransformerFactory
XsltView.newTransformerFactory
(Class<? extends TransformerFactory> transformerFactoryClass) Instantiate a new TransformerFactory for this view.void
XsltView.setErrorListener
(ErrorListener errorListener) Set an implementation of theErrorListener
interface for custom handling of transformation errors and warnings. -
Uses of Nullable in org.springframework.web.socket
Modifier and TypeMethodDescriptionWebSocketSession.getAcceptedProtocol()
Return the negotiated sub-protocol.Return the first header value for the given header name, if any.WebSocketSession.getLocalAddress()
Return the address on which the request was received.WebSocketSession.getPrincipal()
Return aPrincipal
instance containing the name of the authenticated user.CloseStatus.getReason()
Return the reason, ornull
if none.WebSocketSession.getRemoteAddress()
Return the address of the remote client.WebSocketHttpHeaders.getSecWebSocketAccept()
Returns the value of theSec-WebSocket-Accept
header.WebSocketHttpHeaders.getSecWebSocketKey()
Returns the value of theSec-WebSocket-Key
header.WebSocketHttpHeaders.getSecWebSocketVersion()
Returns the value of theSec-WebSocket-Version
header.WebSocketSession.getUri()
Return the URI used to open the WebSocket connection.Modifier and TypeMethodDescriptionvoid
Add the given, single header value under the given name.boolean
boolean
boolean
boolean
void
Set the given, single header value under the given name.void
WebSocketHttpHeaders.setSecWebSocketAccept
(String secWebSocketAccept) Sets the (new) value of theSec-WebSocket-Accept
header.void
WebSocketHttpHeaders.setSecWebSocketKey
(String secWebSocketKey) Sets the (new) value of theSec-WebSocket-Key
header.void
WebSocketHttpHeaders.setSecWebSocketVersion
(String secWebSocketVersion) Sets the (new) value of theSec-WebSocket-Version
header.ModifierConstructorDescriptionCloseStatus
(int code, String reason) Create a newCloseStatus
instance.WebSocketExtension
(String name, Map<String, String> parameters) Create a WebSocketExtension with the given name and parameters. -
Uses of Nullable in org.springframework.web.socket.adapter
Modifier and TypeMethodDescription<R> R
AbstractWebSocketSession.getNativeSession
(Class<R> requiredType) <T> T
NativeWebSocketSession.getNativeSession
(Class<T> requiredType) Return the underlying native WebSocketSession, if available.Modifier and TypeMethodDescription<R> R
AbstractWebSocketSession.getNativeSession
(Class<R> requiredType) <T> T
NativeWebSocketSession.getNativeSession
(Class<T> requiredType) Return the underlying native WebSocketSession, if available.ModifierConstructorDescriptionAbstractWebSocketSession
(Map<String, Object> attributes) Create a new instance and associate the given attributes with it. -
Uses of Nullable in org.springframework.web.socket.adapter.jetty
ModifierConstructorDescriptionJettyWebSocketSession
(Map<String, Object> attributes, Principal user) Create a newJettyWebSocketSession
instance associated with the given user. -
Uses of Nullable in org.springframework.web.socket.adapter.standard
Modifier and TypeMethodDescriptionDecode the message into an object.Encode an object to a message.protected ApplicationContext
ConvertingEncoderDecoderSupport.getApplicationContext()
Returns the activeApplicationContext
.StandardWebSocketSession.getLocalAddress()
StandardWebSocketSession.getRemoteAddress()
StandardWebSocketSession.getUri()
ModifierConstructorDescriptionStandardWebSocketSession
(HttpHeaders headers, Map<String, Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress) Constructor for a standard WebSocket session.StandardWebSocketSession
(HttpHeaders headers, Map<String, Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress) Constructor for a standard WebSocket session.StandardWebSocketSession
(HttpHeaders headers, Map<String, Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress) Constructor for a standard WebSocket session.StandardWebSocketSession
(HttpHeaders headers, Map<String, Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress) Constructor for a standard WebSocket session.StandardWebSocketSession
(HttpHeaders headers, Map<String, Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress, Principal user) Constructor that associates a user with the WebSocket session.StandardWebSocketSession
(HttpHeaders headers, Map<String, Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress, Principal user) Constructor that associates a user with the WebSocket session.StandardWebSocketSession
(HttpHeaders headers, Map<String, Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress, Principal user) Constructor that associates a user with the WebSocket session.StandardWebSocketSession
(HttpHeaders headers, Map<String, Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress, Principal user) Constructor that associates a user with the WebSocket session.StandardWebSocketSession
(HttpHeaders headers, Map<String, Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress, Principal user) Constructor that associates a user with the WebSocket session. -
Uses of Nullable in org.springframework.web.socket.client
Modifier and TypeMethodDescriptionWebSocketConnectionManager.getOrigin()
Return the configured origin.Modifier and TypeMethodDescriptiondefault ListenableFuture<WebSocketSession>
WebSocketClient.doHandshake
(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri) Deprecated.as of 6.0, in favor ofWebSocketClient.execute(WebSocketHandler, WebSocketHttpHeaders, URI)
AbstractWebSocketClient.execute
(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri) WebSocketClient.execute
(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri) Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.void
Set the origin to use. -
Uses of Nullable in org.springframework.web.socket.client.jetty
Modifier and TypeMethodDescriptionJettyWebSocketClient.getTaskExecutor()
Deprecated, for removal: This API element is subject to removal in a future version.Return the configuredAsyncTaskExecutor
.protected Principal
JettyWebSocketClient.getUser()
Deprecated, for removal: This API element is subject to removal in a future version.Return the user to make available throughWebSocketSession.getPrincipal()
.Modifier and TypeMethodDescriptionvoid
JettyWebSocketClient.setTaskExecutor
(AsyncTaskExecutor taskExecutor) Deprecated, for removal: This API element is subject to removal in a future version.Set anAsyncTaskExecutor
to use when opening connections. -
Uses of Nullable in org.springframework.web.socket.client.standard
Modifier and TypeMethodDescriptionStandardWebSocketClient.getTaskExecutor()
Return the configuredAsyncTaskExecutor
.Modifier and TypeMethodDescriptionvoid
StandardWebSocketClient.setTaskExecutor
(AsyncTaskExecutor taskExecutor) Set anAsyncTaskExecutor
to use when opening connections.void
StandardWebSocketClient.setUserProperties
(Map<String, Object> userProperties) The standard Jakarta WebSocket API allows passing "user properties" to the server viauserProperties
. -
Uses of Nullable in org.springframework.web.socket.config.annotation
Modifier and TypeMethodDescriptionprotected HandshakeHandler
AbstractWebSocketHandlerRegistration.getHandshakeHandler()
protected Integer
WebSocketTransportRegistration.getMessageSizeLimit()
Protected accessor for internal use.protected Integer
WebSocketTransportRegistration.getSendBufferSizeLimit()
Protected accessor for internal use.protected Integer
WebSocketTransportRegistration.getSendTimeLimit()
Protected accessor for internal use.protected SockJsServiceRegistration
AbstractWebSocketHandlerRegistration.getSockJsServiceRegistration()
Expose theSockJsServiceRegistration
-- if SockJS is enabled ornull
otherwise -- so that it can be configured with a TaskScheduler if the application did not provide one.protected TaskScheduler
SockJsServiceRegistration.getTaskScheduler()
Return the TaskScheduler, if configured.protected Integer
WebSocketTransportRegistration.getTimeToFirstMessage()
Protected accessor for internal use.ServletWebSocketHandlerRegistry.getUrlPathHelper()
protected UrlPathHelper
WebMvcStompEndpointRegistry.getUrlPathHelper()
Modifier and TypeMethodDescriptionprotected SimpUserRegistry
WebSocketMessageBrokerConfigurationSupport.createLocalUserRegistry
(Integer order) AbstractWebSocketHandlerRegistration.setHandshakeHandler
(HandshakeHandler handshakeHandler) void
ServletWebSocketHandlerRegistry.setUrlPathHelper
(UrlPathHelper urlPathHelper) Set the UrlPathHelper to configure on theSimpleUrlHandlerMapping
used to map handshake requests.void
WebMvcStompEndpointRegistry.setUrlPathHelper
(UrlPathHelper urlPathHelper) Set the UrlPathHelper to configure on theHandlerMapping
used to map handshake requests.WebSocketMessageBrokerConfigurationSupport.webSocketMessageBrokerStats
(AbstractBrokerMessageHandler stompBrokerRelayMessageHandler, WebSocketHandler subProtocolWebSocketHandler, TaskExecutor inboundExecutor, TaskExecutor outboundExecutor, TaskScheduler scheduler) -
Uses of Nullable in org.springframework.web.socket.handler
-
Uses of Nullable in org.springframework.web.socket.messaging
Modifier and TypeMethodDescriptionSubProtocolWebSocketHandler.getDefaultProtocolHandler()
Return the default sub-protocol handler to use.StompSubProtocolHandler.getErrorHandler()
Return the configured error handler.StompSubProtocolHandler.getHeaderInitializer()
Return the configured header initializer.AbstractSubProtocolEvent.getUser()
Return the user for the session associated with the event.Message<byte[]>
StompSubProtocolErrorHandler.handleClientMessageProcessingError
(Message<byte[]> clientMessage, Throwable ex) SubProtocolErrorHandler.handleClientMessageProcessingError
(Message<P> clientMessage, Throwable ex) Handle errors thrown while processing client messages providing an opportunity to prepare the error message or to prevent one from being sent.Message<byte[]>
StompSubProtocolErrorHandler.handleErrorMessageToClient
(Message<byte[]> errorMessage) SubProtocolErrorHandler.handleErrorMessageToClient
(Message<P> errorMessage) Handle errors sent from the server side to clients, e.g.StompSubProtocolHandler.resolveSessionId
(Message<?> message) SubProtocolHandler.resolveSessionId
(Message<?> message) Resolve the session id from the given message or returnnull
.Modifier and TypeMethodDescriptionWebSocketStompClient.connect
(String url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, Object... uriVariables) Deprecated.WebSocketStompClient.connect
(String url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, Object... uriVariables) Deprecated.WebSocketStompClient.connect
(String url, WebSocketHttpHeaders handshakeHeaders, StompSessionHandler handler, Object... uriVariables) Deprecated.WebSocketStompClient.connect
(URI url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler) Deprecated.WebSocketStompClient.connect
(URI url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler) Deprecated.WebSocketStompClient.connectAsync
(String url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, Object... uriVariables) An overloaded version ofWebSocketStompClient.connect(String, StompSessionHandler, Object...)
that also acceptsWebSocketHttpHeaders
to use for the WebSocket handshake andStompHeaders
for the STOMP CONNECT frame.WebSocketStompClient.connectAsync
(String url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, Object... uriVariables) An overloaded version ofWebSocketStompClient.connect(String, StompSessionHandler, Object...)
that also acceptsWebSocketHttpHeaders
to use for the WebSocket handshake andStompHeaders
for the STOMP CONNECT frame.WebSocketStompClient.connectAsync
(String url, WebSocketHttpHeaders handshakeHeaders, StompSessionHandler handler, Object... uriVariables) An overloaded version ofWebSocketStompClient.connect(String, StompSessionHandler, Object...)
that also acceptsWebSocketHttpHeaders
to use for the WebSocket handshake.WebSocketStompClient.connectAsync
(URI url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler) An overloaded version ofWebSocketStompClient.connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)
that accepts a fully preparedURI
.WebSocketStompClient.connectAsync
(URI url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler) An overloaded version ofWebSocketStompClient.connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)
that accepts a fully preparedURI
.Message<byte[]>
StompSubProtocolErrorHandler.handleClientMessageProcessingError
(Message<byte[]> clientMessage, Throwable ex) SubProtocolErrorHandler.handleClientMessageProcessingError
(Message<P> clientMessage, Throwable ex) Handle errors thrown while processing client messages providing an opportunity to prepare the error message or to prevent one from being sent.protected Message<byte[]>
StompSubProtocolErrorHandler.handleInternal
(StompHeaderAccessor errorHeaderAccessor, byte[] errorPayload, Throwable cause, StompHeaderAccessor clientHeaderAccessor) protected Message<byte[]>
StompSubProtocolErrorHandler.handleInternal
(StompHeaderAccessor errorHeaderAccessor, byte[] errorPayload, Throwable cause, StompHeaderAccessor clientHeaderAccessor) protected StompHeaders
WebSocketStompClient.processConnectHeaders
(StompHeaders connectHeaders) void
SubProtocolWebSocketHandler.setDefaultProtocolHandler
(SubProtocolHandler defaultProtocolHandler) Set theSubProtocolHandler
to use when the client did not request a sub-protocol.void
StompSubProtocolHandler.setHeaderInitializer
(MessageHeaderInitializer headerInitializer) Configure aMessageHeaderInitializer
to apply to the headers of all messages created from decoded STOMP frames and other messages sent to the client inbound channel.void
WebSocketStompClient.setTaskScheduler
(TaskScheduler taskScheduler) Configure a scheduler to use for heartbeats and for receipt tracking.boolean
DefaultSimpUserRegistry.supportsSourceType
(Class<?> sourceType) ModifierConstructorDescriptionprotected
AbstractSubProtocolEvent
(Object source, Message<byte[]> message, Principal user) Create a new AbstractSubProtocolEvent.SessionConnectedEvent
(Object source, Message<byte[]> message, Principal user) SessionConnectEvent
(Object source, Message<byte[]> message, Principal user) SessionDisconnectEvent
(Object source, Message<byte[]> message, String sessionId, CloseStatus closeStatus, Principal user) Create a new SessionDisconnectEvent.SessionSubscribeEvent
(Object source, Message<byte[]> message, Principal user) SessionUnsubscribeEvent
(Object source, Message<byte[]> message, Principal user) -
Uses of Nullable in org.springframework.web.socket.server
Modifier and TypeMethodDescriptionvoid
HandshakeInterceptor.afterHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) Invoked after the handshake is done.void
RequestUpgradeStrategy.upgrade
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String, Object> attributes) Perform runtime specific steps to complete the upgrade.void
RequestUpgradeStrategy.upgrade
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String, Object> attributes) Perform runtime specific steps to complete the upgrade. -
Uses of Nullable in org.springframework.web.socket.server.jetty
Modifier and TypeMethodDescriptionvoid
JettyRequestUpgradeStrategy.upgrade
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler handler, Map<String, Object> attributes) void
JettyRequestUpgradeStrategy.upgrade
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler handler, Map<String, Object> attributes) -
Uses of Nullable in org.springframework.web.socket.server.standard
Modifier and TypeMethodDescriptionServletServerContainerFactoryBean.getAsyncSendTimeout()
ServletServerContainerFactoryBean.getMaxBinaryMessageBufferSize()
ServletServerContainerFactoryBean.getMaxSessionIdleTimeout()
ServletServerContainerFactoryBean.getMaxTextMessageBufferSize()
ServletServerContainerFactoryBean.getObject()
protected ServerContainer
ServerEndpointExporter.getServerContainer()
Return the JSR-356ServerContainer
to use for endpoint registration.Modifier and TypeMethodDescriptionvoid
ServerEndpointExporter.setServerContainer
(ServerContainer serverContainer) Set the JSR-356ServerContainer
to use for endpoint registration.void
AbstractStandardUpgradeStrategy.upgrade
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String, Object> attrs) void
AbstractStandardUpgradeStrategy.upgrade
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String, Object> attrs) protected abstract void
AbstractStandardUpgradeStrategy.upgradeInternal
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint) void
AbstractTyrusRequestUpgradeStrategy.upgradeInternal
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<Extension> extensions, Endpoint endpoint) protected void
StandardWebSocketUpgradeStrategy.upgradeInternal
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint) -
Uses of Nullable in org.springframework.web.socket.server.support
Modifier and TypeMethodDescriptionprotected Principal
AbstractHandshakeHandler.determineUser
(ServerHttpRequest request, WebSocketHandler wsHandler, Map<String, Object> attributes) A method that can be used to associate a user with the WebSocket session in the process of being established.protected Object
WebSocketHandlerMapping.getHandlerInternal
(HttpServletRequest request) protected String
AbstractHandshakeHandler.selectProtocol
(List<String> requestedProtocols, WebSocketHandler webSocketHandler) Perform the sub-protocol negotiation based on requested and supported sub-protocols.Modifier and TypeMethodDescriptionvoid
HttpSessionHandshakeInterceptor.afterHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception ex) void
OriginHandshakeInterceptor.afterHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) void
HandshakeInterceptorChain.applyAfterHandshake
(ServerHttpRequest request, ServerHttpResponse response, Exception failure) void
WebSocketHttpRequestHandler.setHandshakeInterceptors
(List<HandshakeInterceptor> interceptors) Configure one or more WebSocket handshake request interceptors.ModifierConstructorDescriptionHandshakeInterceptorChain
(List<HandshakeInterceptor> interceptors, WebSocketHandler wsHandler) -
Uses of Nullable in org.springframework.web.socket.sockjs
Modifier and TypeMethodDescriptionSockJsException.getSockJsSessionId()
Return the SockJS session id.Modifier and TypeMethodDescriptionvoid
SockJsService.handleRequest
(ServerHttpRequest request, ServerHttpResponse response, String sockJsPath, WebSocketHandler handler) Process a SockJS HTTP request.ModifierConstructorDescriptionSockJsException
(String message, String sessionId, Throwable cause) Constructor for SockJsException.SockJsException
(String message, String sessionId, Throwable cause) Constructor for SockJsException.SockJsException
(String message, Throwable cause) Constructor for SockJsException.SockJsTransportFailureException
(String message, String sessionId, Throwable cause) Constructor for SockJsTransportFailureException.SockJsTransportFailureException
(String message, Throwable cause) Constructor for SockJsTransportFailureException. -
Uses of Nullable in org.springframework.web.socket.sockjs.client
Modifier and TypeMethodDescriptionString[]
SockJsClient.getHttpHeaderNames()
The configured HTTP header names to be copied from the handshake headers and also included in other HTTP requests.<T> T
WebSocketClientSockJsSession.getNativeSession
(Class<T> requiredType) protected Principal
SockJsClient.getUser()
Return the user to associate with the SockJS session and make available viaWebSocketSession.getPrincipal()
.TransportRequest.getUser()
Return the user associated with the request, if any.Modifier and TypeMethodDescriptionvoid
AbstractClientSockJsSession.afterTransportClosed
(CloseStatus closeStatus) SockJsClient.execute
(WebSocketHandler handler, WebSocketHttpHeaders headers, URI url) AbstractXhrTransport.executeInfoRequest
(URI infoUrl, HttpHeaders headers) InfoReceiver.executeInfoRequest
(URI infoUrl, HttpHeaders headers) Perform an HTTP request to the SockJS "Info" URL.protected ResponseEntity<String>
JettyXhrTransport.executeRequest
(URI url, org.eclipse.jetty.http.HttpMethod method, HttpHeaders headers, String body) protected ResponseEntity<String>
UndertowXhrTransport.executeRequest
(URI url, io.undertow.util.HttpString method, HttpHeaders headers, String body) <T> T
WebSocketClientSockJsSession.getNativeSession
(Class<T> requiredType) void
SockJsClient.setHttpHeaderNames
(String... httpHeaderNames) The names of HTTP headers that should be copied from the handshake headers of each call toWebSocketClient.doHandshake(WebSocketHandler, WebSocketHttpHeaders, URI)
and also used with other HTTP requests issued as part of that SockJS connection, e.g. -
Uses of Nullable in org.springframework.web.socket.sockjs.frame
Modifier and TypeMethodDescriptionString[]
String[]
Decode the given SockJS message frame.String[]
Jackson2SockJsMessageCodec.decodeInputStream
(InputStream content) String[]
SockJsMessageCodec.decodeInputStream
(InputStream content) Decode the given SockJS message frame.SockJsFrame.getFrameData()
Return data contained in a SockJS "message" and "close" frames.Modifier and TypeMethodDescriptionstatic SockJsFrame
SockJsFrame.closeFrame
(int code, String reason) boolean
-
Uses of Nullable in org.springframework.web.socket.sockjs.support
Modifier and TypeMethodDescriptionAbstractSockJsService.getCorsConfiguration
(HttpServletRequest request) SockJsHttpRequestHandler.getCorsConfiguration
(HttpServletRequest request) Modifier and TypeMethodDescriptionfinal void
AbstractSockJsService.handleRequest
(ServerHttpRequest request, ServerHttpResponse response, String sockJsPath, WebSocketHandler wsHandler) This method determines the SockJS path and handles SockJS static URLs. -
Uses of Nullable in org.springframework.web.socket.sockjs.transport
Modifier and TypeMethodDescriptionvoid
TransportHandlingSockJsService.setHandshakeInterceptors
(List<HandshakeInterceptor> interceptors) Configure one or more WebSocket handshake request interceptors. -
Uses of Nullable in org.springframework.web.socket.sockjs.transport.handler
Modifier and TypeMethodDescriptionprotected final String
AbstractHttpSendingTransportHandler.getCallbackParam
(ServerHttpRequest request) protected abstract String[]
AbstractHttpReceivingTransportHandler.readMessages
(ServerHttpRequest request) protected String[]
XhrReceivingTransportHandler.readMessages
(ServerHttpRequest request) -
Uses of Nullable in org.springframework.web.socket.sockjs.transport.session
Modifier and TypeMethodDescriptionAbstractHttpSockJsSession.getAcceptedProtocol()
Return the selected sub-protocol to use.AbstractHttpSockJsSession.getLocalAddress()
<T> T
WebSocketServerSockJsSession.getNativeSession
(Class<T> requiredType) AbstractHttpSockJsSession.getPrincipal()
AbstractHttpSockJsSession.getRemoteAddress()
WebSocketServerSockJsSession.getUri()
Modifier and TypeMethodDescription<T> T
WebSocketServerSockJsSession.getNativeSession
(Class<T> requiredType) void
AbstractHttpSockJsSession.setAcceptedProtocol
(String protocol) Unlike WebSocket where sub-protocol negotiation is part of the initial handshake, in HTTP transports the same negotiation must be emulated and the selected protocol set through this setter.ModifierConstructorDescriptionAbstractSockJsSession
(String id, SockJsServiceConfig config, WebSocketHandler handler, Map<String, Object> attributes) Create a new instance.WebSocketServerSockJsSession
(String id, SockJsServiceConfig config, WebSocketHandler handler, Map<String, Object> attributes) -
Uses of Nullable in org.springframework.web.util
Modifier and TypeMethodDescriptionstatic String
UriUtils.extractFileExtension
(String path) Extract the file extension from the given URI path.static String
WebUtils.findParameterValue
(ServletRequest request, String name) Obtain a named parameter from the given request parameters.static String
WebUtils.findParameterValue
(Map<String, ?> parameters, String name) Obtain a named parameter from the given request parameters.static Cookie
WebUtils.getCookie
(HttpServletRequest request, String name) Retrieve the first cookie with the given name.CookieGenerator.getCookieDomain()
Deprecated.Return the domain for cookies created by this generator, if any.CookieGenerator.getCookieMaxAge()
Deprecated.Return the maximum age for cookies created by this generator.CookieGenerator.getCookieName()
Deprecated.Return the given name for cookies created by this generator.static Boolean
WebUtils.getDefaultHtmlEscape
(ServletContext servletContext) Return whether default HTML escaping is enabled for the web application, i.e.final String
UriComponents.getFragment()
Return the fragment.abstract String
UriComponents.getHost()
Return the host.static <T> T
WebUtils.getNativeRequest
(ServletRequest request, Class<T> requiredType) Return an appropriate request object of the specified type, if available, unwrapping the given request as far as necessary.static <T> T
WebUtils.getNativeResponse
(ServletResponse response, Class<T> requiredType) Return an appropriate response object of the specified type, if available, unwrapping the given response as far as necessary.abstract String
UriComponents.getPath()
Return the path.abstract String
UriComponents.getQuery()
Return the query.static Boolean
WebUtils.getResponseEncodedHtmlEscape
(ServletContext servletContext) Return whether response encoding should be used when HTML escaping characters, thus only escaping XML markup significant characters with UTF-* encodings.final String
UriComponents.getScheme()
Return the scheme.abstract String
UriComponents.getSchemeSpecificPart()
Return the scheme specific part.static Object
WebUtils.getSessionAttribute
(HttpServletRequest request, String name) Check the given request for a session attribute of the given name.static String
WebUtils.getSessionId
(HttpServletRequest request) Determine the session id of the given request, if any.abstract String
UriComponents.getUserInfo()
Return the user info.Get the value for the given URI variable name.static InetSocketAddress
ForwardedHeaderUtils.parseForwardedFor
(URI uri, HttpHeaders headers, InetSocketAddress remoteAddress) Parse the first "Forwarded: for=..." or "X-Forwarded-For" header value to anInetSocketAddress
representing the address of the client.static InetSocketAddress
UriComponentsBuilder.parseForwardedFor
(HttpRequest request, InetSocketAddress remoteAddress) Deprecated, for removal: This API element is subject to removal in a future version.in favor ofForwardedHeaderUtils.adaptFromForwardedHeaders(java.net.URI, org.springframework.http.HttpHeaders)
; to be removed in 6.2Modifier and TypeMethodDescriptionstatic void
WebUtils.exposeErrorRequestAttributes
(HttpServletRequest request, Throwable ex, String servletName) Expose the Servlet spec's error attributes asHttpServletRequest
attributes under the keys defined in the Servlet 2.3 specification, for error pages that are rendered directly rather than through the Servlet container's error page resolution:jakarta.servlet.error.status_code
,jakarta.servlet.error.exception_type
,jakarta.servlet.error.message
,jakarta.servlet.error.exception
,jakarta.servlet.error.request_uri
,jakarta.servlet.error.servlet_name
.Set the URI fragment.static Boolean
WebUtils.getDefaultHtmlEscape
(ServletContext servletContext) Return whether default HTML escaping is enabled for the web application, i.e.UrlPathHelper.getLookupPathForRequest
(HttpServletRequest request, String name) Deprecated.as of 5.3 in favor of usingUrlPathHelper.resolveAndCacheLookupPath(HttpServletRequest)
andUrlPathHelper.getResolvedLookupPath(ServletRequest)
.static <T> T
WebUtils.getNativeRequest
(ServletRequest request, Class<T> requiredType) Return an appropriate request object of the specified type, if available, unwrapping the given request as far as necessary.static <T> T
WebUtils.getNativeResponse
(ServletResponse response, Class<T> requiredType) Return an appropriate response object of the specified type, if available, unwrapping the given response as far as necessary.WebUtils.getParametersStartingWith
(ServletRequest request, String prefix) Return a map containing all parameters with the given prefix.static Boolean
WebUtils.getResponseEncodedHtmlEscape
(ServletContext servletContext) Return whether response encoding should be used when HTML escaping characters, thus only escaping XML markup significant characters with UTF-* encodings.Get the value for the given URI variable name.Set the URI host which may contain URI template variables, and may also benull
to clear the host of this builder.boolean
Indicate whether the given URI matches this template.static InetSocketAddress
ForwardedHeaderUtils.parseForwardedFor
(URI uri, HttpHeaders headers, InetSocketAddress remoteAddress) Parse the first "Forwarded: for=..." or "X-Forwarded-For" header value to anInetSocketAddress
representing the address of the client.static InetSocketAddress
UriComponentsBuilder.parseForwardedFor
(HttpRequest request, InetSocketAddress remoteAddress) Deprecated, for removal: This API element is subject to removal in a future version.in favor ofForwardedHeaderUtils.adaptFromForwardedHeaders(java.net.URI, org.springframework.http.HttpHeaders)
; to be removed in 6.2Set the URI port.UriBuilder.queryParam
(String name, Collection<?> values) Variant ofUriBuilder.queryParam(String, Object...)
with a Collection.UriComponentsBuilder.queryParam
(String name, Collection<?> values) UriComponentsBuilder.queryParams
(MultiValueMap<String, String> params) Add multiple query parameters and values.UriBuilder.replacePath
(String path) Override the current path.UriComponentsBuilder.replacePath
(String path) UriBuilder.replaceQuery
(String query) Clear existing query parameters and then delegate toUriBuilder.query(String)
.UriComponentsBuilder.replaceQuery
(String query) UriBuilder.replaceQueryParam
(String name, Collection<?> values) Variant ofUriBuilder.replaceQueryParam(String, Object...)
with a Collection.UriComponentsBuilder.replaceQueryParam
(String name, Collection<?> values) UriComponentsBuilder.replaceQueryParams
(MultiValueMap<String, String> params) Set the query parameter values after removing all existing ones.Set the URI scheme which may contain URI template variables, and may also benull
to clear the scheme of this builder.void
CookieGenerator.setCookieDomain
(String cookieDomain) Deprecated.Use the given domain for cookies created by this generator.void
CookieGenerator.setCookieMaxAge
(Integer cookieMaxAge) Deprecated.Use the given maximum age (in seconds) for cookies created by this generator.void
CookieGenerator.setCookieName
(String cookieName) Deprecated.Use the given name for cookies created by this generator.void
DefaultUriBuilderFactory.setDefaultUriVariables
(Map<String, ?> defaultUriVariables) Provide default URI variable values to use when expanding URI templates with a Map of variables.static void
ServletRequestPathUtils.setParsedRequestPath
(RequestPath requestPath, ServletRequest request) Set the cached, parsedRequestPath
to the given value.static void
WebUtils.setSessionAttribute
(HttpServletRequest request, String name, Object value) Set the session attribute with the given name to the given value.Set the URI user info which may contain URI template variables, and may also benull
to clear the user info of this builder.ModifierConstructorDescriptionNestedServletException
(String msg, Throwable cause) Deprecated.Construct aNestedServletException
with the specified detail message and nested exception.NestedServletException
(String msg, Throwable cause) Deprecated.Construct aNestedServletException
with the specified detail message and nested exception.protected
UriComponents
(String scheme, String fragment) protected
UriComponents
(String scheme, String fragment) -
Uses of Nullable in org.springframework.web.util.pattern
Modifier and TypeMethodDescriptionPathPattern.matchAndExtract
(PathContainer pathContainer) Match this pattern to the given URI path and return extracted URI template variables as well as path parameters (matrix variables).PathPatternRouteMatcher.matchAndExtract
(String pattern, RouteMatcher.Route route) PathPattern.matchStartOfPath
(PathContainer pathContainer) Match the beginning of the given path and return the remaining portion not covered by this pattern.Modifier and TypeMethodDescriptionint
PathPattern.compareTo
(PathPattern otherPattern) Compare this pattern with a supplied pattern: return -1,0,+1 if this pattern is more specific, the same or less specific than the supplied pattern.boolean
RootBeanDefinition.setTargetType(ResolvableType)
call