org.jboss.forge.furnace.addons

Interface AddonView

All Known Subinterfaces:

AddonRegistry

public interface AddonView

A view of a set of Addon instances.

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Signal to Furnace that the given AddonView is no longer required, and any Addon instances that are no longer referenced by other AddonView instances may be shut down.
Addon	getAddon(AddonId id) Get the registered Addon for the given AddonId instance.
Set<Addon>	getAddons() Get all currently registered Addon instances.
Set<Addon>	getAddons(AddonFilter filter) Get all registered Addon instances matching the given AddonFilter.
String	getName() Get the unique name of this AddonView.
Set<AddonRepository>	getRepositories() Get the unmodifiable Set of AddonRepository instances by which this AddonView is backed.

Method Detail

getName

String getName()

Get the unique name of this AddonView. Typically something short and nondescript for use in log messages.

dispose

void dispose()

Signal to Furnace that the given AddonView is no longer required, and any Addon instances that are no longer referenced by other AddonView instances may be shut down. Addon instances in this view may no longer function.

getAddon

Addon getAddon(AddonId id)

Get the registered Addon for the given AddonId instance. If no such Addon is currently registered, register it and return the new reference.

Returns:

the registered Addon (Never null.)

getAddons

Set<Addon> getAddons()

Get all currently registered Addon instances.

Returns:

the Set of Addon instances. (Never null.)

getAddons

Set<Addon> getAddons(AddonFilter filter)

Get all registered Addon instances matching the given AddonFilter.

Returns:

the Set of Addon instances. (Never null.)

getRepositories

Set<AddonRepository> getRepositories()

Get the unmodifiable Set of AddonRepository instances by which this AddonView is backed.