Interface IResourceProvider

Contract for a set of localized resources. Generally, this is an abstraction over one or more ResourceManager instances.

Namespace: Lucene.Net.Util

Assembly: Lucene.Net.dll

Syntax

public interface IResourceProvider

Methods

GetObject(string, CultureInfo?)

Gets the value of the specified non-string resource localized for the specified culture.

Declaration

object? GetObject(string name, CultureInfo? culture)

Parameters

Type	Name	Description
string	name	The name of the resource to get.
CultureInfo	culture	The culture for which the resource is localized. If the resource is not localized for this culture, the resource manager uses fallback rules to locate an appropriate resource. If this value is null, the CultureInfo object is obtained by using the CurrentUICulture property.

Returns

Type	Description
object	The value of the resource, localized for the specified culture. If an appropriate resource set exists but name cannot be found, the method returns null.

Exceptions

Type	Condition
ArgumentNullException	The name parameter is null.
MissingManifestResourceException	No usable set of resources has been found, and there are no resources for a default culture. For information about how to handle this exception, see the "Handling MissingManifestResourceException and MissingSatelliteAssemblyException Exceptions" section in the ResourceManager class topic.
MissingSatelliteAssemblyException	The default culture's resources reside in a satellite assembly that could not be found. For information about how to handle this exception, see the "Handling MissingManifestResourceException and MissingSatelliteAssemblyException Exceptions" section in the ResourceManager class topic.

GetStream(string, CultureInfo?)

Returns an unmanaged memory stream object from the specified resource, using the specified culture.

Declaration

Stream? GetStream(string name, CultureInfo? culture)

Parameters

Type	Name	Description
string	name	The name of a resource.
CultureInfo	culture	An object that specifies the culture to use for the resource lookup. If culture is null, the culture for the current thread is used.

Returns

Type	Description
Stream	An unmanaged memory stream object that represents a resource.

Exceptions

Type	Condition
ArgumentNullException	The name parameter is null.
InvalidOperationException	The value of the specified resource is not a MemoryStream object.
MissingManifestResourceException	No usable set of resources has been found, and there are no resources for a default culture. For information about how to handle this exception, see the "Handling MissingManifestResourceException and MissingSatelliteAssemblyException Exceptions" section in the ResourceManager class topic.
MissingSatelliteAssemblyException	The default culture's resources reside in a satellite assembly that could not be found. For information about how to handle this exception, see the "Handling MissingManifestResourceException and MissingSatelliteAssemblyException Exceptions" section in the ResourceManager class topic.

GetString(string, CultureInfo?)

Returns the value of the string resource localized for the specified culture.

Declaration

string? GetString(string name, CultureInfo? culture)

Parameters

Type	Name	Description
string	name	The name of the resource to retrieve.
CultureInfo	culture	An object that represents the culture for which the resource is localized.

Returns

Type	Description
string	The value of the resource localized for the specified culture, or null if name cannot be found in a resource set.

Exceptions

Type	Condition
ArgumentNullException	The name parameter is null.
InvalidOperationException	The value of the specified resource is not a string.
MissingManifestResourceException	No usable set of resources has been found, and there are no resources for a default culture. For information about how to handle this exception, see the "Handling MissingManifestResourceException and MissingSatelliteAssemblyException Exceptions" section in the ResourceManager class topic.
MissingSatelliteAssemblyException	The default culture's resources reside in a satellite assembly that could not be found. For information about how to handle this exception, see the "Handling MissingManifestResourceException and MissingSatelliteAssemblyException Exceptions" section in the ResourceManager class topic.