Class DataValueGeneric<T>

Generic flyweight data value container.

Since

2.0

Type Parameters

  • T

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

DataType HasValidValue IsNullValue ValidValue AssignFrom Clone SetNullValue Create

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

DataType

  • get DataType(): DataType

  • Gets the data type corresponding to the runtime values that can be stored in this value container. The data type is fixed, since a data value cannot be used for values of varying types.

    Returns DataType

    Since

    2.0

HasValidValue

  • get HasValidValue(): boolean

  • Gets a value indicating whether this DataValue contains a valid value. If HasValidValue is false, then either IsNullValue is true or HasDataError is true, but not both. If HasValidValue is true, the IsNullValue and HasDataError are both false.

    Returns boolean

    Since

    2.0

IsNullValue

  • get IsNullValue(): boolean

  • Gets a value indicating whether this DataValue instance represents a null value, or, more precisely, an invalid value with a null data error.

    Returns boolean

    Since

    2.0

ValidValue

  • get ValidValue(): JsType<T>

  • Gets or sets the valid value contained in this DataValue instance. A default value is returned if there is no valid value. After setting a valid value HasValidValue will be true, HasDataError and IsNullValue will be false, and DataError will return null.

    Returns JsType<T>

    Since

    2.0

  • set ValidValue(value): void

  • Gets or sets the runtime value contained in this DataValue instance, as a boxed value. The getter returns null for reference types and default(T) for value types, if the HasValidValue is false. After setting a valid value HasValidValue will be true, HasDataError and IsNullValue will be false, and DataError will return null.

    Parameters

    Returns void

    Since

    2.0

AssignFrom

  • AssignFrom(other): void

  • Sets this DataValue instance equal to another DataValue instance.

    Parameters

    Returns void

    Since

    2.0

Clone

SetNullValue

  • SetNullValue(): void

  • Makes this DataValue instance represent a null value. That is, an invalid value with a null data error. After the method call, HasValidValue will return false, IsNullValue will return true, and HasDataError will return false. The ValidValue property will be null or default(T).

    Returns void

    Since

    2.0

StaticCreate

  • Create(dataType): DataValue

  • Creates a DataValue instance of a given data type.

    Parameters

    • dataType: DataType

      A non-null DataType instance.

    Returns DataValue

    A new DataValue instance of the given type, initially set to a null value.

    Since

    2.0

  • Create<T>(typeT): DataValueGeneric<T>

  • Creates a DataValue instance of a given runtime type.

    Type Parameters

    • T

    Parameters

    Returns DataValueGeneric<T>

    A new DataValue instance of the given type, initially set to a null value.

    Since

    2.0

  • Create(dataType, initialValue): DataValue

  • Creates a DataValue instance of a given data type and with a provided initial value.

    Parameters

    • dataType: DataType

      A non-null DataType instance.

    • initialValue: any

      The value. If null, the initial value will be null.

    Returns DataValue

    A new DataValue instance.

    Since

    2.0

  • Create<T>(typeT, initialValue): DataValueGeneric<T>

  • Creates a DataValue instance of a given runtime type and with a provided initial value.

    Type Parameters

    • T

    Parameters

    • typeT: TypeRefParam<T>

      Generic type argument

    • initialValue: T | JsType<T>

      The initial value. If null, then IsNullValue will be true.

    Returns DataValueGeneric<T>

    A new DataValue instance.

    Since

    2.0

  • Create<T>(typeT, initialValue, isValid): DataValueGeneric<T>

  • Creates a DataValue instance of a given runtime type and with a provided initial value. This method is redundant but useful in practice.

    Type Parameters

    • T

    Parameters

    • typeT: TypeRefParam<T>

      Generic type argument

    • initialValue: T | JsType<T>

      The initial value. If null, then IsNullValue will be true.

    • isValid: boolean | Boolean

      If true, the initial value is valid. If false, the initial value should not be used, and IsNullValue will be set to true.

    Returns DataValueGeneric<T>

    A new DataValue instance.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability