Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.PluginInfrastructure/Interfaces/IApplicationManager.cs @ 2592

Last change on this file since 2592 was 2592, checked in by gkronber, 14 years ago

Merged missing changes (r2587, r2589) in plugin infrastructure from branch to trunk. #799

File size: 3.9 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
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
22using System;
23using System.Collections.Generic;
24using System.Text;
25using System.Windows.Forms;
26using System.Reflection;
27
28namespace HeuristicLab.PluginInfrastructure {
29  /// <summary>
30  /// Interface for application managers.
31  /// </summary>
32  public interface IApplicationManager {
33    /// <summary>
34    /// Gets all discovered plugins.
35    /// </summary>
36    IEnumerable<IPluginDescription> Plugins { get; }
37    /// <summary>
38    /// Gets all discovered applications.
39    /// </summary>
40    IEnumerable<IApplicationDescription> Applications { get; }
41
42    /// <summary>
43    /// Discovers and creates instances of <typeparamref name="T"/> and all types implementing or inheriting <typeparamref name="T"/> (directly and indirectly) declared in any assembly of <paramref name="plugin"/>.
44    /// </summary>
45    /// <typeparam name="T">The type or super-type to discover.</typeparam>
46    /// <param name="plugin">The declaring plugin.</param>
47    /// <returns>An enumerable of instances of the discovered types.</returns>
48    IEnumerable<T> GetInstances<T>(IPluginDescription plugin) where T : class;
49    /// <summary>
50    /// Discovers and creates instances of <typeparamref name="T"/> and all types implementing or inheriting <typeparamref name="T"/> (directly and indirectly).
51    /// </summary>
52    /// <typeparam name="T">The type or super-type to discover.</typeparam>
53    /// <returns>An enumerable of instances of the discovered types.</returns>
54    IEnumerable<T> GetInstances<T>() where T : class;
55
56    /// <summary>
57    /// Discovers and creates instances of <paramref name="type"/> and all types implementing or inheriting <paramref name="type"/> (directly and indirectly).
58    /// </summary>
59    /// <param name="type">The type or super-type to discover.</typeparam>
60    /// <returns>An enumerable of instances of the discovered types.</returns>
61    IEnumerable<object> GetInstances(Type type);
62
63    /// <summary>
64    /// Discovers all types implementing or inheriting <paramref name="type"/> (directly and indirectly).
65    /// </summary>
66    /// <param name="type">The type to discover.</param>
67    /// <returns>An enumerable of discovered types.</returns>
68    IEnumerable<Type> GetTypes(Type type);
69    /// <summary>
70    /// Discovers all types implementing or inheriting <paramref name="type"/> (directly and indirectly) that are declaed in any assembly of <paramref name="plugin"/>.
71    /// </summary>
72    /// <param name="type">The type to discover.</param>
73    /// <param name="plugin">The declaring plugin.</param>
74    /// <returns>An enumerable of discovered types.</returns>
75    IEnumerable<Type> GetTypes(Type type, IPluginDescription plugin);
76    /// <summary>
77    /// Finds the plugin that declares the <paramref name="type">type</paramref>.
78    /// </summary>
79    /// <param name="type">The type of interest.</param>
80    /// <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>
81    IPluginDescription GetDeclaringPlugin(Type type);
82  }
83}
Note: See TracBrowser for help on using the repository browser.