References

An implementation of IReferences that allows you to store and locate component references.

Implements: IReferences

Description

The References class allows you to store and locate component references.

Constructors

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

public References(Object[] tuples)

  • tuples: Object[] - (optional) list of values where odd elements are locators and the following even elements are component references.

Fields

_references

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

protected List<Reference> _references = new ArrayList<>()

Instance methods

find

Gets all component references that match a specified locator.
Throws a ReferenceException when required is set to true but no references were found.

public List find(Object locator, boolean required) throws ReferenceException

  • locator: Object - locator to find a reference by.
  • required: boolean - forces to raise an exception if no reference is found.
  • returns: List - list with matching component references.

    getAll

    Gets all component references registered in this reference map.

    public List getAll()

    • returns: List - list with component references.

      getAllLocators

      Gets locators for all registered component references in this reference map.

      public List getAllLocators()

      • returns: List - list with component locators.

        getOneOptional

        Gets an optional component reference that matches a specified locator.

        public Object getOneOptional(Object locator)

        • locator: Object - locator to find references by.
        • returns: Object - matching component reference or null if nothing was found.

        getOneRequired

        Gets a required component reference that matches specified locator.
        throws a ReferenceException when no references found.

        public getOneRequired<T>(locator: any): T

        • locator: any - locator to find a reference by.
        • returns: T - matching component reference.

        getOptional

        Gets all component references that match a specified locator.

        public getOptional<T>(locator: any): T[]

        • locator: any - locator to find references by.
        • returns: T[] - list with matching component references or empty list if nothing was found.

        getRequired

        Gets all component references that match a 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.

        public Object getOneRequired(Object locator) throws ReferenceException

        • locator: Object - locator to find references by.
        • returns: Object - list with matching component references.

        put

        Puts a new reference into this reference map.

        public void put(Object locator, Object component) throws NullPointerException

        • locator: Object - locator to find the reference by.
        • component: Object - component reference to be added.

        remove

        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.

        public Object remove(Object locator)

        • locator: Object - locator to remove reference
        • returns: Object - removed component reference.

        removeAll

        Removes all component references that match the specified locator.

        public List removeAll(Object locator)

        • locator: Object - locator to remove references by.
        • returns: List - list containing all removed references.

          Static methods

          fromTuples

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

          public static References fromTuples(Object… tuples) throws ReferenceException

          • tuples: Object… - list of values where odd elements are locators and the following even elements are component references
          • returns: References - newly created References.

          Examples

          
{
   public class MyController implements IReferenceable {
      public IMyPersistence _persistence;
      ...
      public void setReferences(IReferences references) {
        this._persistence = (IMyPersistence)references.getOneRequired(
          new Descriptor("mygroup", "persistence", "*", "*", "1.0")
        );
      }
      ...
   }
 
   MyMongoDbPersistence persistence = new MyMongoDbPersistence();
 
   MyController controller = new MyController();
 
   References references = References.fromTuples(
     new Descriptor("mygroup", "persistence", "mongodb", "default", "1.0"), persistence,
     new Descriptor("mygroup", "controller", "default", "default", "1.0"), controller
   );
   controller.setReferences(references);
   }

          See also