/*
 * Copyright 2008 Google Inc.
 * 
 * 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.
 */
package com.google.gwt.benchmarks.client;

import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Documented;

/**
 * Specifies a setup method that will be executed before the annotated
 * {@link Benchmark} test method. Setup methods are automatically executed by
 * the benchmarking framework before their matching test methods. Setup
 * measurements are excluded from final benchmark reports.
 * 
 * <p>
 * For example, you might annotate a {@code Benchmark} method named
 * <code>testInserts</code> with {@code @Setup("setupTestInserts")} to ensure
 * <code>setupTestInserts</code>is always executed before
 * <code>testInserts</code>.
 * </p>
 */
@Target(ElementType.METHOD)
@Documented
public @interface Setup {

  /**
   * The name of the method to execute before the annotated test method.
   * 
   * @return for example, "setupTestInserts"
   */
  String value();
}