﻿// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF 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.

using System;

namespace Org.Apache.REEF.Wake.Util
{
    /// <summary>
    /// Generates IDisposables from a factory method
    /// </summary>
    internal sealed class Disposable : IDisposable
    {
        private readonly Action _disposeFunction;
        private readonly bool _disposed;

        private Disposable(Action disposeFunction)
        {
            _disposeFunction = disposeFunction;
            _disposed = false;
        }

        /// <summary>
        /// Factory method to create an IDisposable from a function.
        /// </summary>
        /// <param name="disposeFunction">The function to call when disposing</param>
        /// <returns>An IDisposable from the given dispose function</returns>
        public static IDisposable Create(Action disposeFunction)
        {
            return new Disposable(disposeFunction); 
        }

        /// <summary>
        /// Dispose of resources by calling the supplied dispose function
        /// </summary>
        public void Dispose()
        {
            if (!_disposed)
            {
                _disposeFunction();
            }
        }
    }
}