Package org.springframework.core.env
Interface EnvironmentCapable
- All Known Subinterfaces:
ApplicationContext,ConfigurableApplicationContext,ConfigurablePortletApplicationContext,ConfigurableWebApplicationContext,WebApplicationContext
- All Known Implementing Classes:
AbstractApplicationContext,AbstractBeanDefinitionReader,AbstractRefreshableApplicationContext,AbstractRefreshableConfigApplicationContext,AbstractRefreshablePortletApplicationContext,AbstractRefreshableWebApplicationContext,AbstractRequestLoggingFilter,AbstractXmlApplicationContext,AnnotationConfigApplicationContext,AnnotationConfigWebApplicationContext,CharacterEncodingFilter,ClassPathBeanDefinitionScanner,ClassPathScanningCandidateComponentProvider,ClassPathXmlApplicationContext,CommonsRequestLoggingFilter,CorsFilter,DelegatingFilterProxy,DispatcherPortlet,DispatcherServlet,FileSystemXmlApplicationContext,ForwardedHeaderFilter,FrameworkPortlet,FrameworkServlet,GenericApplicationContext,GenericFilterBean,GenericGroovyApplicationContext,GenericPortletBean,GenericWebApplicationContext,GenericXmlApplicationContext,GroovyBeanDefinitionReader,GroovyWebApplicationContext,HiddenHttpMethodFilter,HttpPutFormContentFilter,HttpServletBean,Log4jNestedDiagnosticContextFilter,MultipartFilter,OncePerRequestFilter,OpenEntityManagerInViewFilter,OpenPersistenceManagerInViewFilter,OpenSessionInViewFilter,OpenSessionInViewFilter,OpenSessionInViewFilter,PropertiesBeanDefinitionReader,RelativeRedirectFilter,RequestContextFilter,ResourceAdapterApplicationContext,ResourceServlet,ResourceUrlEncodingFilter,ServletContextRequestLoggingFilter,ShallowEtagHeaderFilter,StaticApplicationContext,StaticPortletApplicationContext,StaticWebApplicationContext,XmlBeanDefinitionReader,XmlPortletApplicationContext,XmlWebApplicationContext
public interface EnvironmentCapable
Interface indicating a component that contains and exposes anEnvironmentreference.All Spring application contexts are EnvironmentCapable, and the interface is used primarily for performing
instanceofchecks 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,
ApplicationContextextends EnvironmentCapable, and thus exposes agetEnvironment()method; however,ConfigurableApplicationContextredefinesgetEnvironment()and narrows the signature to return aConfigurableEnvironment. 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:
Environment,ConfigurableEnvironment,ConfigurableApplicationContext.getEnvironment()
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EnvironmentgetEnvironment()Return theEnvironmentassociated with this component (may benullor a default environment).
Method Detail
getEnvironment
Environment getEnvironment()
Return theEnvironmentassociated with this component (may benullor a default environment).