dotnet/src/webdriver/Interactions/InputDevice.cs

// <copyright file="InputDevice.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.Collections.Generic;
using System.Globalization;

namespace OpenQA.Selenium.Interactions;

/// <summary>
/// Base class for all input devices for actions.
/// </summary>
public abstract class InputDevice
{
    /// <summary>
    /// Initializes a new instance of the <see cref="InputDevice"/> class.
    /// </summary>
    /// <param name="deviceName">The unique name of the input device represented by this class.</param>
    /// <exception cref="ArgumentException">If <paramref name="deviceName"/> is <see langword="null"/> or <see cref="string.Empty"/>.</exception>
    protected InputDevice(string deviceName)
    {
        if (string.IsNullOrEmpty(deviceName))
        {
            throw new ArgumentException("Device name must not be null or empty", nameof(deviceName));
        }

        this.DeviceName = deviceName;
    }

    /// <summary>
    /// Gets the unique name of this input device.
    /// </summary>
    public string DeviceName { get; }

    /// <summary>
    /// Gets the kind of device for this input device.
    /// </summary>
    public abstract InputDeviceKind DeviceKind { get; }

    /// <summary>
    /// Returns a value for this input device that can be transmitted across the wire to a remote end.
    /// </summary>
    /// <returns>A <see cref="Dictionary{TKey, TValue}"/> representing this action.</returns>
    public abstract Dictionary<string, object> ToDictionary();

    /// <summary>
    /// Creates a pause action for synchronization with other action sequences.
    /// </summary>
    /// <returns>The <see cref="Interaction"/> representing the action.</returns>
    public Interaction CreatePause()
    {
        return this.CreatePause(TimeSpan.Zero);
    }

    /// <summary>
    /// Creates a pause action for synchronization with other action sequences.
    /// </summary>
    /// <param name="duration">A <see cref="TimeSpan"/> representing the duration
    /// of the pause. Note that <see cref="TimeSpan.Zero"/> pauses to synchronize
    /// with other action sequences for other devices.</param>
    /// <returns>The <see cref="Interaction"/> representing the action.</returns>
    /// <exception cref="ArgumentException">If <paramref name="duration"/> is negative.</exception>
    public Interaction CreatePause(TimeSpan duration)
    {
        return new PauseInteraction(this, duration);
    }

    /// <summary>
    /// Returns a hash code for the current <see cref="InputDevice"/>.
    /// </summary>
    /// <returns>A hash code for the current <see cref="InputDevice"/>.</returns>
    public override int GetHashCode()
    {
        return this.DeviceName.GetHashCode();
    }

    /// <summary>
    /// Returns a string that represents the current <see cref="InputDevice"/>.
    /// </summary>
    /// <returns>A string that represents the current <see cref="InputDevice"/>.</returns>
    public override string ToString()
    {
        return string.Format(CultureInfo.InvariantCulture, "{0} input device [name: {1}]", this.DeviceKind, this.DeviceName);
    }
}