common/device-side/bedstead/harrier/common/src/main/java/com/android/bedstead/harrier/annotations/meta/RequireRunOnProfileAnnotation.java

/*
 * Copyright (C) 2021 The Android Open Source Project
 *
 * 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.android.bedstead.harrier.annotations.meta;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Mark that an annotation is used to indicate that a test should run on a given profile type.
 *
 * <p>The annotation annotated with {@link RequireRunOnProfileAnnotation} must have the same body as
 * {@link RequireRunOnProfile}.
 */
@Target(ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface RequireRunOnProfileAnnotation {
    /** The name of the profile type which the test should be run on. */
    String value();

    /** If the profile type requires a profile owner. */
    boolean hasProfileOwner() default false;
}