wamblee.org Git - utils/blob - support/src/org/wamblee/general/BeanFactory.java

   1 /*
   2  * Copyright 2005 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.general;
  17
  18 /**
  19  * Bean factory used to obtain objects in a transparent way.
  20  */
  21 public interface BeanFactory {
  22
  23     /**
  24      * Finds a bean based on id.
  25      * @param aId Id of the bean.
  26      * @return Object  (always non-null).
  27      * @throws BeanFactoryException In case the object could not be found.
  28      */
  29     Object find(String aId);
  30
  31     /**
  32      * Finds a bean of the given class and which can be cast to the
  33      * specified class. This is typically used by specifying the interface
  34      * class for retrieving an implementation of that class. This
  35      * means that the bean implementing the class is configured in the bean factory
  36      * with id equal to the class name of the interface.
  37      * @param aClass
  38      * @return Object (always non-null).
  39      * @throws BeanFactoryException In case the object could not be found.
  40      */
  41      <T> T find(Class<T> aClass);
  42
  43      /**
  44       * Finds a bean with the given id which can be cast to the specified
  45       * class.
  46       * @param <T> Type of the object to get.
  47       * @param aId Id of the object to lookup.
  48       * @param aClass Class that the object must extends.
  49       * @return Object, always non-null.
  50       * @throws BeanFactoryException In case the object could not be found.
  51       */
  52      <T> T find(String aId, Class<T> aClass);
  53 }