File: IObjectFactory.cs

package info (click to toggle)
mono 4.6.2.7+dfsg-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 778,148 kB
  • ctags: 914,052
  • sloc: cs: 5,779,509; xml: 2,773,713; ansic: 432,645; sh: 14,749; makefile: 12,361; perl: 2,488; python: 1,434; cpp: 849; asm: 531; sql: 95; sed: 16; php: 1
file content (150 lines) | stat: -rw-r--r-- 5,791 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
#region MIT license
// 
// MIT license
//
// Copyright (c) 2007-2008 Jiri Moudry, Pascal Craponne
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
// 
#endregion
using System;
using System.Collections.Generic;

namespace DbLinq.Factory
{
    /// <summary>
    /// The object factory is the start point for DbLinq main factory.
    /// See ObjectFactory.Current for details
    /// </summary>
#if !MONO_STRICT
    public
#endif
    interface IObjectFactory
    {
        /// <summary>
        ///  Registers <paramref name="implementationType" /> as an 
        ///  implementation for all implemented interfaces.
        /// </summary>
        /// <param name="implementationType">
        ///  A <see cref="T:System.Type" /> which is the implementation type
        ///  to register.
        /// </param>
        /// <remarks>
        ///  Once this method has been called, 
        ///  <paramref name="implementationType" /> may be used in future
        ///  <see cref="M:Create(Type)" /> and <see cref="M:Get(Type)" />
        ///  invocations.
        /// </remarks>
        void Register(Type implementationType);

        /// <summary>
        ///  Unregisters <paramref name="implementationType" /> as an 
        ///  implementation for all implemented interfaces.
        /// </summary>
        /// <param name="implementationType">
        ///  A <see cref="T:System.Type" /> which is the implementation type
        ///  to unregister.
        /// </param>
        /// <remarks>
        ///  Once this method has been called, 
        ///  <paramref name="implementationType" /> will no longer be used by
        ///  subsequent <see cref="M:Create(Type)" /> and 
        ///  <see cref="M:Get(Type)" /> invocations.
        /// </remarks>
        void Unregister(Type implementationType);

        /// <summary>
        /// Returns an instance of a stateless class (may be a singleton)
        /// </summary>
        /// <returns>
        ///  An instance of type <paramref name="interfaceType" />.
        ///  This instance will be shared by other invocations of 
        ///  <c>Get()</c> with the same <param name="interfaceType" /> value.
        /// </returns>
        object Get(Type interfaceType);

        /// <summary>
        /// Returns a new instance of the specified class (can not be a singleton)
        /// </summary>
        /// <returns>
        ///  A new instance of type <paramref name="interfaceType" />.
        ///  This instance will not be shared by other invocations of 
        ///  <c>Create()</c> with the same <param name="interfaceType" /> 
        ///  value.
        /// </returns>
        object Create(Type interfaceType);

        /// <summary>
        /// Returns a list of types implementing the required interface
        /// </summary>
        /// <param name="interfaceType"></param>
        /// <returns>
        ///  An <see cref="T:IEnumerable{Type}" /> containing all registered 
        ///  implementations for the interface 
        ///  <paramref name="interfaceType" />.
        /// </returns>
        IEnumerable<Type> GetImplementations(Type interfaceType);
    }

    /// <summary>
    ///  Extension methods for <see cref="T:IObjectFactory" />.
    /// </summary>
#if !MONO_STRICT
    public
#endif
    static class ObjectFactoryExtensions
    {
        /// <summary>
        ///  Creates a new instance of <typeparamref name="T" /> from 
        ///  <paramref name="self" />.
        /// </summary>
        /// <typeparam name="T">The type to create.</typeparam>
        /// <param name="self">
        ///  An <see cref="T:IObjectFactory" /> to use to create a new instance
        ///  of type <typeparamref name="T" />.
        /// </param>
        /// <returns>
        ///  A newly created instance of type <typeparamref name="T" />.
        /// </returns>
        /// <seealso cref="M:IObjectFactory.Create(Type)"/>
        public static T Create<T>(this IObjectFactory self)
        {
            return (T) self.Create(typeof(T));
        }

        /// <summary>
        ///  Gets a (possibly pre-existing) instance of 
        ///  <typeparamref name="T" /> from <paramref name="self" />.
        /// </summary>
        /// <typeparam name="T">The type to get.</typeparam>
        /// <param name="self">
        ///  An <see cref="T:IObjectFactory" /> to use to get an instance
        ///  of type <typeparamref name="T" />.
        /// </param>
        /// <returns>
        ///  A (possibly pre-existing) instance of type 
        ///  <typeparamref name="T" />.
        /// </returns>
        /// <seealso cref="M:IObjectFactory.Get(Type)"/>
        public static T Get<T>(this IObjectFactory self)
        {
            return (T) self.Get(typeof(T));
        }
    }
}