ConfigValue

Description

abstract class Tinman.Core.Config.ConfigValue

Derived from: IVersioned
ICodeOutput
IEquatable<ConfigValue>
IValidatable
ICodeRange

Abstract base class for ConfigValue implementations.

Public / Constants

ContextIncludeVirtualFields

public constant ContextIncludeVirtualFields → ("include-virtual-fields":string)

When using ToString¹, this context value will be set via Context.Set² when generating source code.

False

[ShutdownSurvive]
public static readonly attribute False → (ConfigValue)

The boolean value false.

This config value is immutable. Modifying its value will produce undefined behaviour.

See also: ConfigValue.IsImmutable

Invalid

[ShutdownSurvive]
public static readonly attribute Invalid → (ConfigValue)

An invalid value.

This config value is immutable. Modifying its value will produce undefined behaviour.

See also: ConfigValue.IsImmutable

Nan

[ShutdownSurvive]
public static readonly attribute Nan → (ConfigValue)

The number value NaN.

This config value is immutable. Modifying its value will produce undefined behaviour.

See also: ConfigValue.IsImmutable

Null

[ShutdownSurvive]
public static readonly attribute Null → (ConfigValue)

The null value for ClassType values.

This config value is immutable. Modifying its value will produce undefined behaviour.

See also: ConfigValue.IsImmutable

One

[ShutdownSurvive]
public static readonly attribute One → (ConfigValue)

The number value 1.

This config value is immutable. Modifying its value will produce undefined behaviour.

See also: ConfigValue.IsImmutable

True

[ShutdownSurvive]
public static readonly attribute True → (ConfigValue)

The boolean value true.

This config value is immutable. Modifying its value will produce undefined behaviour.

See also: ConfigValue.IsImmutable

Zero

[ShutdownSurvive]
public static readonly attribute Zero → (ConfigValue)

The number value 0.

This config value is immutable. Modifying its value will produce undefined behaviour.

See also: ConfigValue.IsImmutable

Public / Constructors

Evaluate

public static method Evaluate → (1)

expression ⁱⁿ : string: [not-null]
The config expression.
returns → ConfigValue: The config value.

Parses the given config expression and returns the resulting config value.

ValidatingException: If the given expression ⁱⁿ source code is malformed.

ConfigException: If an error has occurred while evaluating the expression (e.g. identifier not found).

See also: ConfigExpression.Evaluate

New

_4 overloads

public static method New¹ → (1)

value ⁱⁿ : bool: The initial value.
returns → ConfigValue: The ConfigValue object.

Creates a new ConfigType.Bool config value object for the given value.

public static method New² → (1)

value ⁱⁿ : float64: The initial value.
returns → ConfigValue: The ConfigValue object.

Creates a new ConfigType.Num config value object for the given value.

public static method New³ → (1)

value ⁱⁿ : Path: The initial value.
returns → ConfigValue: The ConfigValue object.

Creates a new ConfigType.Path config value object for the given value.

public static method New⁴ → (1)

value ⁱⁿ : string: The initial value.
returns → ConfigValue: The ConfigValue object.

Creates a new ConfigType.Str config value object for the given value.

NewArray

_4 overloads

public static method NewArray¹ → (1)

values ⁱⁿ : bool [ ]: The initial values.
returns → ConfigValue: The ConfigValue object.

Creates a new ConfigType.Path config value array for the given values.

public static method NewArray² → (1)

values ⁱⁿ : float64 [ ]: The initial values.
returns → ConfigValue: The ConfigValue object.

Creates a new ConfigType.Path config value array for the given values.

public static method NewArray³ → (1)

values ⁱⁿ : string [ ]: The initial values.
returns → ConfigValue: The ConfigValue object.

Creates a new ConfigType.Path config value array for the given values.

public static method NewArray⁴ → (1)

values ⁱⁿ : Path [ ]: The initial values.
returns → ConfigValue: The ConfigValue object.

Creates a new ConfigType.Path config value array for the given values.

Public / Methods

Cache

[EmptyBody]
public virtual method Cache → (1)

obj ⁱⁿ : object: The native object
returns → ConfigValue: this

