org.scijava.ui.behaviour.io.gui

Class CommandDescriptionsBuilder

java.lang.Object

org.scijava.AbstractContextual

org.scijava.ui.behaviour.io.gui.CommandDescriptionsBuilder

All Implemented Interfaces:

Contextual

public class CommandDescriptionsBuilder
extends AbstractContextual

Helper class to populate CommandDescriptions from CommandDescriptionProviders.

Constructor Summary

Constructors

Constructor and Description
CommandDescriptionsBuilder()

Method Summary

Modifier and Type	Method and Description
void	addManually(CommandDescriptionProvider provider, String... contexts) Manually add a provider in the specified contexts.
void	addManually(CommandDescriptionProvider provider, String context) Manually adds a provider in a specified context.
CommandDescriptions	build()
void	discoverProviders() Adds all CommandDescriptionProviders on the plugin index, with their respective expected contexts.
void	discoverProviders(CommandDescriptionProvider.Scope... scopes) Adds all CommandDescriptionProviders on the plugin index having any of the given scopes, with their respective expected contexts.
void	discoverProviders(Predicate<CommandDescriptionProvider> predicate) Adds all CommandDescriptionProviders on the plugin index that match the given predicate, with their respective expected contexts.
void	verifyManuallyAdded() Debugging helper.

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.scijava.Contextual

setContext

Constructor Detail

CommandDescriptionsBuilder

public CommandDescriptionsBuilder()

Method Detail

addManually

public void addManually(CommandDescriptionProvider provider,
                        String context)

Manually adds a provider in a specified context. For example, this is useful for adding stuff in a specific order, for building nice keyconfig.yaml files.

Parameters:

provider - the provider to add.

context - the context to add to.

addManually

public void addManually(CommandDescriptionProvider provider,
                        String... contexts)

Manually add a provider in the specified contexts. For example, this is useful for adding stuff in a specific order, for building nice keyconfig.yaml files.

Parameters:

provider - the provider to add.

contexts - the list of contexts to add to.

discoverProviders

public void discoverProviders()

Adds all CommandDescriptionProviders on the plugin index, with their respective expected contexts.

discoverProviders

public void discoverProviders(CommandDescriptionProvider.Scope... scopes)

Adds all CommandDescriptionProviders on the plugin index having any of the given scopes, with their respective expected contexts.

discoverProviders

public void discoverProviders(Predicate<CommandDescriptionProvider> predicate)

Adds all CommandDescriptionProviders on the plugin index that match the given predicate, with their respective expected contexts.

verifyManuallyAdded

public void verifyManuallyAdded()

Debugging helper. Checks whether all manually added providers are automatically discovered, and vice versa. Prints warnings to stderr otherwise.

build

public CommandDescriptions build()