Interface OmnibusDefiner

public interface OmnibusDefiner

Manager responsible for returning Omnibus instances

Author:

A248

Method Summary

Modifier and Type	Method	Description
Omnibus	getOmnibus(Class<?> callerClass)	Gets an Omnibus instance for the given caller class.
boolean	requiresCallerClass()	Whether this provider requires that the caller class be looked up.

Method Details

getOmnibus

Omnibus getOmnibus(Class<?> callerClass)

Gets an Omnibus instance for the given caller class. This is usually a singleton.
This method corresponds to OmnibusProvider.getOmnibus() where callerClass is its caller.

If the caller class is never used, then requiresCallerClass() should return false.

Parameters:

callerClass - the class which called OmnibusProvider.getOmnibus(), or null if the caller class is not required

Returns:

the central omnibus instance the caller class should be using

requiresCallerClass

boolean requiresCallerClass()

Whether this provider requires that the caller class be looked up.
If the implementation of getOmnibus(Class) ignores the callerClass parameter, this method should return false

Returns:

true if the caller class lookup is required, false otherwise