[2488] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[11171] | 3 | * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
---|
[2488] | 4 | *
|
---|
| 5 | * This file is part of HeuristicLab.
|
---|
| 6 | *
|
---|
| 7 | * HeuristicLab is free software: you can redistribute it and/or modify
|
---|
| 8 | * it under the terms of the GNU General Public License as published by
|
---|
| 9 | * the Free Software Foundation, either version 3 of the License, or
|
---|
| 10 | * (at your option) any later version.
|
---|
| 11 | *
|
---|
| 12 | * HeuristicLab is distributed in the hope that it will be useful,
|
---|
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
| 15 | * GNU General Public License for more details.
|
---|
| 16 | *
|
---|
| 17 | * You should have received a copy of the GNU General Public License
|
---|
| 18 | * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
|
---|
| 19 | */
|
---|
| 20 | #endregion
|
---|
| 21 |
|
---|
| 22 | using System;
|
---|
| 23 | using System.Collections.Generic;
|
---|
| 24 |
|
---|
| 25 | namespace HeuristicLab.PluginInfrastructure {
|
---|
| 26 | /// <summary>
|
---|
| 27 | /// Interface for application managers.
|
---|
| 28 | /// </summary>
|
---|
| 29 | public interface IApplicationManager {
|
---|
[2504] | 30 | /// <summary>
|
---|
| 31 | /// Gets all discovered plugins.
|
---|
| 32 | /// </summary>
|
---|
[2488] | 33 | IEnumerable<IPluginDescription> Plugins { get; }
|
---|
[2642] | 34 |
|
---|
[2504] | 35 | /// <summary>
|
---|
| 36 | /// Gets all discovered applications.
|
---|
| 37 | /// </summary>
|
---|
[2488] | 38 | IEnumerable<IApplicationDescription> Applications { get; }
|
---|
| 39 |
|
---|
[2504] | 40 | /// <summary>
|
---|
| 41 | /// Discovers and creates instances of <typeparamref name="T"/> and all types implementing or inheriting <typeparamref name="T"/> (directly and indirectly).
|
---|
| 42 | /// </summary>
|
---|
| 43 | /// <typeparam name="T">The type or super-type to discover.</typeparam>
|
---|
| 44 | /// <returns>An enumerable of instances of the discovered types.</returns>
|
---|
[2488] | 45 | IEnumerable<T> GetInstances<T>() where T : class;
|
---|
| 46 |
|
---|
[2504] | 47 | /// <summary>
|
---|
[2592] | 48 | /// Discovers and creates instances of <paramref name="type"/> and all types implementing or inheriting <paramref name="type"/> (directly and indirectly).
|
---|
| 49 | /// </summary>
|
---|
[3092] | 50 | /// <param name="type">The type or super-type to discover.</param>
|
---|
[2592] | 51 | /// <returns>An enumerable of instances of the discovered types.</returns>
|
---|
| 52 | IEnumerable<object> GetInstances(Type type);
|
---|
| 53 |
|
---|
| 54 | /// <summary>
|
---|
[2504] | 55 | /// Discovers all types implementing or inheriting <paramref name="type"/> (directly and indirectly).
|
---|
| 56 | /// </summary>
|
---|
| 57 | /// <param name="type">The type to discover.</param>
|
---|
[5850] | 58 | /// <param name="onlyInstantiable">Return only types that are instantiable (instance, abstract... are not returned)</param>
|
---|
[2504] | 59 | /// <returns>An enumerable of discovered types.</returns>
|
---|
[7111] | 60 | IEnumerable<Type> GetTypes(Type type, bool onlyInstantiable = true, bool includeGenericTypeDefinitions = false);
|
---|
[2642] | 61 |
|
---|
[2504] | 62 | /// <summary>
|
---|
[5850] | 63 | /// Discovers all types implementing or inheriting all or any type in <paramref name="types"/> (directly and indirectly).
|
---|
[2642] | 64 | /// </summary>
|
---|
[5850] | 65 | /// <param name="types">The types to discover.</param>
|
---|
[2642] | 66 | /// <param name="onlyInstantiable">Return only types that are instantiable (instance, abstract... are not returned)</param>
|
---|
[5903] | 67 | /// <param name="assignableToAllTypes">Specifies if discovered types must implement or inherit all given <paramref name="types"/>.</param>
|
---|
[2642] | 68 | /// <returns>An enumerable of discovered types.</returns>
|
---|
[7111] | 69 | IEnumerable<Type> GetTypes(IEnumerable<Type> types, bool onlyInstantiable = true, bool includeGenericTypeDefinitions = false, bool assignableToAllTypes = true);
|
---|
[2642] | 70 |
|
---|
| 71 | /// <summary>
|
---|
[2504] | 72 | /// Discovers all types implementing or inheriting <paramref name="type"/> (directly and indirectly) that are declaed in any assembly of <paramref name="plugin"/>.
|
---|
| 73 | /// </summary>
|
---|
| 74 | /// <param name="type">The type to discover.</param>
|
---|
| 75 | /// <param name="plugin">The declaring plugin.</param>
|
---|
[5850] | 76 | /// <param name="onlyInstantiable">Return only types that are instantiable (instance, abstract... are not returned)</param>
|
---|
[2504] | 77 | /// <returns>An enumerable of discovered types.</returns>
|
---|
[7111] | 78 | IEnumerable<Type> GetTypes(Type type, IPluginDescription plugin, bool onlyInstantiable = true, bool includeGenericTypeDefinitions = false);
|
---|
[2642] | 79 |
|
---|
[2592] | 80 | /// <summary>
|
---|
[5850] | 81 | /// Discovers all types implementing or inheriting all or any type in <paramref name="types"/> (directly and indirectly) that are declaed in any assembly of <paramref name="plugin"/>.
|
---|
[2642] | 82 | /// </summary>
|
---|
[5850] | 83 | /// <param name="types">The types to discover.</param>
|
---|
[2642] | 84 | /// <param name="plugin">The declaring plugin.</param>
|
---|
| 85 | /// <param name="onlyInstantiable">Return only types that are instantiable (instance, abstract... are not returned)</param>
|
---|
[5903] | 86 | /// /// <param name="assignableToAllTypes">Specifies if discovered types must implement or inherit all given <paramref name="types"/>.</param>
|
---|
[2642] | 87 | /// <returns>An enumerable of discovered types.</returns>
|
---|
[7111] | 88 | IEnumerable<Type> GetTypes(IEnumerable<Type> types, IPluginDescription plugin, bool onlyInstantiable = true, bool includeGenericTypeDefinitions = false, bool assignableToAllTypes = true);
|
---|
[2642] | 89 |
|
---|
| 90 | /// <summary>
|
---|
[2592] | 91 | /// Finds the plugin that declares the <paramref name="type">type</paramref>.
|
---|
| 92 | /// </summary>
|
---|
| 93 | /// <param name="type">The type of interest.</param>
|
---|
| 94 | /// <returns>The description of the plugin that declares the given type or null if the type has not been declared by a known plugin.</returns>
|
---|
| 95 | IPluginDescription GetDeclaringPlugin(Type type);
|
---|
[2488] | 96 | }
|
---|
| 97 | }
|
---|