ConfigValueBrowser

Description

abstract class Tinman.Engine.Application.ConfigValueBrowser

Derived from: IPleaseIncludeInBinaryThanks
Extended by: ConfigValueBrowser_Tinman_AddOns ^sealed

Abstract base for classes that can browse a ConfigValue by creating an interactive IApplication for it.

Public / Methods

Browse

[OwnerReturn]
public abstract method Browse → (2)

config ⁱⁿ : ConfigValue: [not-null]
The config value.
validator ^opt : Validator = null: Optional validator object to use for validating the configured native object, before wrapping it in an application.
returns → IApplication: The browser application or null.

Creates a new instance of IApplication that browses the given config value.

ConfigException: If config ⁱⁿ specifies malformed configuration data.

IOException: If a temporary I/O error has occurred; the same call might succeed later.

ValidatingException: If the given config value is invalid (see IValidatable.Validate).

See also: ConfigValueBrowser.CanBrowse

BrowseWidget

[OwnerReturn]
public static method BrowseWidget → (2)

value ⁱⁿ : IWidget ^own: The value to browse.
operation ^opt : IOperation ^own = null: Operation to run along with application (see IApplication.RunOperation).
returns → IApplication: The browser application or null.

Browses the given value.

CanBrowse

public abstract method CanBrowse → (1)

config ⁱⁿ : ConfigValue: [not-null]
The config value.
returns → bool: true if Browse can possibly create a browser application,
false if not (i.e. Browse will always return null).

Can this ConfigValueBrowser object create a browser application for the given config value?

CanInspect

public abstract method CanInspect → (1)

config ⁱⁿ : ConfigValue: [not-null]
The config value.
returns → bool: true if Inspect can possibly inspect the value,
false if not (i.e. Inspect will always return null).

Can this ConfigValueBrowser object inspect the given config value?

Inspect

[OwnerReturn]
public abstract method Inspect → (1)

config ⁱⁿ : ConfigValue

[not-null]
The config value.

returns → object

The object that represents the inspection result, or null.
Depending on the type of the returned object, the following behaviour applies:

IDisposable:
The calling code is responsible for calling IDisposable.Dispose.
IConfigurable:
The IConfigurable.ToConfig method can be used to obtain the config value to use as the inspection result.
ConfigValue:
The returned config value is used as the inspection result.

Returns an inspection object for the given config value.

ConfigException: If config ⁱⁿ specifies malformed configuration data.

IOException: If a temporary I/O error has occurred; the same call might succeed later.

ValidatingException: If the given config value is invalid (see IValidatable.Validate).

See also: ConfigValueBrowser.CanInspect

Public / Attributes

All

public static attribute All → (get)

value : ConfigValueBrowser [ ]: [not-null]
The list of registered browser objects.

Returns all ConfigValueBrowser objects, in the order in which they have been registered.

Name

public abstract attribute Name → (get)

value : string: [not-empty]
The human-readable name.

Human-readable name of this ConfigValueBrowser instance.

Protected / Methods

Register

protected method Register → ()

Registers this ConfigValueBrowser so that it appears in All.

Logging

Logger

public static readonly attribute Logger → (ILogger)

The logger object of this class.