You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
63 lines
3.0 KiB
63 lines
3.0 KiB
// Author: Gockner, Simon
|
|
// Created: 2020-02-12
|
|
// Copyright(c) 2020 SimonG. All Rights Reserved.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace GBase.Interfaces.DataHandling
|
|
{
|
|
/// <summary>
|
|
/// Interface for data handlers to implement
|
|
/// </summary>
|
|
public interface IDataHandler : IAsyncDisposable
|
|
{
|
|
/// <summary>
|
|
/// Initialize the <see cref="IDataHandler"/>
|
|
/// </summary>
|
|
/// <param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
|
|
/// <param name="cancellationToken">A <see cref="CancellationToken"/> to cancel the async operation</param>
|
|
/// <returns>Returns true if successful, false if not</returns>
|
|
Task<bool> Init(bool overwrite, CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Set the value for the given property
|
|
/// </summary>
|
|
/// <typeparam name="T">The <see cref="Type"/> of the property</typeparam>
|
|
/// <typeparam name="TProperty">The <see cref="Type"/> of the property</typeparam>
|
|
/// <param name="propertyName">The name of the property</param>
|
|
/// <param name="value">The value to set</param>
|
|
/// <returns>A <see cref="Task"/> to await</returns>
|
|
Task SetValue<T, TProperty>(string propertyName, TProperty value);
|
|
|
|
/// <summary>
|
|
/// Remove the value for the given property
|
|
/// </summary>
|
|
/// <typeparam name="T">The <see cref="Type"/> of the property</typeparam>
|
|
/// <typeparam name="TProperty">The <see cref="Type"/> of the property</typeparam>
|
|
/// <param name="propertyName">The name of the property</param>
|
|
/// <param name="value">The value to set</param>
|
|
/// <returns>A <see cref="Task"/> to await</returns>
|
|
Task RemoveValue<T, TProperty>(string propertyName, TProperty value);
|
|
|
|
/// <summary>
|
|
/// Get the value for the given property, if multiple values are set the first is returned
|
|
/// </summary>
|
|
/// <typeparam name="T">The <see cref="Type"/> of the property</typeparam>
|
|
/// <typeparam name="TProperty">The <see cref="Type"/> of the property</typeparam>
|
|
/// <param name="propertyName">The name of the property</param>
|
|
/// <returns>The value for the given property</returns>
|
|
Task<TProperty> GetValue<T, TProperty>(string propertyName);
|
|
|
|
/// <summary>
|
|
/// Get all the values that are set for the given property
|
|
/// </summary>
|
|
/// <typeparam name="T">The <see cref="Type"/> of the property</typeparam>
|
|
/// <typeparam name="TProperty">The <see cref="Type"/> of the property</typeparam>
|
|
/// <param name="propertyName">The name of the property</param>
|
|
/// <returns>An <see cref="IEnumerable{T}"/> with all the values for the property</returns>
|
|
Task<IEnumerable<TProperty>> GetValues<T, TProperty>(string propertyName);
|
|
}
|
|
} |