Class FormatHandlerAttribute

Specifies that a class can be used to decode a particular file type.
Inheritance
System.Object
FormatHandlerAttribute
FormatDecoderAttribute
FormatEncoderAttribute
Namespace: Mars.Common.Compat
Assembly: Mars.Common.dll
Syntax
public abstract class FormatHandlerAttribute : Attribute

Constructors

FormatHandlerAttribute(String)

Initializes a new instance of the FormatHandlerAttribute class.
Declaration
public FormatHandlerAttribute(string extension)
Parameters
Type Name Description
System.String extension

Properties

Extension

Gets or sets the file extension that this format decoder applies to (i.e. "wav").
Declaration
public string Extension { get; set; }
Property Value
Type Description
System.String

Methods

GetHandler<TInterface, TAttribute>(String, Dictionary<String, Type>, Dictionary<String, TInterface>)

Finds a file handler that can process the given normalized file extension.
Declaration
public static TInterface GetHandler<TInterface, TAttribute>(string fileExtension, Dictionary<string, Type> handlerTypes, Dictionary<string, TInterface> cache)
    where TInterface : class where TAttribute : FormatHandlerAttribute
Parameters
Type Name Description
System.String fileExtension The normalized file extension (GetNormalizedExtension(String).
Dictionary<System.String, Type> handlerTypes The handler types.
Dictionary<System.String, TInterface> cache The cache of already instantiated handler types.
Returns
Type Description
TInterface A file decoder or encoder implementing the TInterface interface, or null if none have been found.
Type Parameters
Name Description
TInterface The type of the the handler to be found (e.g. IImageDecoder or IAudioDecoder).
TAttribute The type of the attribute to be found (e.g. FormatDecoderAttribute or FormatEncoderAttribute).

GetNormalizedExtension(String)

Extracts and normalizes a file extension in the same format that is used when specifying which formats are supported by each decoder (e.g. "file.wav" would become "WAV", "image.png" would become "PNG", etc).
Declaration
public static string GetNormalizedExtension(string fileName)
Parameters
Type Name Description
System.String fileName
Returns
Type Description
System.String

PopulateDictionaryWithHandlersFromAllAssemblies<TInterface, TAttribute>(Dictionary<String, Type>)

Populates the dictionary with available decoders of a particular category by inspecting types from all referenced assemblies. Note: calling this method will force all referenced assemblies to be loaded into the current AppDomain.
Declaration
public static void PopulateDictionaryWithHandlersFromAllAssemblies<TInterface, TAttribute>(Dictionary<string, Type> dictionary)
    where TAttribute : FormatHandlerAttribute
Parameters
Type Name Description
Dictionary<System.String, Type> dictionary The dictionary where the found decoders will be stored.
Type Parameters
Name Description
TInterface The base type for the decoders. This should be an interface such as IImageDecoder or IAudioDecoder.
TAttribute The type of the attribute to be found (e.g. FormatDecoderAttribute or FormatEncoderAttribute).

Extension Methods