Open Source Repository

Home /spring/spring-beans-3.0.5 | Repository Home



org/springframework/beans/factory/BeanFactoryAware.java
/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.beans.factory;

import org.springframework.beans.BeansException;

/**
 * Interface to be implemented by beans that wish to be aware of their
 * owning {@link BeanFactory}.
 *
 <p>For example, beans can look up collaborating beans via the factory
 * (Dependency Lookup). Note that most beans will choose to receive references
 * to collaborating beans via corresponding bean properties or constructor
 * arguments (Dependency Injection).
 *
 <p>For a list of all bean lifecycle methods, see the
 {@link BeanFactory BeanFactory javadocs}.
 *
 @author Rod Johnson
 @since 11.03.2003
 @see BeanNameAware
 @see BeanClassLoaderAware
 @see InitializingBean
 @see org.springframework.context.ApplicationContextAware
 */
public interface BeanFactoryAware {

  /**
   * Callback that supplies the owning factory to a bean instance.
   <p>Invoked after the population of normal bean properties
   * but before an initialization callback such as
   {@link InitializingBean#afterPropertiesSet()} or a custom init-method.
   @param beanFactory owning BeanFactory (never <code>null</code>).
   * The bean can immediately call methods on the factory.
   @throws BeansException in case of initialization errors
   @see BeanInitializationException
   */
  void setBeanFactory(BeanFactory beanFactorythrows BeansException;

}