Package uk.ac.manchester.spinnaker.nmpi.machinemanager.commands

Class Command<A>

java.lang.Object

uk.ac.manchester.spinnaker.nmpi.machinemanager.commands.Command<A>

Type Parameters:

A - The type of arguments.

Direct Known Subclasses:

CreateJobCommand, DestroyJobCommand, GetJobMachineInfoCommand, GetJobStateCommand, JobKeepAliveCommand, ListMachinesCommand, NoNotifyJobCommand, NotifyJobCommand, PowerOffJobBoardsCommand, PowerOnJobBoardsCommand, WhereIsCommand

public abstract class Command<A>
extends Object

A serialisable request to spalloc.

Constructor Summary

Constructors

Constructor	Description
Command(String command)	Create a command.

Method Summary

Modifier and Type	Method	Description
protected void	addArg(A... values)	Add to the positional arguments part.
protected void	addKwArg(String key, Object value)	Add to the keyword arguments part.
List<A>	getArgs()	Get the command arguments.
String	getCommand()	Get the command name.
Map<String,Object>	getKwargs()	Get the command keyword arguments.

Methods inherited from class java.lang.Object

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

Constructor Details

Command

public Command(String command)

Create a command.

Parameters:

command - The command token.

Method Details

addKwArg

protected final void addKwArg(String key, Object value)

Add to the keyword arguments part.

Parameters:

key - The keyword

value - The argument value; will be converted to a string

addArg

@SafeVarargs protected final void addArg(A... values)

Add to the positional arguments part.

Parameters:

values - The arguments to add.

getCommand

public String getCommand()

Get the command name.

Returns:

The command name

getArgs

public List<A> getArgs()

Get the command arguments.

Returns:

The command arguments.

getKwargs

public Map<String,Object> getKwargs()

Get the command keyword arguments.

Returns:

The command keyword arguments