Home | History | Annotate | Download | only in annotations
      1 package org.testng.annotations;
      2 
      3 /**
      4  * Encapsulate the @Configuration / @testng.configuration annotation
      5  *
      6  * Created on Dec 20, 2005
      7  * @author <a href="mailto:cedric (at) beust.com">Cedric Beust</a>
      8  */
      9 public interface IConfigurationAnnotation extends ITestOrConfiguration {
     10   /**
     11    * If true, the annotated method will be run after the test class is instantiated
     12    * and before the test method is invoked.
     13    */
     14   public boolean getBeforeTestClass();
     15 
     16   /**
     17    * If true, the annotated method will be run after all the tests in the test
     18    * class have been run.
     19    */
     20   public boolean getAfterTestClass();
     21 
     22   /**
     23    * If true, the annotated method will be run before any test method is invoked.
     24    */
     25   public boolean getBeforeTestMethod();
     26 
     27   /**
     28    * If true, the annotated method will be run after any test method is invoked.
     29    */
     30   public boolean getAfterTestMethod();
     31 
     32   /**
     33    * If true, the annotated method will be run before this suite starts.
     34    */
     35   public boolean getBeforeSuite();
     36 
     37   /**
     38    * If true, the annotated method will be run after all tests in this suite
     39    * have run.
     40    */
     41   public boolean getAfterSuite();
     42 
     43   /**
     44    * If true, the annotated method will be run before every test
     45    */
     46   public boolean getBeforeTest();
     47 
     48   /**
     49    * If true, the annotated method will be run after all every test.
     50    */
     51   public boolean getAfterTest();
     52 
     53   /**
     54    * Used only for after type of configuration methods. If set to true than
     55    * the configuration method will be run whatever the status of before
     56    * configuration methods was.
     57    */
     58   public boolean getAlwaysRun();
     59 
     60   /**
     61    * If true, this @Configuration method will belong to groups specified in the
     62    * \@Test annotation on the class (if any).
     63    */
     64   public boolean getInheritGroups();
     65 
     66   /**
     67    * The list of groups that this configuration method will run before.
     68    */
     69   public String[] getBeforeGroups();
     70 
     71   /**
     72    * The list of groups that this configuration method will run after.
     73    */
     74   public String[] getAfterGroups();
     75 
     76   /**
     77    * Internal use only.
     78    * @return true if this configuration annotation is not a "true" configuration
     79    * annotation but a @BeforeSuite or similar that is represented as a configuration
     80    * annotation.
     81    */
     82   public boolean isFakeConfiguration();
     83 }
     84