Caches the given object.

This method can be called after a config value has been constructed for a native object.

Cached

[EmptyBody]
public virtual method Cached → (1)

version ⁱⁿ : int32: The config value version.
returns → object: The cached native object or null if not present or outdated.

Returns the cached object.

Configure

[OwnerReturn]
public method Configure → ()

returns → IConfigurable: The created object.

Uses this config value and creates a native object from it.

A IConfiguratorObject instance must have been specified for the ClassType of this value (see ClassTypeBuilder.Configurator).

ConfigException: If this config value 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).

GetField

public method GetField → (2)

name ⁱⁿ : string: [not-null]
The field name.
notNull ^opt : bool = false: Call NotNull on field value?
returns → ConfigValue: The field value.

Returns the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if the field violates the required nullability.

See also: ConfigValue.Fields

GetFieldBool

public method GetFieldBool → (1)

name ⁱⁿ : string: [not-null]
The field name.
returns → bool: The field value.

Returns the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if the field has an inconvertible type.

See also: ConfigValue.Fields

GetFieldDouble

public method GetFieldDouble → (1)

name ⁱⁿ : string: [not-null]
The field name.
returns → float64: The field value.

Returns the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if the field has an inconvertible type.

See also: ConfigValue.Fields

GetFieldInt

public method GetFieldInt → (1)

name ⁱⁿ : string: [not-null]
The field name.
returns → int32: The field value.

Returns the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if the field has an inconvertible type.

See also: ConfigValue.Fields

GetFieldPath

public method GetFieldPath → (2)

name ⁱⁿ : string: [not-null]
The field name.
notNull ^opt : bool = false: Call NotNull on field value?
returns → Path: The field value.

Returns the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if the field has an inconvertible type.

See also: ConfigValue.Fields

GetFieldStr

public method GetFieldStr → (2)

name ⁱⁿ : string: [not-null]
The field name.
notNull ^opt : bool = false: Call NotNull on field value?
returns → string: The field value.

Returns the value of the given field.

ConfigException: If name ⁱⁿ is invalid, if the field has an inconvertible type or if the field violates the required nullability.

See also: ConfigValue.Fields

New

_2 overloads

public method New¹ → ()

returns → ConfigValue: this

Creates a new instance of this nullable type and sets this value to the resulting value.

See also: ConfigValue.IsImmutable

public virtual method New² → (1)

type ⁱⁿ : ConfigType: The nullable type to instantiate or null to use the value base type.
returns → ConfigValue: this

Creates a new instance of the given nullable type and sets this value to the resulting value.

ConfigException: If the given type ⁱⁿ cannot be instantiated or cannot be assigned to the base type of this config value.

See also: ConfigValue.IsImmutable

NotNull

public method NotNull → ()

returns → ConfigValue: this

Ensures that this config value is not equal to Null, i.e. IsNull will return false.

ConfigException: If this config value is Null.

Set

public virtual method Set → (1)

value ⁱⁿ : ConfigValue: [not-null]
The other value.
returns → ConfigValue: this

Sets the value to the given value.

ConfigException: If value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable

SetField

_4 overloads

public method SetField¹ → (2)

name ⁱⁿ : string: [not-null]
The field name.
value ⁱⁿ : ConfigValue: [not-null]
The field value.
returns → ConfigValue: this

Sets the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable
ConfigValue.Fields

public method SetField² → (2)

name ⁱⁿ : string: [not-null]
The field name.
value ⁱⁿ : IConfigurableNull: The field value.
returns → ConfigValue: this

Sets the value of the given field, by calling IConfigurable.ToConfig on value ⁱⁿ (if not null) and then delegating to SetField¹.

If value ⁱⁿ is null, the field will be set to Null.

ConfigException: If name ⁱⁿ is invalid or if value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable
ConfigValue.Fields

public method SetField³ → (2)
→ <T ^val : IConfigurableTrait>

name ⁱⁿ : string: [not-null]
The field name.
value ⁱⁿ : T: The field value.
returns → ConfigValue: this

Sets the value of the given field, by calling IConfigurableTrait.ToConfig on value ⁱⁿ and then delegating to SetField¹.

