Module kivakit.component

Package com.telenav.kivakit.component

Interface Component

All Superinterfaces:

Broadcaster, Listener, NamedObject, Receiver<Transmittable>, Repeater, Transceiver, Transmitter<Transmittable>

All Known Subinterfaces:

ComponentMixin

All Known Implementing Classes:

Application, BaseComponent, Server

public interface Component
extends Repeater

Interface to KivaKit component functionality, including easy access to settings (see Settings) and object registries (see Registry).

Packaging Methods

Classes implementing this interface are provided with easy access to packages and package resources relative to the class' package:

• relativeResource(String) - Returns a Resource for the given path relative to the class implementing this interface
• relativePackage(String) - Returns a KivaKit Package for the given path relative to the class implementing this interface

Settings Registry Methods

Settings for a component can be retrieved with settings(Class). This provides a simplified interface to load settings objects specified by the user while also allowing for default settings when they are not specified. See Settings for details.

• require(Class) - Gets the given settings object or fails
• require(Class, Enum) - Gets the settings object of the given instance or fails
• require(Class, String) - Gets the settings object of the given instance or fails
• require(Class, InstanceIdentifier) - Gets the settings object of the given instance or fails
• settings(Class) - A settings object of the specified class or null if none exists
• settings(Class, Enum) - Get any given instance of the given settings object type
• settings(Class, String) - Get any given instance of the given settings object type
• settings(Class, InstanceIdentifier) - Get any given instance of the given settings object type
• settingsRegistry() - Retrieves the Settings registry for this component
• registerDeployment(Deployment) - Adds the settings objects for the given deployment
• registerAllSettings(Settings) - Adds the settings objects in the given settings registry
• registerSettingsObject(Object) - Adds the given settings object
• registerSettingsObject(Object, InstanceIdentifier) - Adds the given settings object under the given instance identifier
• registerAllSettingsIn(Folder) - Adds settings objects from the given folder
• registerAllSettingsIn(Package) - Adds settings objects from the given package

Object Lookup Registry

Access to this component's lookup Registry is provided and fulfills basic needs for object wiring:

• lookup(Class) - Lookup the registered object of the given type, if any
• lookup(Class, String) - Find the given instance of the given class, if any
• lookup(Class, Enum) - Find the given instance of the given class, if any
• lookup(Class, InstanceIdentifier) - Find the given instance of the given class, if any
• registerObject(Object) - Register the given singleton object for lookup
• registerObject(Object, String) - Register the given instance of the given object for lookup
• registerObject(Object, Enum) - Register the given instance of the given object for lookup
• registerObject(Object, InstanceIdentifier) - Register the given instance of the given object for lookup
• registry() - Retrieves the lookup Registry for this component

Author:

jonathanl (shibo)

See Also:

Registry, Settings, Repeater

Method Summary

Modifier and Type	Method	Description
default <T> T	lookup(Class<T> type)	Convenience method
<T> T	lookup(Class<T> type, InstanceIdentifier instance)
default <T> T	lookup(Class<T> type, Enum<?> instance)	Convenience method
default <T> T	lookup(Class<T> type, String instance)	Convenience method
default Resource	packageResource(String path)
void	registerAllSettings(Settings settings)	Registers the settings from the given settings registry with the settings registry for this component
void	registerAllSettingsIn(Folder folder)	Registers the settings in the given folder with the settings registry for this component
void	registerAllSettingsIn(Package package_)	Registers the settings in the given package with the registry for this component
default void	registerDeployment(Deployment deployment)	Adds the settings objects from the given Deployment to the settings registry for this component.
default <T> T	registerObject(T object)	Convenience method
<T> T	registerObject(T object, InstanceIdentifier instance)	Registers the given object and instance in the global object Registry
default <T> T	registerObject(T object, Enum<?> instance)	Convenience method
default <T> T	registerObject(T object, String instance)	Convenience method
default void	registerSettingsObject(Object settings)	Convenience method
void	registerSettingsObject(Object settings, InstanceIdentifier instance)	Registers the given instance of the given settings object with the lookup registry for this component
default Registry	registry()
default Package	relativePackage(String path)
default Resource	relativeResource(String path)
default <T> T	require(Class<T> type)	Convenience method
<T> T	require(Class<T> type, InstanceIdentifier instance)
default <T> T	require(Class<T> type, Enum<?> instance)	Convenience method
default <T> T	require(Class<T> type, String instance)	Convenience method
default <T> T	settings(Class<T> type)	Convenience method
<T> T	settings(Class<T> type, InstanceIdentifier instance)
default <T> T	settings(Class<T> type, Enum<?> instance)	Convenience method
default <T> T	settings(Class<T> type, String instance)	Convenience method
default Settings	settingsRegistry()

