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

   1 package jp.sourceforge.stigmata.spi;
   2
   3 /*
   4  * $Id$
   5  */
   6
   7 import java.util.Locale;
   8
   9 import jp.sourceforge.stigmata.Birthmark;
  10 import jp.sourceforge.stigmata.BirthmarkComparator;
  11 import jp.sourceforge.stigmata.BirthmarkElement;
  12 import jp.sourceforge.stigmata.BirthmarkExtractor;
  13 import jp.sourceforge.stigmata.BirthmarkPreprocessor;
  14
  15 /**
  16  * Birthmark service provider interface.
  17  *
  18  * @author Haruaki TAMADA
  19  * @version $Revision$
  20  */
  21 public interface BirthmarkSpi extends ServiceProvider{
  22     /**
  23      * returns a type of the birthmark this service provides.
  24      */
  25     public String getType();
  26
  27     /**
  28      * returns a type of the birthmark for display.
  29      */
  30     public String getDisplayType(Locale locale);
  31
  32     /**
  33      * returns a type of the birthmark for display in default locale.
  34      */
  35     public String getDisplayType();
  36
  37     /**
  38      * returns a description of the birthmark this service provides.
  39      */
  40     public String getDefaultDescription();
  41
  42     /**
  43      * returns a localized description of the birthmark this service provides.
  44      */
  45     public String getDescription(Locale locale);
  46
  47     /**
  48      * returns a localized description of the birthmark in default locale.
  49      */
  50     public String getDescription();
  51
  52     public String getExtractorClassName();
  53
  54     public Birthmark buildBirthmark();
  55
  56     public BirthmarkElement buildBirthmarkElement(String elementValue);
  57
  58     public BirthmarkPreprocessor getPreprocessor();
  59
  60     public String getPreprocessorClassName();
  61
  62     /**
  63      * returns a extractor for the birthmark of this service.
  64      */
  65     public BirthmarkExtractor getExtractor();
  66
  67     public String getComparatorClassName();
  68
  69     /**
  70      * returns a comparator for the birthmark of this service.
  71      */
  72     public BirthmarkComparator getComparator();
  73
  74     public boolean isExperimental();
  75
  76     public boolean isUserDefined();
  77
  78 }
  79