Class VariableManager

java.lang.Object
com.github.gbenroscience.util.VariableManager
public class VariableManager extends Object
Author:
JIBOYE Oluwagbemiro Olaoluwa

  • Field Details

  • Constructor Details

    • VariableManager

      public VariableManager()

  • Method Details

    • getSlot

      public int getSlot(String name)

    • size

      public int size()
      Returns the total number of slots required for the execution frame.

    • reset

      public void reset()

    • getCommandParser

      public VariableManager.CommandInterpreter getCommandParser()

    • setCommandParser

      public void setCommandParser(VariableManager.CommandInterpreter commandParser)

    • getEndOfLine

      public static String getEndOfLine()

    • getVarStore

      public Map<String,Variable> getVarStore()
      Returns:
      the ArrayList object that stores the Variable data of objects of this class.

    • load

      public static void load(Collection<Variable> variables)
      Loads the Variable objects in this Collection into the VARIABLES Map.
      Parameters:
      variables - A Collection of Variable objects.

    • load

      public static void load(Map<String,Variable> variables)
      Loads the Variable objects in this Map into the VARIABLES Map.
      Parameters:
      variables - A Map of Variable objects.

    • load

      public static void load(Map<String,Variable> variables, boolean clearFirst)
      Loads the Variable objects in this Map into the VARIABLES Map.
      Parameters:
      variables - A Map of Variable objects.
      clearFirst - If true, then the VARIABLES is cleared first before new content is loaded into it.

    • contains

      public boolean contains(String variableName)
      Parameters:
      variableName - The name attribute of the variable we are searching the variable store for.
      Returns:
      true if it finds a variable by that name in the store.

    • parseSingleCommand

      public Variable parseSingleCommand(String cmd)
      Parses a command that creates a single variable or changes its value.
      Parameters:
      cmd - The command string to parse.

    • parseCommand

      public final void parseCommand(String cmd)
      Parses a command that creates or changes the value of variables.
      Parameters:
      cmd - The command string to parse.

    • update

      public static void update()
      Saves stored variables and updates the UI that renders the variables.

    • init

      public static void init()
      Initializes the variables store and loads them from persistent storage

    • getVariable

      public static Variable getVariable(String vName)
      Parameters:
      vName - The name of the Variable object.
      Returns:
      the Variable object that has the name supplied if it exists. If no such Variable object exists, then it returns null.

    • lookUp

      public static Variable lookUp(String vName)
      Attempts to retrieve a Variable object from a VariableManager based on its name.
      Parameters:
      vName - The name of the Variable object.
      Returns:
      the Variable object that has that name or null if the Variable is not found.

    • saveIfNotExists

      public static Variable saveIfNotExists(Variable v)

    • saveOrUpdate

      public static Variable saveOrUpdate(Variable v)

    • delete

      public static void delete(String varName)
      deletes a Variable or constant whose name is known
      Parameters:
      varName - the name of the Variable object to be deleted

    • add

      public static void add(Variable var)
      Introduces a Variable
      Parameters:
      var - the name of the Variable object to be added to the Variable Registry

    • add

      public static void add(Variable... vars)
      Introduces an array or variable-args list of Variable
      Parameters:
      vars - the variable args list of the Variable objects to be added to the Variable Registry

    • clearVariables

      public static void clearVariables()
      Clears all Variables

    • clearConstants

      public void clearConstants()
      Clears all constants

    • clearVariablesAndConstants

      public void clearVariablesAndConstants()
      Clears All Variables and Constants

    • generateCommandStringFromVariableNamesArray

      public static String generateCommandStringFromVariableNamesArray(String[] variableNames)
      Parameters:
      variableNames - An array containing valid variable names
      Returns:
      a command string that initializes the variable names to 0.0 e.g if the array is [a,v,b,m,n], then the output is: a=0.0;v=0.0;b=0.0;m=0.0;n=0.0

    • getVariables

      public static final ArrayList<Variable> getVariables()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • main

      public static void main(String[] args)