RequiresDisplay.kt

/*
 * Copyright (C) 2022 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 androidx.test.espresso.device.filter

import androidx.test.annotation.ExperimentalTestApi
import androidx.test.espresso.device.sizeclass.HeightSizeClass.Companion.HeightSizeClassEnum
import androidx.test.espresso.device.sizeclass.WidthSizeClass.Companion.WidthSizeClassEnum
import androidx.test.filters.CustomFilter

/**
 * Indicates that a specific test should not be run on a device that does not have the provided
 * display attributes.
 *
 * <p>This API is experimental and subject to change or removal.
 */
@ExperimentalTestApi
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
@CustomFilter(filterClass = RequiresDisplayFilter::class)
annotation class RequiresDisplay(
  val widthSizeClass: WidthSizeClassEnum,
  val heightSizeClass: HeightSizeClassEnum
)