src/main/java/jp/sourceforge/stigmata/spi/BirthmarkExtractorSpi.java

   1 package jp.sourceforge.stigmata.spi;
   2
   3 /*
   4  * $Id$
   5  */
   6
   7 import java.util.Locale;
   8
   9 import jp.sourceforge.stigmata.BirthmarkExtractor;
  10
  11 /**
  12  * Service provider interface for extracting birhtmark from given class files.
  13  *
  14  * @author Haruaki TAMADA
  15  * @version $Revision$
  16  */
  17 public interface BirthmarkExtractorSpi extends ServiceProvider{
  18     /**
  19      * returns a type of the birthmark this service provides.
  20      */
  21     public String getType();
  22
  23     /**
  24      * returns a localized description of the birthmark this service provides.
  25      */
  26     @Override
  27     public String getDescription(Locale locale);
  28
  29     /**
  30      * returns a localized description of the birthmark in default locale.
  31      */
  32     @Override
  33     public String getDescription();
  34
  35     public String getExtractorClassName();
  36
  37     /**
  38      * returns a extractor for the birthmark of this service.
  39      */
  40     public BirthmarkExtractor getExtractor(BirthmarkSpi service);
  41 }
  42