KeywordInterface

Object

KeywordInterface

public class KeywordInterface
extends Object

KeywordInterface is the backend for CommandUI, providing support for parsing user input to commands and functions.

Field Summary

Fields

Modifier and Type Field Description

static Object prev
The previous output of useKeywords(String)

Method Summary

Modifier and Type	Method	Description
`static GeneralFunction`	`parseStored(String input)`	Parses input using `useKeywords(String)` and `storedFunctions`
`static Object`	`safeKeywords(String input)`	Runs `useKeywords(String)` assuming that the input is not an exit argument, removing the checked exception
`static GeneralFunction`	`substituteAll(GeneralFunction function)`	Substitutes everything stored in `storedFunctions` into `function` in an unspecified order
`static Object`	`useKeywords(String input)`	Takes input as a string in the format `"command arguments..."`

Methods inherited from class Object

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

Field Details
- prev
  
  public static Object prev
  
  The previous output of useKeywords(String)
Method Details
- useKeywords
  
  public static Object useKeywords(String input) throws UserExitException
  
  Takes input as a string in the format "command arguments..."
  
  Parameters:
  
  input - a string that contains the command and arguments
  
  Returns:
  
  the Object requested
  
  Throws:
  
  UserExitException - if the input prompts an exit from the program
- safeKeywords
  
  public static Object safeKeywords(String input)
  
  Runs useKeywords(String) assuming that the input is not an exit argument, removing the checked exception
  
  Parameters:
  
  input - the input for useKeywords(String)
  
  Returns:
  
  the output of useKeywords(String)
  
  Throws:
  
  IllegalArgumentException - if the input passed throws an UserExitException
- parseStored
  
  public static GeneralFunction parseStored(String input)
  
  Parses input using useKeywords(String) and storedFunctions
  
  Parameters:
  
  input - input string
  
  Returns:
  
  a GeneralFunction
- substituteAll
  
  public static GeneralFunction substituteAll(GeneralFunction function)
  
  Substitutes everything stored in storedFunctions into function in an unspecified order
  
  Parameters:
  
  function - the function to be substituted into
  
  Returns:
  
  input with all substitutions