ConfigException: If name ⁱⁿ is invalid or if value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable
ConfigValue.Fields

public method SetField⁴ → (3) → <T>

name ⁱⁿ : string: [not-null]
The field name.
value ⁱⁿ : T: The field value.
configurator ⁱⁿ : IConfigurator<T>: [not-null]
The value configurator.
returns → ConfigValue: this

Sets the value of the given field, by calling IConfigurator.ToValue on configurator ⁱⁿ passing value ⁱⁿ and then delegating to SetField¹.

ConfigException: If name ⁱⁿ is invalid or if value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable
ConfigValue.Fields

SetFieldBool

public method SetFieldBool → (2)

name ⁱⁿ : string: [not-null]
The field name.
value ⁱⁿ : bool: The field value.
returns → ConfigValue: this

Sets the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable
ConfigValue.Fields

SetFieldNum

_3 overloads

public method SetFieldNum¹ → (2)

name ⁱⁿ : string: [not-null]
The field name.
value ⁱⁿ : int64: The field value.
returns → ConfigValue: this

Sets the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable
ConfigValue.Fields

public method SetFieldNum² → (2)

name ⁱⁿ : string: [not-null]
The field name.
value ⁱⁿ : float32: The field value.
returns → ConfigValue: this

Sets the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable
ConfigValue.Fields

public method SetFieldNum³ → (2)

name ⁱⁿ : string: [not-null]
The field name.
value ⁱⁿ : float64: The field value.
returns → ConfigValue: this

Sets the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable
ConfigValue.Fields

SetFieldPath

public method SetFieldPath → (2)

name ⁱⁿ : string: [not-null]
The field name.
value ⁱⁿ : Path: The field value.
returns → ConfigValue: this

Sets the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable
ConfigValue.Fields

SetFieldStr

public method SetFieldStr → (2)

name ⁱⁿ : string: [not-null]
The field name.
value ⁱⁿ : string: The field value.
returns → ConfigValue: this

Sets the value of the given field.

ConfigException: If name ⁱⁿ is invalid or if value ⁱⁿ is not convertible to the type of this config value.

See also: ConfigValue.IsImmutable
ConfigValue.Fields

ToString

_2 overloads

public method ToString¹ → (1)

includeVirtualFields ⁱⁿ : bool: Include virtual fields (see ConfigMember.IsVirtual)?
returns → string: The parsable string representation

Returns a parsable string representation of this config value.

ValidateFlush

public virtual method ValidateFlush → ()

Flushes all cached validation results.

Call this method when external changes have taken place, such as file deletions / creations.

Public / Attributes

Bool

public virtual attribute Bool → (get,set)

value : bool: The config value.

Accesses the config value, assuming a conversion to ConfigType.Bool exists.

ConfigException: If no conversion to ConfigType.Bool exists.

See also: ConfigValue.IsImmutable
ConfigType.IsBoolean
ConfigType.IsConvertibleTo

CanConfigure

public attribute CanConfigure → (get)

value : bool: true if Configure can be called,
false if not.

Can the Configure method be called on this config value?

Elements

public virtual attribute Elements → (get)

value : ValueArray: [not-null]
The config value.

Accesses the config value, assuming it is an array value.

ConfigException: If this is not an array value.

See also: ConfigType.IsArray
ArrayType

EvaluatedBy

public attribute EvaluatedBy → (get)

value : ConfigExpression: The config expression or null if not known resp. applicable.

Returns the config expression that has been evaluated to create this config value.

Fields

public virtual attribute Fields → (get)

value : IConfigValueBag: [not-null]
The config value.

Accesses the config value, assuming it is a class value.

ConfigException: If this is not a class value.

See also: ConfigType.IsClass
ClassType

IsImmutable

public attribute IsImmutable → (get)

value : bool: true if this config value is immutable, false if it is mutable.

Is this config value immutable?

See also: ConfigValue.False
ConfigValue.Invalid
ConfigValue.Null
ConfigValue.One
ConfigValue.True
ConfigValue.Zero

IsInvalid

public virtual attribute IsInvalid → (get)

