类 ServletContextParameterFactoryBean
- java.lang.Object
- org.springframework.web.context.support.ServletContextParameterFactoryBean
- 所有已实现的接口:
Aware
,FactoryBean<String>
,ServletContextAware
public class ServletContextParameterFactoryBean extends Object implements FactoryBean<String>, ServletContextAware
FactoryBean
that retrieves a specific ServletContext init parameter (that is, a "context-param" defined inweb.xml
). Exposes that ServletContext init parameter when used as bean reference, effectively making it available as named Spring bean instance.NOTE: As of Spring 3.0, you may also use the "contextParameters" default bean which is of type Map, and dereference it using an "#{contextParameters.myKey}" expression to access a specific parameter by name.
- 从以下版本开始:
- 1.2.4
- 作者:
- Juergen Hoeller
- 另请参阅:
WebApplicationContext.CONTEXT_PARAMETERS_BEAN_NAME
,ServletContextAttributeFactoryBean
构造器概要
构造器 构造器 说明 ServletContextParameterFactoryBean()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 String
getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.Class<String>
getObjectType()
Return the type of object that this FactoryBean creates, ornull
if not known in advance.boolean
isSingleton()
Is the object managed by this factory a singleton?void
setInitParamName(String initParamName)
Set the name of the ServletContext init parameter to expose.void
setServletContext(ServletContext servletContext)
Set theServletContext
that this object runs in.
构造器详细资料
ServletContextParameterFactoryBean
public ServletContextParameterFactoryBean()
方法详细资料
setInitParamName
public void setInitParamName(String initParamName)
Set the name of the ServletContext init parameter to expose.
setServletContext
public void setServletContext(ServletContext servletContext)
从接口复制的说明:ServletContextAware
Set theServletContext
that this object runs in.Invoked after population of normal bean properties but before an init callback like InitializingBean's
afterPropertiesSet
or a custom init-method. Invoked after ApplicationContextAware'ssetApplicationContext
.- 指定者:
setServletContext
在接口中ServletContextAware
- 参数:
servletContext
- ServletContext object to be used by this object- 另请参阅:
InitializingBean.afterPropertiesSet()
,ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
getObject
public String getObject()
从接口复制的说明:FactoryBean
Return an instance (possibly shared or independent) of the object managed by this factory.As with a
BeanFactory
, this allows support for both the Singleton and Prototype design pattern.If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding
FactoryBeanNotInitializedException
.As of Spring 2.0, FactoryBeans are allowed to return
null
objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.- 指定者:
getObject
在接口中FactoryBean<String>
- 返回:
- an instance of the bean (can be
null
) - 另请参阅:
FactoryBeanNotInitializedException
getObjectType
public Class<String> getObjectType()
从接口复制的说明:FactoryBean
Return the type of object that this FactoryBean creates, ornull
if not known in advance.This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
null
here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.- 指定者:
getObjectType
在接口中FactoryBean<String>
- 返回:
- the type of object that this FactoryBean creates, or
null
if not known at the time of the call - 另请参阅:
ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
isSingleton
public boolean isSingleton()
从接口复制的说明:FactoryBean
Is the object managed by this factory a singleton? That is, willFactoryBean.getObject()
always return the same object (a reference that can be cached)?NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from
getObject()
might get cached by the owning BeanFactory. Hence, do not returntrue
unless the FactoryBean always exposes the same reference.The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning
false
does not necessarily indicate that returned objects are independent instances. An implementation of the extendedSmartFactoryBean
interface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()
method. PlainFactoryBean
implementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()
implementation returnsfalse
.- 指定者:
isSingleton
在接口中FactoryBean<String>
- 返回:
- whether the exposed object is a singleton
- 另请参阅:
FactoryBean.getObject()
,SmartFactoryBean.isPrototype()