IndexedRDList.cs

Go to the documentation of this file.

// SmartAPI - .Net programmatic access to RedDot servers
//  
// Copyright (C) 2013 erminas GbR
// 
// This program is free software: you can redistribute it and/or modify it 
// under the terms of the GNU General Public License as published by the Free Software Foundation,
// either version 3 of the License, or (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License along with this program.
// If not, see <http://www.gnu.org/licenses/>.

using System;
using System.Collections.Generic;
using System.Linq;
using erminas.SmartAPI.CMS;

namespace erminas.SmartAPI.Utils.CachedCollections
{
    public interface IIndexedRDList<in TK, T> : IIndexedCachedList<TK, T>, IRDList<T> where T : class, IRedDotObject
    {
        new IIndexedRDList<TK, T> Refreshed();
        void WaitFor(Func<IIndexedRDList<TK, T>, bool> predicate, TimeSpan maxWait, TimeSpan retryEverySecond);
    }

    public class IndexedRDList<TK, T> : IndexedCachedList<TK, T>, IIndexedRDList<TK, T> where T : class, IRedDotObject
    {
        public IndexedRDList(Func<List<T>> retrieveFunc, Func<T, TK> indexFunc, Caching caching)
            : base(retrieveFunc, indexFunc, caching)
        {
        }

        protected IndexedRDList(Func<T, TK> indexFunc, Caching caching) : base(indexFunc, caching)
        {
        }

        public bool Contains(T element)
        {
            return ContainsGuid(element.Guid);
        }

        public bool ContainsGuid(Guid guid)
        {
            T tmp;
            return TryGetByGuid(guid, out tmp);
        }

        public bool ContainsName(string name)
        {
            T tmp;
            return TryGetByName(name, out tmp);
        }

        public virtual T GetByGuid(Guid guid)
        {
            EnsureListIsLoaded();
            return List.First(x => x.Guid == guid);
        }

        public virtual T GetByName(string name)
        {
            EnsureListIsLoaded();
            return List.First(x => x.Name == name);
        }

        public new IIndexedRDList<TK, T> Refreshed()
        {
            Refresh();
            return this;
        }

        public virtual bool TryGetByGuid(Guid guid, out T output)
        {
            EnsureListIsLoaded();
            output = List.FirstOrDefault(x => x.Guid == guid);
            return output != null;
        }

        public virtual bool TryGetByName(string name, out T output)
        {
            EnsureListIsLoaded();
            output = List.FirstOrDefault(x => x.Name == name);
            return output != null;
        }

        public void WaitFor(Func<IIndexedRDList<TK, T>, bool> predicate, TimeSpan maxWait, TimeSpan retryPeriod)
        {
            Wait.For(() => predicate(Refreshed()), maxWait, retryPeriod);
        }

        public void WaitFor(Predicate<IRDList<T>> predicate, TimeSpan maxWait, TimeSpan retryPeriod)
        {
            Wait.For(() => predicate(Refreshed()), maxWait, retryPeriod);
        }

        IRDList<T> IRDList<T>.Refreshed()
        {
            Refresh();
            return this;
        }
    }

    public class NameIndexedRDList<T> : IndexedRDList<String, T> where T : class, IRedDotObject
    {
        public NameIndexedRDList(Func<List<T>> retrieveFunc, Caching caching) : base(retrieveFunc, x => x.Name, caching)
        {
        }

        protected NameIndexedRDList(Caching caching) : base(x => x.Name, caching)
        {
        }

        public override T GetByName(string name)
        {
            return this[name];
        }

        public new NameIndexedRDList<T> Refreshed()
        {
            Refresh();
            return this;
        }

        public override bool TryGetByName(string name, out T output)
        {
            return TryGet(name, out output);
        }
    }

    public class GuidIndexedRDList<T> : IndexedRDList<Guid, T> where T : class, IRedDotObject
    {
        public GuidIndexedRDList(Func<List<T>> retrieveFunc, Caching caching) : base(retrieveFunc, x => x.Guid, caching)
        {
        }

        protected GuidIndexedRDList(Caching caching) : base(x => x.Guid, caching)
        {
        }

        public override T GetByGuid(Guid guid)
        {
            return this[guid];
        }

        public new GuidIndexedRDList<T> Refreshed()
        {
            Refresh();
            return this;
        }

        public override bool TryGetByGuid(Guid guid, out T output)
        {
            return TryGet(guid, out output);
        }
    }
}