io.appium.java_client.pagefactory.WithTimeout Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

Java client for Appium Mobile Webdriver

There is a newer version: 9.3.0

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * 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 io.appium.java_client.pagefactory;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.time.Duration;
import java.time.temporal.ChronoUnit;

/**
 * This annotation is used when some element waits for time
 * that differs from defined by default.
 */
@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD})
public @interface WithTimeout {
    /**
     * Desired waiting duration.
     *
     * @return waiting duration
     */
    long time();

    /**
     * Desired time unit.
     *
     * @return time unit.
     */
    ChronoUnit chronoUnit();

    class DurationBuilder {
        private DurationBuilder() {
        }

        static Duration build(WithTimeout withTimeout) {
            return Duration.of(withTimeout.time(), withTimeout.chronoUnit());
        }
    }
}