-
Notifications
You must be signed in to change notification settings - Fork 623
/
ICodecFactory.cs
42 lines (40 loc) · 1.8 KB
/
ICodecFactory.cs
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
using Lucene.Net.Util;
namespace Lucene.Net.Codecs
{
/*
* 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.
*/
/// <summary>
/// Contract for extending the functionality of <see cref="Codec"/> implementations so
/// they can be injected with dependencies.
/// <para/>
/// To set the <see cref="ICodecFactory"/>, call <see cref="Codec.SetCodecFactory(ICodecFactory)"/>.
/// <para/>
/// See the <see cref="Lucene.Net.Codecs"/> namespace documentation for some common usage examples.
/// </summary>
/// <seealso cref="DefaultCodecFactory"/>
/// <seealso cref="IServiceListable"/>
// LUCENENET specific
public interface ICodecFactory
{
/// <summary>
/// Gets the <see cref="Codec"/> instance from the provided <paramref name="name"/>.
/// </summary>
/// <param name="name">The name of the <see cref="Codec"/> instance to retrieve.</param>
/// <returns>The <see cref="Codec"/> instance.</returns>
Codec GetCodec(string name);
}
}