value : bool: true if this config type is Invalid),
false if it is some other valid type.

Checks if this config type is the special invalid type.

IsNull

public virtual attribute IsNull → (get)

value : bool: true if this config type is Null),
false if it is some other non-null type.

Checks if this config type is the special null type.

Num

public virtual attribute Num → (get,set)

value : float64: The config value.

Accesses the config value, assuming a conversion to ConfigType.Num exists.

ConfigException: If no conversion to ConfigType.Num exists.

See also: ConfigValue.IsImmutable
ConfigType.IsNumber
ConfigType.IsConvertibleTo

Path

public virtual attribute Path → (get,set)

value : Path: The config value.

Accesses the config value, assuming a conversion to ConfigType.Path exists.

ConfigException: If no conversion to ConfigType.Path exists.

See also: ConfigValue.IsImmutable
ConfigType.IsPath
ConfigType.IsConvertibleTo

Str

public virtual attribute Str → (get,set)

value : string: The config value.

Accesses the config value, assuming a conversion to ConfigType.Str exists.

ConfigException: If no conversion to ConfigType.Str exists.

See also: ConfigValue.IsImmutable
ConfigType.IsString
ConfigType.IsConvertibleTo

SyntaxWeightCtor

public attribute SyntaxWeightCtor → (get)

value : int32: The syntax weight.

Returns the syntax weight for this config value (for pretty-print only).

Type

public abstract attribute Type → (get)

value : ConfigType: [not-null]
The type of this property value.

Returns the type of this config property value.

Protected / Constructors

ConfigValue

protected constructor ConfigValue → ()

Creates a new instance of ConfigValue.

Protected / Methods

DoEquals

protected abstract method DoEquals → (1)

other ⁱⁿ : ConfigValue: The other config value. This will never be null. Also, the types of this config value and the given one are mutually convertible to each other.
returns → bool: true if both config values are equal, false if not.

Compares this config value and the given one for equality.

ConfigException: If an unexpected error has occurred.

DoValidate

[EmptyBody]
protected virtual method DoValidate → (1)

validator ⁱⁿ : Validator: The validator to use.

Validates this config value.

ConfigException: If this config value specifies malformed configuration data.

ThrowIfImmutable

protected method ThrowIfImmutable → (1)

source ⁱⁿ : string @ Tag: The error source tag.

Asserts that this config value is mutable.

ConfigException: If IsImmutable returns true.

See also: ConfigValue.IsImmutable

Protected / Attributes

DoSyntaxWeightCtor

protected abstract attribute DoSyntaxWeightCtor → (get)

value : int32: The syntax weight.

Returns the syntax weight for this config value (for pretty-print only).

ConfigException: If an unexpected error has occurred.

ConfigValue

Description

Public / Constants

Context​Include​Virtual​Fields

False

Invalid

Nan

Null

One

True

Zero

Public / Constructors

Evaluate

New

New​Array

Public / Methods

Cache

Cached

Configure

Get​Field

Get​Field​Bool

Get​Field​Double

Get​Field​Int

Get​Field​Path

Get​Field​Str

New

Not​Null

Set

Set​Field

Set​Field​Bool

Set​Field​Num

Set​Field​Path

Set​Field​Str

To​String

Validate​Flush

Public / Attributes

Bool

Can​Configure

Elements

Evaluated​By

Fields

Is​Immutable

Is​Invalid

Is​Null

Num

Path

Str

Syntax​Weight​Ctor

Type

Protected / Constructors

Config​Value

Protected / Methods

Do​Equals

Do​Validate

Throw​If​Immutable

Protected / Attributes

Do​Syntax​Weight​Ctor

ContextIncludeVirtualFields

NewArray

GetField

GetFieldBool

GetFieldDouble

GetFieldInt

GetFieldPath

GetFieldStr

NotNull

SetField

SetFieldBool

SetFieldNum

SetFieldPath

SetFieldStr

ToString

ValidateFlush

CanConfigure

EvaluatedBy

IsImmutable

IsInvalid

IsNull

SyntaxWeightCtor

ConfigValue

DoEquals

DoValidate

ThrowIfImmutable

DoSyntaxWeightCtor