// <copyright file="IWait{T}.cs" company="Selenium Committers">
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you 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.
// </copyright>

using System;
using System.Diagnostics.CodeAnalysis;

namespace OpenQA.Selenium.Support.UI;

/// <summary>
/// Interface describing a class designed to wait for a condition.
/// </summary>
/// <typeparam name="T">The type of object used to detect the condition.</typeparam>
public interface IWait<T>
{
    /// <summary>
    /// Gets or sets how long to wait for the evaluated condition to be true.
    /// </summary>
    TimeSpan Timeout { get; set; }

    /// <summary>
    /// Gets or sets how often the condition should be evaluated.
    /// </summary>
    TimeSpan PollingInterval { get; set; }

    /// <summary>
    /// Gets or sets the message to be displayed when time expires.
    /// </summary>
    string Message { get; set; }

    /// <summary>
    /// Configures this instance to ignore specific types of exceptions while waiting for a condition.
    /// Any exceptions not whitelisted will be allowed to propagate, terminating the wait.
    /// </summary>
    /// <param name="exceptionTypes">The types of exceptions to ignore.</param>
    void IgnoreExceptionTypes(params Type[] exceptionTypes);

    /// <summary>
    /// Waits until a condition is true or times out.
    /// </summary>
    /// <typeparam name="TResult">The type of result to expect from the condition.</typeparam>
    /// <param name="condition">A delegate taking a TSource as its parameter, and returning a TResult.</param>
    /// <returns>If TResult is a boolean, the method returns <see langword="true"/> when the condition is true, and <see langword="false"/> otherwise.
    /// If TResult is an object, the method returns the object when the condition evaluates to a value other than <see langword="null"/>.</returns>
    /// <exception cref="ArgumentException">Thrown when TResult is not boolean or an object type.</exception>
    [return: NotNull]
    TResult Until<TResult>(Func<T, TResult?> condition);
}
