| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class DefaultCodecFactory |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class DefaultCodecFactory |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Codecs.DefaultCodecFactory"> |
| |
| |
| <h1 id="Lucene_Net_Codecs_DefaultCodecFactory" data-uid="Lucene.Net.Codecs.DefaultCodecFactory" class="text-break">Class DefaultCodecFactory |
| </h1> |
| <div class="markdown level0 summary"><p>Implements the default functionality of <a class="xref" href="Lucene.Net.Codecs.ICodecFactory.html">ICodecFactory</a>. |
| <p> |
| To replace the <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html">DefaultCodecFactory</a> instance, call |
| <a class="xref" href="Lucene.Net.Codecs.Codec.html#Lucene_Net_Codecs_Codec_SetCodecFactory_Lucene_Net_Codecs_ICodecFactory_">SetCodecFactory(ICodecFactory)</a> at application start up. |
| <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html">DefaultCodecFactory</a> can be subclassed or passed additional parameters to register |
| additional codecs, inject dependencies, or change caching behavior, as shown in the following examples. |
| Alternatively, <a class="xref" href="Lucene.Net.Codecs.ICodecFactory.html">ICodecFactory</a> can be implemented to provide complete control over |
| codec creation and lifetimes. |
| <p> |
| <h4>Register Additional Codecs</h4> |
| <p> |
| Additional codecs can be added by initializing the instance of <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html">DefaultCodecFactory</a> and |
| passing an array of <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a>-derived types.</p> |
| <pre><code>// Register the factory at application start up. |
| Codec.SetCodecFactory(new DefaultCodecFactory { |
| CustomCodecTypes = new Type[] { typeof(MyCodec), typeof(AnotherCodec) } |
| });</code></pre> |
| <p><p> |
| <h4>Only Use Explicitly Defined Codecs</h4> |
| <p> |
| <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html#Lucene_Net_Codecs_DefaultCodecFactory_PutCodecType_System_Type_">PutCodecType(Type)</a> can be used to explicitly add codec types. In this example, |
| the call to <code>base.Initialize()</code> is excluded to skip the built-in codec registration. |
| Since <code>AnotherCodec</code> doesn't have a default constructor, the <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html#Lucene_Net_Codecs_DefaultCodecFactory_NewCodec_System_Type_">NewCodec(Type)</a> |
| method is overridden to supply the required parameters.</p> |
| <pre><code>public class ExplicitCodecFactory : DefaultCodecFactory |
| { |
| protected override void Initialize() |
| { |
| // Load specific codecs in a specific order. |
| PutCodecType(typeof(MyCodec)); |
| PutCodecType(typeof(AnotherCodec)); |
| } |
| |
| protected override Codec NewCodec(Type type) |
| { |
| // Special case: AnotherCodec has a required dependency |
| if (typeof(AnotherCodec).Equals(type)) |
| return new AnotherCodec(new SomeDependency()); |
| |
| return base.NewCodec(type); |
| } |
| } |
| |
| // Register the factory at application start up. |
| Codec.SetCodecFactory(new ExplicitCodecFactory());</code></pre> |
| <p>See the <a class="xref" href="Lucene.Net.Codecs.html">Lucene.Net.Codecs</a> namespace documentation for more examples of how to |
| inject dependencies into <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> subclasses. |
| <p> |
| <h4>Use Reflection to Scan an Assembly for Codecs</h4> |
| <p> |
| <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html#Lucene_Net_Codecs_DefaultCodecFactory_ScanForCodecs_System_Reflection_Assembly_">ScanForCodecs(Assembly)</a> or <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html#Lucene_Net_Codecs_DefaultCodecFactory_ScanForCodecs_System_Collections_Generic_IEnumerable_System_Reflection_Assembly__">ScanForCodecs(IEnumerable<Assembly>)</a> can be used |
| to scan assemblies using .NET Reflection for codec types and add all subclasses that are found automatically. |
| This example calls <code>base.Initialize()</code> to load the default codecs prior to scanning for additional codecs.</p> |
| <pre><code>public class ScanningCodecFactory : DefaultCodecFactory |
| { |
| protected override void Initialize() |
| { |
| // Load all default codecs |
| base.Initialize(); |
| |
| // Load all of the codecs inside of the same assembly that MyCodec is defined in |
| ScanForCodecs(typeof(MyCodec).Assembly); |
| } |
| } |
| |
| // Register the factory at application start up. |
| Codec.SetCodecFactory(new ScanningCodecFactory());</code></pre> |
| <p>Codecs in the target assemblie(s) can be excluded from the scan by decorating them with |
| the <a class="xref" href="Lucene.Net.Codecs.ExcludeCodecFromScanAttribute.html">ExcludeCodecFromScanAttribute</a>.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><a class="xref" href="Lucene.Net.Util.NamedServiceFactory-1.html">NamedServiceFactory</a><<a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a>></div> |
| <div class="level2"><span class="xref">DefaultCodecFactory</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.Codecs.ICodecFactory.html">ICodecFactory</a></div> |
| <div><a class="xref" href="Lucene.Net.Util.IServiceListable.html">IServiceListable</a></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.NamedServiceFactory-1.html#Lucene_Net_Util_NamedServiceFactory_1_m_initializationLock">NamedServiceFactory<Codec>.m_initializationLock</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.NamedServiceFactory-1.html#Lucene_Net_Util_NamedServiceFactory_1_EnsureInitialized">NamedServiceFactory<Codec>.EnsureInitialized()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.NamedServiceFactory-1.html#Lucene_Net_Util_NamedServiceFactory_1_CodecsAssembly">NamedServiceFactory<Codec>.CodecsAssembly</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.NamedServiceFactory-1.html#Lucene_Net_Util_NamedServiceFactory_1_IsServiceType_System_Type_">NamedServiceFactory<Codec>.IsServiceType(Type)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.NamedServiceFactory-1.html#Lucene_Net_Util_NamedServiceFactory_1_GetServiceName_System_Type_">NamedServiceFactory<Codec>.GetServiceName(Type)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.NamedServiceFactory-1.html#Lucene_Net_Util_NamedServiceFactory_1_GetCanonicalName_System_Type_">NamedServiceFactory<Codec>.GetCanonicalName(Type)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.NamedServiceFactory-1.html#Lucene_Net_Util_NamedServiceFactory_1_IsFullyTrusted">NamedServiceFactory<Codec>.IsFullyTrusted</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Codecs.html">Lucene.Net.Codecs</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Codecs_DefaultCodecFactory_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class DefaultCodecFactory : NamedServiceFactory<Codec>, ICodecFactory, IServiceListable</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory__ctor.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L127">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory__ctor_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.#ctor*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory__ctor" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.#ctor">DefaultCodecFactory()</h4> |
| <div class="markdown level1 summary"><p>Creates a new instance of <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html">DefaultCodecFactory</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public DefaultCodecFactory()</code></pre> |
| </div> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory_AvailableServices.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.AvailableServices%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L302">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory_AvailableServices_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.AvailableServices*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory_AvailableServices" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.AvailableServices">AvailableServices</h4> |
| <div class="markdown level1 summary"><p>Gets a list of the available <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a>s (by name).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual ICollection<string> AvailableServices { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.ICollection</span><<span class="xref">System.String</span>></td> |
| <td><p>A <span class="xref">ICollection{string}</span> of <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> names.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory_CustomCodecTypes.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.CustomCodecTypes%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L142">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory_CustomCodecTypes_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.CustomCodecTypes*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory_CustomCodecTypes" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.CustomCodecTypes">CustomCodecTypes</h4> |
| <div class="markdown level1 summary"><p>An array of custom <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a>-derived types to be registered. This property |
| can be initialized during construction of <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html">DefaultCodecFactory</a> |
| to make your custom codecs known to Lucene. |
| <p> |
| These types will be registered after the default Lucene types, so if a custom type has the same |
| name as a Lucene <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> (via <a class="xref" href="Lucene.Net.Codecs.CodecNameAttribute.html">CodecNameAttribute</a>) |
| the custom type will replace the Lucene type with the same name.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IEnumerable<Type> CustomCodecTypes { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">System.Type</span>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory_GetCodec_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.GetCodec(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L232">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory_GetCodec_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.GetCodec*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory_GetCodec_System_String_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.GetCodec(System.String)">GetCodec(String)</h4> |
| <div class="markdown level1 summary"><p>Gets the <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> instance from the provided <code data-dev-comment-type="paramref" class="paramref">name</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Codec GetCodec(string name)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>The name of the <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> instance to retrieve.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a></td> |
| <td><p>The <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> instance.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory_GetCodec_System_Type_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.GetCodec(System.Type)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L247">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory_GetCodec_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.GetCodec*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory_GetCodec_System_Type_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.GetCodec(System.Type)">GetCodec(Type)</h4> |
| <div class="markdown level1 summary"><p>Gets the <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> instance from the provided <code data-dev-comment-type="paramref" class="paramref">type</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual Codec GetCodec(Type type)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Type</span></td> |
| <td><span class="parametername">type</span></td> |
| <td><p>The <span class="xref">System.Type</span> of <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> to retrieve.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a></td> |
| <td><p>The <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> instance.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory_GetCodecType_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.GetCodecType(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L281">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory_GetCodecType_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.GetCodecType*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory_GetCodecType_System_String_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.GetCodecType(System.String)">GetCodecType(String)</h4> |
| <div class="markdown level1 summary"><p>Gets the <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> <span class="xref">System.Type</span> from the provided <code data-dev-comment-type="paramref" class="paramref">name</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual Type GetCodecType(string name)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>The name of the <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> <span class="xref">System.Type</span> to retrieve.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Type</span></td> |
| <td><p>The <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> <span class="xref">System.Type</span>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory_Initialize.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.Initialize%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L153">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory_Initialize_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.Initialize*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory_Initialize" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.Initialize">Initialize()</h4> |
| <div class="markdown level1 summary"><p>Initializes the codec type cache with the known <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> types. |
| Override this method (and optionally call <code>base.Initialize()</code>) to add your |
| own <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> types by calling <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html#Lucene_Net_Codecs_DefaultCodecFactory_PutCodecType_System_Type_">PutCodecType(Type)</a> |
| or <a class="xref" href="Lucene.Net.Codecs.DefaultCodecFactory.html#Lucene_Net_Codecs_DefaultCodecFactory_ScanForCodecs_System_Reflection_Assembly_">ScanForCodecs(Assembly)</a>. |
| <p> |
| If two types have the same name by using the <a class="xref" href="Lucene.Net.Codecs.CodecNameAttribute.html">CodecNameAttribute</a>, the |
| last one registered wins.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected override void Initialize()</code></pre> |
| </div> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Util.NamedServiceFactory<Lucene.Net.Codecs.Codec>.Initialize()</span></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory_NewCodec_System_Type_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.NewCodec(System.Type)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L271">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory_NewCodec_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.NewCodec*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory_NewCodec_System_Type_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.NewCodec(System.Type)">NewCodec(Type)</h4> |
| <div class="markdown level1 summary"><p>Instantiates a <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> based on the provided <code data-dev-comment-type="paramref" class="paramref">type</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual Codec NewCodec(Type type)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Type</span></td> |
| <td><span class="parametername">type</span></td> |
| <td><p>The <span class="xref">System.Type</span> of <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> to instantiate.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a></td> |
| <td><p>The new instance.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory_PutCodecType_System_Type_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.PutCodecType(System.Type)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L208">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory_PutCodecType_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.PutCodecType*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory_PutCodecType_System_Type_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.PutCodecType(System.Type)">PutCodecType(Type)</h4> |
| <div class="markdown level1 summary"><p>Adds a <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> type to the <span class="xref">Lucene.Net.Codecs.DefaultCodecFactory.codecNameToTypeMap</span>, using |
| the name provided in the <a class="xref" href="Lucene.Net.Codecs.CodecNameAttribute.html">CodecNameAttribute</a>, if present, or the name |
| of the codec class minus the "Codec" suffix as the name by default. |
| <p> |
| Note that if a <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> with the same name already exists in the map, |
| calling this method will update it to the new type.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void PutCodecType(Type codec)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Type</span></td> |
| <td><span class="parametername">codec</span></td> |
| <td><p>A type that subclasses <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory_ScanForCodecs_System_Collections_Generic_IEnumerable_System_Reflection_Assembly__.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.ScanForCodecs(System.Collections.Generic.IEnumerable%7BSystem.Reflection.Assembly%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L172">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory_ScanForCodecs_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.ScanForCodecs*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory_ScanForCodecs_System_Collections_Generic_IEnumerable_System_Reflection_Assembly__" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.ScanForCodecs(System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">ScanForCodecs(IEnumerable<Assembly>)</h4> |
| <div class="markdown level1 summary"><p>Scans the given <code data-dev-comment-type="paramref" class="paramref">assemblies</code> for subclasses of <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> |
| and adds their names to the <span class="xref">Lucene.Net.Codecs.DefaultCodecFactory.codecNameToTypeMap</span>. Note that names will be |
| automatically overridden if the <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> name appears multiple times - the last match wins.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void ScanForCodecs(IEnumerable<Assembly> assemblies)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">System.Reflection.Assembly</span>></td> |
| <td><span class="parametername">assemblies</span></td> |
| <td><p>A list of assemblies to scan. The assemblies will be scanned from first to last, |
| and the last match for each <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> name wins.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory_ScanForCodecs_System_Reflection_Assembly_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory.ScanForCodecs(System.Reflection.Assembly)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L186">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_DefaultCodecFactory_ScanForCodecs_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.ScanForCodecs*"></a> |
| <h4 id="Lucene_Net_Codecs_DefaultCodecFactory_ScanForCodecs_System_Reflection_Assembly_" data-uid="Lucene.Net.Codecs.DefaultCodecFactory.ScanForCodecs(System.Reflection.Assembly)">ScanForCodecs(Assembly)</h4> |
| <div class="markdown level1 summary"><p>Scans the given <code data-dev-comment-type="paramref" class="paramref">assembly</code> for subclasses of <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> |
| and adds their names to the <span class="xref">Lucene.Net.Codecs.DefaultCodecFactory.codecNameToTypeMap</span>. Note that names will be |
| automatically overridden if the <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a> name appears multiple times - the last match wins.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void ScanForCodecs(Assembly assembly)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Reflection.Assembly</span></td> |
| <td><span class="parametername">assembly</span></td> |
| <td><p>The assembly to scan.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Codecs.ICodecFactory.html">ICodecFactory</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.IServiceListable.html">IServiceListable</a> |
| </div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Codecs.ICodecFactory.html">ICodecFactory</a></div> |
| <div><a class="xref" href="Lucene.Net.Util.IServiceListable.html">IServiceListable</a></div> |
| <div><a class="xref" href="Lucene.Net.Codecs.ExcludeCodecFromScanAttribute.html">ExcludeCodecFromScanAttribute</a></div> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_DefaultCodecFactory.md&value=---%0Auid%3A%20Lucene.Net.Codecs.DefaultCodecFactory%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs/#L106" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
