//  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
//
//   Copyright 2016-2018 Pascal ECHEMANN.
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.

/**
 * The <code>AnnotatedMethodParams</code> interface defines the API you must 
 * implement to create objects passed as parameter of the JUTA
 * <code>@Before<code>, <code>@After<code>, <code>@BeforeAll<code> and
 * <code>@AfterAll<code> decorators.
 */
export interface AnnotatedMethodParams {
  
  /**
   * The timeout for an asynchronous annotated method.
   */
  timeout?:number;
  
  /**
   * Defines whether the annotated method is asynchronous (<code>true</code>),
   * or not (<code>false</code>).
   */
  async?:boolean;

  /**
   * Indicates whether a test method has to be ignored (<code>true</code>), or
   * not (<code>false</code>).
   */
  disabled?: boolean;
}