com.github.nill14.utils.init.api.IQualifiedProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lazy-init Show documentation
The newest version!
package com.github.nill14.utils.init.api;

import java.lang.annotation.Annotation;
import java.util.Optional;

import com.github.nill14.utils.init.meta.Annotations;
import com.google.inject.Key;

public interface IQualifiedProvider {

  /**
   * @param named 
   * @return a named object from the registry
   * @see Annotations#named(String)
   *
   * Returns from registry the object of given type and qualified with name.
   * If object is not found, an exception is thrown.
   */
  T getNamed(String named);

  /**
   * @param named 
   * @return an optional object from the registry
   * @see Annotations#named(String)
   *
   * Returns from registry the object of given type and qualified with name.
   */
  Optional getOptionalNamed(String named);

  /**
   * @param annotationType 
   * @return a qualified object from the registry
   * @see Annotations#annotation(Class)
   *
   * Returns from registry the object of given type and qualified with the annotation.
   * If object is not found, an exception is thrown.
   * Generates an Annotation for the annotation class. Requires that the annotation is all optionals.
   */
  T getQualified(Class annotationType);

  /**
   * @param annotationType 
   * @return an optional qualified object from the registry
   * @see Annotations#annotation(Class)
   *
   * Returns from registry the object of given type and qualified with the annotation.
   * Generates an Annotation for the annotation class. Requires that the annotation is all optionals.
   */
  Optional getOptionalQualified(Class annotationType);

  /**
   *
   * Returns from registry the object of given type and qualified with the annotation.
   * If object is not found, an exception is thrown.
   * 
   * @param qualifier 	
   * @return a qualified object from the registry
   * @see Key#get(Class, Annotation)
   */
  T getQualified(Annotation qualifier);

  /**
   * @param qualifier 	
   * @return an optional qualified object from the registry
   * @see Key#get(Class, Annotation)
   *
   * Returns from registry the object of given type and qualified with the annotation.
   */
  Optional getOptionalQualified(Annotation qualifier);

}