Options
All
  • Public
  • Public/Protected
  • All
Menu

Class References

The most basic implementation of IReferences to store and locate component references.

see

IReferences

Example

export class MyController implements IReferenceable {
    public _persistence: IMyPersistence;
    ...
    public setReferences(references: IReferences): void {
        this._persistence = references.getOneRequired<IMyPersistence>(
            new Descriptor("mygroup", "persistence", "*", "*", "1.0")
        );
    }
    ...
}

let persistence = new MyMongoDbPersistence();

let controller = new MyController();

let references = References.fromTuples(
    new Descriptor("mygroup", "persistence", "mongodb", "default", "1.0"), persistence,
    new Descriptor("mygroup", "controller", "default", "default", "1.0"), controller
);
controller.setReferences(references);

Hierarchy

  • References

Implements

Index

Constructors

constructor

  • Creates a new instance of references and initializes it with references.

    Parameters

    • Default value tuples: any[] = null

      (optional) a list of values where odd elements are locators and the following even elements are component references

    Returns References

Properties

Protected _references

_references: Reference[] = []

Methods

find

  • find<T>(locator: any, required: boolean): T[]
  • Gets all component references that match specified locator.

    throws

    a ReferenceException when required is set to true but no references found.

    Type parameters

    • T

    Parameters

    • locator: any

      the locator to find a reference by.

    • required: boolean

      forces to raise an exception if no reference is found.

    Returns T[]

    a list with matching component references.

getAll

  • getAll(): any[]
  • Gets all component references registered in this reference map.

    Returns any[]

    a list with component references.

getAllLocators

  • getAllLocators(): any[]
  • Gets locators for all registered component references in this reference map.

    Returns any[]

    a list with component locators.

getOneOptional

  • getOneOptional<T>(locator: any): T
  • Gets an optional component reference that matches specified locator.

    Type parameters

    • T

    Parameters

    • locator: any

      the locator to find references by.

    Returns T

    a matching component reference or null if nothing was found.

getOneRequired

  • getOneRequired<T>(locator: any): T
  • Gets a required component reference that matches specified locator.

    throws

    a ReferenceException when no references found.

    Type parameters

    • T

    Parameters

    • locator: any

      the locator to find a reference by.

    Returns T

    a matching component reference.

getOptional

  • getOptional<T>(locator: any): T[]
  • Gets all component references that match specified locator.

    Type parameters

    • T

    Parameters

    • locator: any

      the locator to find references by.

    Returns T[]

    a list with matching component references or empty list if nothing was found.

getRequired

  • getRequired<T>(locator: any): T[]
  • Gets all component references that match specified locator. At least one component reference must be present. If it doesn't the method throws an error.

    throws

    a ReferenceException when no references found.

    Type parameters

    • T

    Parameters

    • locator: any

      the locator to find references by.

    Returns T[]

    a list with matching component references.

put

  • put(locator: any, component: any): void
  • Puts a new reference into this reference map.

    Parameters

    • locator: any

      a locator to find the reference by.

    • component: any

      a component reference to be added.

    Returns void

remove

  • remove(locator: any): any
  • Removes a previously added reference that matches specified locator. If many references match the locator, it removes only the first one. When all references shall be removed, use removeAll method instead.

    see

    removeAll

    Parameters

    • locator: any

      a locator to remove reference

    Returns any

    the removed component reference.

removeAll

  • removeAll(locator: any): any[]
  • Removes all component references that match the specified locator.

    Parameters

    • locator: any

      the locator to remove references by.

    Returns any[]

    a list, containing all removed references.

Static fromTuples

  • Creates a new References from a list of key-value pairs called tuples.

    see

    fromTuplesArray

    Parameters

    • Rest ...tuples: any[]

      a list of values where odd elements are locators and the following even elements are component references

    Returns References

    a newly created References.

Generated using TypeDoc