wamblee.org Git - utils/blob - support/general/src/main/java/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  * @author Erik Brakkee
  22  */
  23 public interface BeanFactory {
  24
  25     /**
  26      * Finds a bean based on id.
  27      * @param aId Id of the bean.
  28      * @return Object  (always non-null).
  29      * @throws BeanFactoryException In case the object could not be found.
  30      */
  31     Object find(String aId);
  32
  33     /**
  34      * Finds a bean of the given class and which can be cast to the
  35      * specified class. This is typically used by specifying the interface
  36      * class for retrieving an implementation of that class. This
  37      * means that the bean implementing the class is configured in the bean factory
  38      * with id equal to the class name of the interface.
  39      * @param aClass Class of the object to find.
  40      * @return Object (always non-null).
  41      * @throws BeanFactoryException In case the object could not be found.
  42      */
  43      <T> T find(Class<T> aClass);
  44
  45      /**
  46       * Finds a bean with the given id which can be cast to the specified
  47       * class.
  48       * @param <T> Type of the object to get.
  49       * @param aId Id of the object to lookup.
  50       * @param aClass Class that the object must extends.
  51       * @return Object, always non-null.
  52       * @throws BeanFactoryException In case the object could not be found.
  53       */
  54      <T> T find(String aId, Class<T> aClass);
  55 }