smart-exim/smart-exim-api/src/main/java/com/smartitengineering/exim/ClassConfigScanner.java

   1 /*
   2  * This is a common dao with basic CRUD operations and is not limited to any
   3  * persistent layer implementation
   4  *
   5  * Copyright (C) 2008  Imran M Yousuf (imyousuf@smartitengineering.com)
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 3 of the License, or (at your option) any later version.
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19 package com.smartitengineering.exim;
  20
  21 /**
  22  * A config registrar only able to scan classes
  23  * @author imyousuf
  24  * @since 0.4
  25  */
  26 public interface ClassConfigScanner
  27     extends ConfigScanner {
  28
  29     /**
  30      * Retrieves the configuration for the resource class, if its not already
  31      * generated then it will search the package of the class and generate its
  32      * configuraiton.
  33      * @param resourceClass The class to scanClassForConfig retrieve configuration for
  34      * @return Configuration for the resource; NULL if no resource is available
  35      *          or generateable
  36      * @throws IllegalArgumentException If resource class is null!
  37      */
  38     public EximResourceConfig getResourceConfigForClass(
  39         final Class resourceClass);
  40 }