Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class NamedServiceFactory<TService>

    LUCENENET specific abstract class containing common fuctionality for named service factories.

    Inheritance
    object
    NamedServiceFactory<TService>
    DefaultCodecFactory
    DefaultDocValuesFormatFactory
    DefaultPostingsFormatFactory
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Util
    Assembly: Lucene.Net.dll
    Syntax
    public abstract class NamedServiceFactory<TService>
    Type Parameters
    Name Description
    TService

    The type of service this factory applies to.

    Fields

    m_initializationLock

    LUCENENET specific abstract class containing common fuctionality for named service factories.

    Declaration
    protected object m_initializationLock
    Field Value
    Type Description
    object

    Properties

    CodecsAssembly

    The Lucene.Net.Codecs assembly or null if the assembly is not referenced in the host project.

    Declaration
    protected Assembly CodecsAssembly { get; }
    Property Value
    Type Description
    Assembly

    IsFullyTrusted

    Gets a value that indicates whether the current application domain executes with full trust.

    Declaration
    protected bool IsFullyTrusted { get; }
    Property Value
    Type Description
    bool

    Methods

    EnsureInitialized()

    Ensures the Initialize() method has been called since the last application start. This method is thread-safe.

    Declaration
    protected void EnsureInitialized()

    GetCanonicalName(Type)

    Gets the type name without the suffix of the abstract base class it implements. If the class is generic, it will add the word "Generic" to the suffix in place of "`" to ensure the name is ASCII-only.

    Declaration
    protected static string GetCanonicalName(Type type)
    Parameters
    Type Name Description
    Type type

    The Type to get the name for.

    Returns
    Type Description
    string

    The canonical name of the service.

    GetServiceName(Type)

    Get the service name for the class (either by convention or by attribute).

    Declaration
    public static string GetServiceName(Type type)
    Parameters
    Type Name Description
    Type type

    A service to get the name for.

    Returns
    Type Description
    string

    The canonical name of the service or the name provided in the corresponding name attribute, if supplied.

    Initialize()

    Initializes the dependencies of this factory (such as using Reflection to populate the type cache).

    Declaration
    protected abstract void Initialize()

    IsServiceType(Type)

    Determines whether the given type is corresponding service for this class, based on its generic closing type TService.

    Declaration
    protected virtual bool IsServiceType(Type type)
    Parameters
    Type Name Description
    Type type

    The Type of service to analyze.

    Returns
    Type Description
    bool

    true if the service subclasses TService, is public, and is not abstract; otherwise false.

    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.