Package org.jmol.util
Class CommandHistory
java.lang.Object
org.jmol.util.CommandHistory
Implements a queue for a bash-like command history.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate javajs.util.Lst<String>
Array of commands.private int
Current position of the cursor;(package private) static final int
static final String
(package private) boolean
private javajs.util.Lst<String>
private int
private int
Position of the next command.static final String
static final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCommand
(String strCommand) Adds any number of lines to the command historyprivate void
addCommandLine
(String command) Adds a single line to the bottom of the list, resets list position.void
clear()
clears the history.private String
Calculates the command to return.Retrieves the following command from the top of the list, updates list position.Retrieves the following command from the bottom of the list, updates list position.getSetHistory
(int n) Options include: all Integer.MAX_VALUE n prev n >= 1 next -1 set max to -2 - n n <= -3 just clear -2 clear and turn off; return "" 0 clear and turn on; return "" Integer.MIN_VALUE;popState()
void
removeCommand
(int n) void
reset
(int maxSize) Resets instance.void
setMaxSize
(int maxSize) Resets maximum size of command queue.
-
Field Details
-
ERROR_FLAG
- See Also:
-
NOHISTORYLINE_FLAG
- See Also:
-
NOHISTORYATALL_FLAG
- See Also:
-
DEFAULT_MAX_SIZE
static final int DEFAULT_MAX_SIZE- See Also:
-
commandList
Array of commands. -
maxSize
private int maxSize -
nextCommand
private int nextCommandPosition of the next command. -
cursorPos
private int cursorPosCurrent position of the cursor; -
isOn
boolean isOn -
lstStates
-
-
Constructor Details
-
CommandHistory
public CommandHistory()Creates a new instance using the default size (100)
-
-
Method Details
-
clear
public void clear()clears the history. -
reset
public void reset(int maxSize) Resets instance.- Parameters:
maxSize
- maximum size for the command queue.
-
setMaxSize
public void setMaxSize(int maxSize) Resets maximum size of command queue. Cuts off extra commands.- Parameters:
maxSize
- maximum size for the command queue.
-
getCommandUp
Retrieves the following command from the bottom of the list, updates list position.- Returns:
- the String value of a command.
-
getCommandDown
Retrieves the following command from the top of the list, updates list position.- Returns:
- the String value of a command.
-
getCommand
Calculates the command to return.- Returns:
- the String value of a command.
-
addCommand
Adds any number of lines to the command history- Parameters:
strCommand
-
-
getSetHistory
Options include: all Integer.MAX_VALUE n prev n >= 1 next -1 set max to -2 - n n <= -3 just clear -2 clear and turn off; return "" 0 clear and turn on; return "" Integer.MIN_VALUE;- Parameters:
n
-- Returns:
- one or more lines of command history
-
find
-
removeCommand
-
removeCommand
-
addCommandLine
Adds a single line to the bottom of the list, resets list position.- Parameters:
command
- the String value of a command.
-
pushState
-
popState
-