Methods inherited from interface com.telenav.kivakit.kernel.messaging.Broadcaster

addListener, addListener, clearListeners, hasListeners, messageSource, messageSource, onTransmit, removeListener, silence, transmit, transmit, transmitAll

Methods inherited from interface com.telenav.kivakit.kernel.messaging.Listener

isDeaf, listenTo, listenTo, message, onMessage

Methods inherited from interface com.telenav.kivakit.kernel.interfaces.naming.NamedObject

objectName, objectName

Methods inherited from interface com.telenav.kivakit.kernel.messaging.Repeater

onHandle, onReceive, receive

Methods inherited from interface com.telenav.kivakit.kernel.messaging.Transceiver

announce, debug, debugClassContext, debugCodeContext, debugCodeContext, fatal, fatal, glitch, glitch, glitch, glitch, halt, halt, handle, ifDebug, illegalArgument, illegalState, illegalState, information, isDebugOn, isOn, narrate, problem, problem, problem, problem, quibble, quibble, quibble, quibble, trace, trace, trace, trace, warning, warning, warning, warning

Method Details

lookup

default <T> T lookup(Class<T> type)

Convenience method

lookup

default <T> T lookup(Class<T> type,
 Enum<?> instance)

Convenience method

lookup

default <T> T lookup(Class<T> type,
 String instance)

Convenience method

lookup

<T> T lookup(Class<T> type,
 InstanceIdentifier instance)

Returns:

Any settings object of the given type and instance

packageResource

default Resource packageResource(String path)

Returns:

The resource at the given path relative to this component's class

registerAllSettings

void registerAllSettings(Settings settings)

Registers the settings from the given settings registry with the settings registry for this component

registerAllSettingsIn

void registerAllSettingsIn(Folder folder)

Registers the settings in the given folder with the settings registry for this component

registerAllSettingsIn

void registerAllSettingsIn(Package package_)

Registers the settings in the given package with the registry for this component

registerDeployment

default void registerDeployment(Deployment deployment)

Adds the settings objects from the given Deployment to the settings registry for this component.

registerObject

default <T> T registerObject(T object)

Convenience method

registerObject

default <T> T registerObject(T object,
 Enum<?> instance)

Convenience method

registerObject

default <T> T registerObject(T object,
 String instance)

Convenience method

registerObject

<T> T registerObject(T object,
 InstanceIdentifier instance)

Registers the given object and instance in the global object Registry

registerSettingsObject

default void registerSettingsObject(Object settings)

Convenience method

registerSettingsObject

void registerSettingsObject(Object settings,
 InstanceIdentifier instance)

Registers the given instance of the given settings object with the lookup registry for this component

registry

default Registry registry()

Returns:

The lookup registry for this component

relativePackage

default Package relativePackage(String path)

relativeResource

default Resource relativeResource(String path)

require

default <T> T require(Class<T> type)

Convenience method

require

default <T> T require(Class<T> type,
 Enum<?> instance)

Convenience method

require

default <T> T require(Class<T> type,
 String instance)

Convenience method

require

<T> T require(Class<T> type,
 InstanceIdentifier instance)

Returns:

The settings object of the given instance and type, or Ensure.fail() is called if there is no such object

settings

default <T> T settings(Class<T> type)

Convenience method

settings

default <T> T settings(Class<T> type,
 Enum<?> instance)

Convenience method

settings

default <T> T settings(Class<T> type,
 String instance)

Convenience method

settings

<T> T settings(Class<T> type,
 InstanceIdentifier instance)

Returns:

The settings object of the given instance and type or null if there is no such object

settingsRegistry

default Settings settingsRegistry()

Returns:

The settings registry for this component