Interface Populator

All Known Implementing Classes:
PopulatorImpl

public interface Populator
Implementations of this interface are used to populate HK2 service locators from inhabitants files
See Also:
  • Method Details

    • populate

      List<ActiveDescriptor<?>> populate(DescriptorFileFinder fileFinder, PopulatorPostProcessor... postProcessors) throws IOException, MultiException
      This method can be used to populate the service locator with files that have been written out using the DescriptorImpl writeObject method.
      Parameters:
      fileFinder - An object that finds files in the environment. If this is null then the system will look in the service locator for an implementation of DescriptorFileFinder. If one is still not find this service will return an empty list
      postProcessors - post-processors that allows the environment to modify the set of descriptors that are added to the system.
      Returns:
      The list of descriptors added to the system. Will not return null, but may return an empty list
      Throws:
      IOException - In case of an error reading the input streams
      MultiException - if the user code throws an error, in which case none of the descriptors will be added to the system
    • populate

      This method will populate the service locator using the system classloader to find the hk2-locator files from the default location of META-INF/hk2-locator/default. No post processing will be done on the descriptors added to the system
      Returns:
      The list of descriptors added to the system. Will not return null, but may return an empty list
      Throws:
      IOException - if there was an error reading any of the descriptors
      MultiException - if the user code throws an error, in which case none of the descriptors will be added to the system