org.epics.pvmanager.exec

Class ExecServiceMethodDescription

java.lang.Object

org.epics.pvmanager.exec.ExecServiceMethodDescription

public class ExecServiceMethodDescription
extends Object

The description for an executor service method (i.e. a shell command).

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
ExecServiceMethodDescription(String name, String description) A new service method with the given name and description.

Method Summary

Methods

Modifier and Type	Method and Description
ExecServiceMethodDescription	addArgument(String name, String description, Class<?> type) Adds an argument for the query.
ExecServiceMethodDescription	command(String command)
ExecServiceMethodDescription	queryResult(String name, String description) Adds a result for the script.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecServiceMethodDescription

public ExecServiceMethodDescription(String name,
                            String description)

A new service method with the given name and description.

Parameters:

name - the method name

description - the method description

Method Detail

addArgument

public ExecServiceMethodDescription addArgument(String name,
                                       String description,
                                       Class<?> type)

Adds an argument for the query.

Arguments need to be specified in the same order as they appear in the query.

Parameters:

name - argument name

description - argument description

type - the expected type of the argument

Returns:

this

queryResult

public ExecServiceMethodDescription queryResult(String name,
                                       String description)

Adds a result for the script.

Parameters:

name - the result name

description - the result description

Returns:

this

command

public ExecServiceMethodDescription command(String command)