1 /*
2  * Copyright (C) 2021 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.bedstead.harrier.annotations;
18 
19 import com.android.bedstead.harrier.DeviceState;
20 
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25 
26 /**
27  * Replacement for {@link org.junit.BeforeClass} for use by classes which use {@link DeviceState}.
28  *
29  * <p>Methods annotated {@link BeforeClass} must be public, static, must return {@code void}, and
30  * must take no arguments.
31  *
32  * <p>The annotated method will be called before any tests, once per class. Class-level Bedstead
33  * annotations will be processed before running the method, and if any assumptions are violated the
34  * method will not be run.
35  *
36  * <p>If there are multiple methods annotated {@code @BeforeClass} there is no guarantee as to the
37  * order they will be executed.
38  */
39 @Retention(RetentionPolicy.RUNTIME)
40 @Target(ElementType.METHOD)
41 public @interface BeforeClass {
42 }
43