Actionを１回だけ実行できるようにしたい

概要

コールバックを別のオブジェクトに渡して呼び出してもらうようなときに、複数回呼んで欲しくない（１回呼び出したらコールバックそのものが消滅してほしい）場合に利用できるラッパークラスを作りました。

参考

１回だけ実行可能なコールバッククラス

/// <summary>
/// １度だけ実行可能なAction
/// </summary>
public class OnceAction
{
    private Action _Action;

    /// <summary>
    /// 空オブジェクト
    /// </summary>
    public static OnceAction Default = new OnceAction();

    /// <summary>
    /// 実行可能であればtrue
    /// </summary>
    public bool IsEnable => this._Action != null;

    /// <summary>
    /// １度だけ実行可能なAction
    /// </summary>
    private OnceAction()
    {
        this._Action = null;
    }

    /// <summary>
    /// １度だけ実行可能なAction
    /// </summary>
    public OnceAction(Action action)
    {
        this._Action = action;
    }

    /// <summary>
    /// 登録されたコールバックを呼び出す
    /// </summary>
    [MethodImpl(MethodImplOptions.Synchronized)]
    public void Invoke()
    {
        if (this._Action == null)
        {
            return;
        }

        this._Action.Invoke();
        this._Action = null;
    }
}

なんてことはない、１回呼び出したらActionへの参照を消してやるだけの簡単なラッパークラスです。
ですがActionの生成側で使用回数を制限できるのが便利です。利用側で呼び出した回数を管理したりActionへの参照を消したりするの面倒ですからね。

OnceAction.Defaultは、OnceAction型の変数なりプロパティなりの初期値として利用します。

Actionの場合は以下のように書けばnullアクセス違反にはならないが呼び出しても何も起きない状態にできました。

// こんな感じで初期化しておくと呼び出すときにnullチェック不用
private Action _Callback = delegate { };

しかし、OnceActionではいちいちインスタンスをnewで作らないといけなくなるので、その代わりとして作りました。

// こんな感じで初期化しておくとnullチェック不用
private OnceAction _Callback = OnceAction.Default;