Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Promise<T>

Type parameters

  • T

Hierarchy

  • PromiseBase<T>
    • Promise

Implements

  • IPromise

Index

Constructors

Methods

Constructors

constructor

  • Initializes a new instance of the fm.icelink.promiseBase class.

    Returns Promise

Methods

Protected doAll

  • doAll<R>(promises: Future<R>[], counter: AtomicInteger): void
  • Internal DoAll.

    Type parameters

    • R: Object

    Parameters

    • promises: Future<R>[]
    • counter: AtomicInteger

    Returns void

fail

  • fail(reject?: IAction1<Exception>): Future<T>

  • Parameters

    • Optional reject: IAction1<Exception>

    Returns Future<T>

getException

  • getException(): Exception
  • Gets the exception if rejected.

    Returns Exception

getId

  • getId(): string
  • Gets the identifier of this promise.

    Returns string

getResult

  • getResult(): T
  • Gets the result if resolved.

    Returns T

getState

  • getState(): FutureState
  • Gets the current state.

    Returns FutureState

getTypeString

  • getTypeString(): string

  • Returns string

Protected process

  • process(promise: IPromise, resolve: IAction1<T>, reject: IAction1<Exception>): void
  • Processes the specified promise.

    Parameters

    • promise: IPromise

      The promise.

    • resolve: IAction1<T>

      The resolve.

    • reject: IAction1<Exception>

      The reject.

    Returns void

reject

  • reject(exception: Exception): boolean
  • Rejects the promise.

    Parameters

    • exception: Exception

      The exception.

    Returns boolean

rejectAsync

  • rejectAsync(exception: Exception): Future<Object>
  • Rejects the promise asynchronously.

    Parameters

    • exception: Exception

      The exception.

    Returns Future<Object>

resolve

  • resolve(result: T): boolean
  • Resolves the promise.

    Parameters

    • result: T

      The result.

    Returns boolean

resolveAsync

  • resolveAsync(result: T): Future<Object>
  • Resolves the promise asynchronously.

    Parameters

    • result: T

      The result.

    Returns Future<Object>

Protected setException

  • setException(value: Exception): void
  • Sets the exception if rejected.

    Parameters

    • value: Exception

    Returns void

Protected setResult

  • setResult(value: T): void
  • Sets the result if resolved.

    Parameters

    • value: T

    Returns void

Protected setState

  • setState(value: FutureState): void
  • Sets the current state.

    Parameters

    • value: FutureState

    Returns void

then

  • then<R>(resolve: IFunction1<T, R | Future<R>>, reject?: IAction1<Exception>): Future<R>

  • Type parameters

    • R

    Parameters

    • resolve: IFunction1<T, R | Future<R>>
    • Optional reject: IAction1<Exception>

    Returns Future<R>

Static all

  • all<R>(promises: Future<R>[]): Future<R>
  • Returns a promise that resolves when all passed in promises resolve.

    Type parameters

    • R: Object

    Parameters

    • promises: Future<R>[]

      The promises to check.

    Returns Future<R>

Static rejectNow

  • rejectNow<R>(ex: Exception): Future<R>
  • Creates a promise and rejects it immediately.

    Type parameters

    • R: Object

    Parameters

    • ex: Exception

      The exception.

    Returns Future<R>

Static resolveNow

  • resolveNow(): Future<Object>
  • resolveNow<R>(result: R): Future<R>
  • Creates a promise and resolves it immediately using a null result value.

    Returns Future<Object>

  • Creates a promise and resolves it immediately using the given result value.

    Type parameters

    • R: Object

    Parameters

    • result: R

      The result.

    Returns Future<R>

Static wrap

  • wrap(callbackAction: IAction0): Future<Object>
  • wrap<R>(callbackFunction: IFunction0<R>): Future<R>

  • Parameters

    • callbackAction: IAction0

    Returns Future<Object>

  • Type parameters

    • R: Object

    Parameters

    • callbackFunction: IFunction0<R>

    Returns Future<R>

Static wrapAsync

  • wrapAsync(callbackAction: IAction0): Future<Object>
  • wrapAsync<R>(callbackFunction: IFunction0<R>): Future<R>

  • Parameters

    • callbackAction: IAction0

    Returns Future<Object>

  • Type parameters

    • R: Object

    Parameters

    • callbackFunction: IFunction0<R>

    Returns Future<R>

Static wrapPromise

  • wrapPromise<R>(callback: IFunction0<Future<R>>): Future<R>
  • Creates a promise and resolves it using the result from a callback function, or rejects it if an exception is thrown.

    Type parameters

    • R: Object

    Parameters

    • callback: IFunction0<Future<R>>

      The callback function.

    Returns Future<R>