com.realtime.crossfire.jxclient.settings.CommandHistory Class Reference

Collaboration diagram for com.realtime.crossfire.jxclient.settings.CommandHistory:

Public Member Functions
void	addCommand (@NotNull final String command)
	CommandHistory (@NotNull final String ident)
String	down ()
String	last (final int index)
String	up ()

Private Member Functions
void	removeCommand (@NotNull final String command)
void	trimToMaxSize ()

Private Attributes
int	commandIndex
final List< String >	commands = new ArrayList<>(HISTORY_SIZE)

Static Private Attributes
static final int	HISTORY_SIZE = 100

Detailed Description

Manages a list of previously entered commands.

Author

Andreas Kirschbaum

Definition at line 35 of file CommandHistory.java.

Constructor & Destructor Documentation

CommandHistory()

com.realtime.crossfire.jxclient.settings.CommandHistory.CommandHistory

(

@NotNull final String

ident

)

Creates a new instance.

Parameters

ident

the identification string for backing up to file

Definition at line 57 of file CommandHistory.java.

Member Function Documentation

addCommand()

void com.realtime.crossfire.jxclient.settings.CommandHistory.addCommand

(

@NotNull final String

command

)

Adds a new command.

Parameters

command

the command to add

Definition at line 64 of file CommandHistory.java.

References com.realtime.crossfire.jxclient.settings.CommandHistory.commandIndex, com.realtime.crossfire.jxclient.settings.CommandHistory.commands, com.realtime.crossfire.jxclient.settings.CommandHistory.removeCommand(), and com.realtime.crossfire.jxclient.settings.CommandHistory.trimToMaxSize().

Referenced by com.realtime.crossfire.jxclient.gui.textinput.GUIText.keyPressed().

Here is the call graph for this function:

Here is the caller graph for this function:

down()

String com.realtime.crossfire.jxclient.settings.CommandHistory.down

(

)

Returns the next command.

Returns

the next command or

null 

if no previous command exists

Definition at line 118 of file CommandHistory.java.

References com.realtime.crossfire.jxclient.settings.CommandHistory.commandIndex, and com.realtime.crossfire.jxclient.settings.CommandHistory.commands.

Referenced by com.realtime.crossfire.jxclient.gui.textinput.GUIText.historyNext().

Here is the caller graph for this function:

last()

String com.realtime.crossfire.jxclient.settings.CommandHistory.last

(

final int

index

)

Returns the last executed command.

Parameters

index

the index of the command; 0=last command, 1=second to last, etc.

Returns

the last executed command or

null 

if the index is invalid

Definition at line 132 of file CommandHistory.java.

References com.realtime.crossfire.jxclient.settings.CommandHistory.commands.

Referenced by com.realtime.crossfire.jxclient.commands.AgainCommand.execute().

Here is the caller graph for this function:

removeCommand()

void com.realtime.crossfire.jxclient.settings.CommandHistory.removeCommand ( @NotNull final String  command )

private

Removes a command.

Parameters

command

the command to remove

Definition at line 92 of file CommandHistory.java.

References com.realtime.crossfire.jxclient.settings.CommandHistory.commands.

Referenced by com.realtime.crossfire.jxclient.settings.CommandHistory.addCommand().

Here is the caller graph for this function:

trimToMaxSize()

void com.realtime.crossfire.jxclient.settings.CommandHistory.trimToMaxSize ( )

private

Cut off old entries if more than HISTORY_SIZE commands are present.

Definition at line 79 of file CommandHistory.java.

References com.realtime.crossfire.jxclient.settings.CommandHistory.commandIndex, com.realtime.crossfire.jxclient.settings.CommandHistory.commands, and com.realtime.crossfire.jxclient.settings.CommandHistory.HISTORY_SIZE.

Referenced by com.realtime.crossfire.jxclient.settings.CommandHistory.addCommand().

Here is the caller graph for this function:

up()

String com.realtime.crossfire.jxclient.settings.CommandHistory.up

(

)

Returns the previous command.

Returns

the previous command or

null 

if no previous command exists

Definition at line 109 of file CommandHistory.java.

References com.realtime.crossfire.jxclient.settings.CommandHistory.commandIndex, and com.realtime.crossfire.jxclient.settings.CommandHistory.commands.

Referenced by com.realtime.crossfire.jxclient.gui.textinput.GUIText.historyPrev().

Here is the caller graph for this function:

Member Data Documentation

commandIndex

int com.realtime.crossfire.jxclient.settings.CommandHistory.commandIndex

private

The current command index.

Definition at line 51 of file CommandHistory.java.

Referenced by com.realtime.crossfire.jxclient.settings.CommandHistory.addCommand(), com.realtime.crossfire.jxclient.settings.CommandHistory.down(), com.realtime.crossfire.jxclient.settings.CommandHistory.trimToMaxSize(), and com.realtime.crossfire.jxclient.settings.CommandHistory.up().

commands

final List<String> com.realtime.crossfire.jxclient.settings.CommandHistory.commands = new ArrayList<>(HISTORY_SIZE)

private

The commands.

Definition at line 46 of file CommandHistory.java.

Referenced by com.realtime.crossfire.jxclient.settings.CommandHistory.addCommand(), com.realtime.crossfire.jxclient.settings.CommandHistory.down(), com.realtime.crossfire.jxclient.settings.CommandHistory.last(), com.realtime.crossfire.jxclient.settings.CommandHistory.removeCommand(), com.realtime.crossfire.jxclient.settings.CommandHistory.trimToMaxSize(), and com.realtime.crossfire.jxclient.settings.CommandHistory.up().

HISTORY_SIZE

final int com.realtime.crossfire.jxclient.settings.CommandHistory.HISTORY_SIZE = 100

staticprivate

The maximum number of commands to store.

Definition at line 40 of file CommandHistory.java.

Referenced by com.realtime.crossfire.jxclient.settings.CommandHistory.trimToMaxSize().

---

The documentation for this class was generated from the following file:

• src/gui/src/main/java/com/realtime/crossfire/jxclient/settings/CommandHistory.java