// <copyright file="ICookieJar.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.ObjectModel;

namespace OpenQA.Selenium;

/// <summary>
/// Defines an interface allowing the user to manipulate cookies on the current page.
/// </summary>
public interface ICookieJar
{
    /// <summary>
    /// Gets all cookies defined for the current page.
    /// </summary>
    ReadOnlyCollection<Cookie> AllCookies { get; }

    /// <summary>
    /// Adds a cookie to the current page.
    /// </summary>
    /// <param name="cookie">The <see cref="Cookie"/> object to be added.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="cookie"/> is <see langword="null"/>.</exception>
    void AddCookie(Cookie cookie);

    /// <summary>
    /// Gets a cookie with the specified name.
    /// </summary>
    /// <param name="name">The name of the cookie to retrieve.</param>
    /// <returns>The <see cref="Cookie"/> containing the name. Returns <see langword="null"/>
    /// if no cookie with the specified name is found.</returns>
    /// <exception cref="ArgumentException">If <paramref name="name"/> is <see langword="null"/> or <see cref="string.Empty"/>.</exception>
    Cookie? GetCookieNamed(string name);

    /// <summary>
    /// Deletes the specified cookie from the page.
    /// </summary>
    /// <param name="cookie">The <see cref="Cookie"/> to be deleted.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="cookie"/> is <see langword="null"/>.</exception>
    void DeleteCookie(Cookie cookie);

    /// <summary>
    /// Deletes the cookie with the specified name from the page.
    /// </summary>
    /// <param name="name">The name of the cookie to be deleted.</param>
    /// <exception cref="ArgumentException">If <paramref name="name"/> is <see langword="null"/> or <see cref="string.Empty"/>.</exception>
    void DeleteCookieNamed(string name);

    /// <summary>
    /// Deletes all cookies from the page.
    /// </summary>
    void DeleteAllCookies();
}
