程序包 cn.taketoday.context.aware

类 ApplicationContextSupport

java.lang.Object

cn.taketoday.context.aware.ApplicationContextSupport

所有已实现的接口:

Aware, ApplicationContextAware

public abstract class ApplicationContextSupport
extends Object
implements ApplicationContextAware

Convenient superclass for application objects that want to be aware of the application context, e.g. for custom lookup of collaborating beans or for context-specific resource access. It saves the application context reference and provides an initialization callback method. Furthermore, it offers numerous convenience methods for message lookup.

从以下版本开始:

2019-12-21 15:45

作者:

TODAY

字段概要

字段

修饰符和类型	字段	说明
protected ApplicationContext	applicationContext
protected final cn.taketoday.logging.Logger	log
protected MessageSourceAccessor	messageSourceAccessor	MessageSourceAccessor for easy message access.

构造器概要

构造器

构造器	说明
ApplicationContextSupport()

方法概要

修饰符和类型	方法	说明
final ApplicationContext	getApplicationContext()	Return the ApplicationContext that this object is associated with.
protected final MessageSourceAccessor	getMessageSourceAccessor()	Return a MessageSourceAccessor for the application context used by this object, for easy message access.
protected void	initApplicationContext()	Subclasses can override this for custom initialization behavior.
protected void	initApplicationContext(ApplicationContext context)	Subclasses can override this for custom initialization behavior.
protected boolean	isContextRequired()	Determine whether this application object needs to run in an ApplicationContext.
ApplicationContext	obtainApplicationContext()	Return the ApplicationContext that this object is associated with.
protected Class<?>	requiredContextClass()	Determine the context class that any context passed to setApplicationContext must be an instance of.
final void	setApplicationContext(ApplicationContext context)	Set the ApplicationContext that this object runs in.
<T> T	unwrap(Class<T> requiredType)	unwrap this ApplicationContext to requiredType
<T> T	unwrapFactory(Class<T> requiredType)	unwrap bean-factory to requiredType

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

log

protected final cn.taketoday.logging.Logger log

applicationContext

@Nullable
protected ApplicationContext applicationContext

messageSourceAccessor

@Nullable
protected MessageSourceAccessor messageSourceAccessor

MessageSourceAccessor for easy message access. @since 4.0

构造器详细资料

ApplicationContextSupport

public ApplicationContextSupport()

方法详细资料

setApplicationContext

public final void setApplicationContext(@Nullable
 ApplicationContext context)
                                 throws BeansException

从接口复制的说明: ApplicationContextAware

Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.

Invoked after population of normal bean properties but before an init callback such as InitializingBean.afterPropertiesSet() or a custom init-method. Invoked after ResourceLoaderAware.setResourceLoader(cn.taketoday.core.io.ResourceLoader), ApplicationEventPublisherAware.setApplicationEventPublisher(cn.taketoday.context.ApplicationEventPublisher) and MessageSourceAware, if applicable.

指定者:

setApplicationContext 在接口中 ApplicationContextAware

参数:

context - the ApplicationContext object to be used by this object

抛出:

ApplicationContextException - in case of context initialization errors

BeansException - if thrown by application context methods

另请参阅:

• BeanInitializationException

initApplicationContext

protected void initApplicationContext(ApplicationContext context)

Subclasses can override this for custom initialization behavior. Gets called by setApplicationContext after setting the context instance.

Note: Does not get called on re-initialization of the context but rather just on first initialization of this object's context reference.

The default implementation calls the overloaded initApplicationContext() method without ApplicationContext reference.

参数:

context - the containing ApplicationContext

抛出:

ApplicationContextException - if thrown by ApplicationContext methods

另请参阅:

• setApplicationContext(cn.taketoday.context.ApplicationContext)

initApplicationContext

protected void initApplicationContext()

Subclasses can override this for custom initialization behavior.

The default implementation is empty. Called by initApplicationContext(ApplicationContext).

抛出:

ApplicationContextException - if thrown by ApplicationContext methods

另请参阅:

• setApplicationContext(cn.taketoday.context.ApplicationContext)

getApplicationContext

@Nullable
public final ApplicationContext getApplicationContext()
                                               throws IllegalStateException

Return the ApplicationContext that this object is associated with.

抛出:

IllegalStateException - if not running in an ApplicationContext

obtainApplicationContext

public ApplicationContext obtainApplicationContext()

Return the ApplicationContext that this object is associated with.

抛出:

IllegalStateException - if not running in an ApplicationContext

unwrapFactory

public <T> T unwrapFactory(Class<T> requiredType)

unwrap bean-factory to requiredType

抛出:

IllegalArgumentException - not a requiredType

从以下版本开始:

4.0

另请参阅:

• ApplicationContext.getBeanFactory()

unwrap

public <T> T unwrap(Class<T> requiredType)

unwrap this ApplicationContext to requiredType

抛出:

IllegalArgumentException - not a requiredType

从以下版本开始:

4.0

getMessageSourceAccessor

@Nullable
protected final MessageSourceAccessor getMessageSourceAccessor()
                                                        throws IllegalStateException

Return a MessageSourceAccessor for the application context used by this object, for easy message access.

抛出:

IllegalStateException - if not running in an ApplicationContext

从以下版本开始:

4.0

isContextRequired

protected boolean isContextRequired()

Determine whether this application object needs to run in an ApplicationContext.

Default is "false". Can be overridden to enforce running in a context (i.e. to throw IllegalStateException on accessors if outside a context).

从以下版本开始:

4.0

另请参阅:

• getApplicationContext()
• getMessageSourceAccessor()

requiredContextClass

protected Class<?> requiredContextClass()

Determine the context class that any context passed to setApplicationContext must be an instance of. Can be overridden in subclasses.

从以下版本开始:

4.0

另请参阅:

• setApplicationContext(cn.taketoday.context.ApplicationContext)