Command doc.

This commit is contained in:
Johannes Mockenhaupt 2017-07-26 15:50:07 +02:00
parent f6b1887fd2
commit e1b63a4a74
No known key found for this signature in database
GPG key ID: 9E1EA6AF7BBBB0D1

View file

@ -5,6 +5,13 @@ import java.util.List;
import de.jotomo.ruffyscripter.PumpState;
import de.jotomo.ruffyscripter.RuffyScripter;
/**
* Interface for all commands to be executed by the pump.
*
* Note on cammond methods and timing: a method shall wait before and after executing
* as necessary to not cause timing issues, so the caller can just call methods in
* sequence, letting the methods take care of waits.
*/
public interface Command {
CommandResult execute(RuffyScripter ruffyScripter, PumpState initialPumpState);
List<String> validateArguments();