org.cytoscape.command

Interface AvailableCommands

public interface AvailableCommands

TODO: Missing documentation

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Module: command-executor-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>command-executor-api</artifactId>
</dependency>

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getArguments(String namespace, String command) Returns a list of arguments for the specified namespace and command in alphabetical order.
List<String>	getCommands(String namespace) Returns a list of available commands in alphabetical order for the specified namespace.
List<String>	getNamespaces() Returns a list of available command namespaces in alphabetical order.

Method Detail

getNamespaces

List<String> getNamespaces()

Returns a list of available command namespaces in alphabetical order.

Returns:

A list of available command namespaces in alphabetical order.

getCommands

List<String> getCommands(String namespace)

Returns a list of available commands in alphabetical order for the specified namespace.

Parameters:

namespace - The namespace whose available commands we want to know about.

Returns:

a list of available commands in alphabetical order for the specified namespace.

getArguments

List<String> getArguments(String namespace,
                        String command)

Returns a list of arguments for the specified namespace and command in alphabetical order.

Parameters:

namespace - The namespace for the command whose arguments we want to know about.

command - The command within the specified namespace whose arguments we want to know about.

Returns:

a list of arguments for the specified namespace and command in alphabetical order.