org.osgl.inject

Interface ElementLoader<E>

Type Parameters:

E - the generic element type

All Superinterfaces:

ElementFilter<E>

All Known Implementing Classes:

AnnotatedElementLoader, ElementLoaderBase, TypedElementLoader

public interface ElementLoader<E>
extends ElementFilter<E>

An ElementLoader is responsible for providing initial data to be loaded into a Collection type.

Method Summary

Modifier and Type	Method and Description
Iterable<E>	load(Map<String,Object> options, BeanSpec container, Genie genie) Provide element data to be loaded.
int	priority() When multiple ElementLoader are used together to load initial data, the priority() method can used to determine which loader is called first.

Methods inherited from interface org.osgl.inject.ElementFilter

filter

Method Detail

load

Iterable<E> load(Map<String,Object> options,
                 BeanSpec container,
                 Genie genie)

Provide element data to be loaded.

Parameters:

options - options that could be used to regulate the data loading logic

container - the bean spec about the container into which the element will be loaded

genie - the dependency injector that could be used to recursively load dependencies

Returns:

an Iterable of elements

priority

int priority()

When multiple ElementLoader are used together to load initial data, the priority() method can used to determine which loader is called first. All following loaders will be treated as ElementFilter to filter the data series generated by the first loader.

A good practice is if a loader loads fewer number of instance, then the priority value shall be lower than that of the loader which loads more instances.

Returns:

priority of the loader