org.camunda.bpm.engine.test.RequiredHistoryLevel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation

There is a newer version: 7.23.0-alpha1

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; 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 org.camunda.bpm.engine.test;

import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Annotation for a test method or class to specify the required history level.
 * If the current history level of the process engine is lower than the
 * specified one then the test method is skipped.
 *
 * Usage:
 *
 *  * package org.example;
 *
 * ...
 *
 * public class ExampleTest {
 *
 *   @RequiredHistoryLevel(ProcessEngineConfiguration.HISTORY_ACTIVITY)
 *   public void testWithHistory() {
 *
 *     // test something with the history service (e.g. variables)
 *   }
 * 
 */
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface RequiredHistoryLevel {

  /**
   * The required history level.
   */
  public String value();

}