Package org.springframework.core.env
Interface EnvironmentCapable
- All Known Subinterfaces:
ApplicationContext
,ConfigurableApplicationContext
,ConfigurableWebApplicationContext
,WebApplicationContext
- All Known Implementing Classes:
AbstractApplicationContext
,AbstractBeanDefinitionReader
,AbstractRefreshableApplicationContext
,AbstractRefreshableConfigApplicationContext
,AbstractRefreshableWebApplicationContext
,AbstractRequestLoggingFilter
,AbstractXmlApplicationContext
,AnnotationConfigApplicationContext
,AnnotationConfigWebApplicationContext
,CharacterEncodingFilter
,ClassPathBeanDefinitionScanner
,ClassPathScanningCandidateComponentProvider
,ClassPathXmlApplicationContext
,CommonsRequestLoggingFilter
,CorsFilter
,DelegatingFilterProxy
,DispatcherServlet
,FileSystemXmlApplicationContext
,FormContentFilter
,ForwardedHeaderFilter
,FrameworkServlet
,GenericApplicationContext
,GenericFilterBean
,GenericGroovyApplicationContext
,GenericWebApplicationContext
,GenericXmlApplicationContext
,GroovyBeanDefinitionReader
,GroovyWebApplicationContext
,HiddenHttpMethodFilter
,HttpServletBean
,MultipartFilter
,OncePerRequestFilter
,OpenEntityManagerInViewFilter
,OpenSessionInViewFilter
,PropertiesBeanDefinitionReader
,RelativeRedirectFilter
,RequestContextFilter
,ResourceUrlEncodingFilter
,ServletContextRequestLoggingFilter
,ShallowEtagHeaderFilter
,StaticApplicationContext
,StaticWebApplicationContext
,XmlBeanDefinitionReader
,XmlWebApplicationContext
public interface EnvironmentCapable
Interface indicating a component that contains and exposes an
Environment
reference.
All Spring application contexts are EnvironmentCapable, and the interface is used primarily
for performing instanceof
checks in framework methods that accept BeanFactory
instances that may or may not actually be ApplicationContext instances in order to interact
with the environment if indeed it is available.
As mentioned, ApplicationContext
extends EnvironmentCapable, and thus exposes a getEnvironment()
method; however,
ConfigurableApplicationContext
redefines getEnvironment()
and narrows the signature to return a ConfigurableEnvironment
.
The effect is that an Environment object is 'read-only' until it is being accessed from
a ConfigurableApplicationContext, at which point it too may be configured.
- Since:
- 3.1
- Author:
- Chris Beams
- See Also:
-
Method Summary
-
Method Details
-
getEnvironment
Environment getEnvironment()Return theEnvironment
associated with this component.
-