com.realtime.crossfire.jxclient.scripts

Class DefaultScriptProcess

java.lang.Object

com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess

com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess

All Implemented Interfaces:

ScriptProcess, java.lang.Comparable<ScriptProcess>, java.lang.Runnable

public class DefaultScriptProcess
extends AbstractScriptProcess

A script process that executes an external command.

Constructor Summary

Constructors

Constructor and Description
DefaultScriptProcess(int scriptId, @NotNull java.lang.String filename, @NotNull CommandQueue commandQueue, @NotNull CrossfireServerConnection crossfireServerConnection, @NotNull Stats stats, @NotNull FloorView floorView, @NotNull ItemSet itemSet, @NotNull SpellsManager spellsManager, @NotNull MapUpdaterState mapUpdaterState, @NotNull SkillSet skillSet) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	killScript() Kills the script process.
protected @Nullable java.lang.String	readFromScript() Reads a line from the script process.
protected @Nullable java.lang.String	waitForTermination() Waits until the script has terminated.
protected void	writeToScript(@NotNull java.lang.String data) Sends some data to the script process.

Methods inherited from class com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess

addScriptProcessListener, commandSent, compareTo, equals, getFilename, getScriptId, hashCode, run, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultScriptProcess

public DefaultScriptProcess(int scriptId,
                            @NotNull
                            @NotNull java.lang.String filename,
                            @NotNull
                            @NotNull CommandQueue commandQueue,
                            @NotNull
                            @NotNull CrossfireServerConnection crossfireServerConnection,
                            @NotNull
                            @NotNull Stats stats,
                            @NotNull
                            @NotNull FloorView floorView,
                            @NotNull
                            @NotNull ItemSet itemSet,
                            @NotNull
                            @NotNull SpellsManager spellsManager,
                            @NotNull
                            @NotNull MapUpdaterState mapUpdaterState,
                            @NotNull
                            @NotNull SkillSet skillSet)
                     throws java.io.IOException

Creates a new instance.

Parameters:

scriptId - the script ID identifying the new script

filename - the command including arguments to execute

commandQueue - the command queue for sending commands

crossfireServerConnection - the server connection

stats - the stats instance to watch

floorView - the floor view to use

itemSet - the item set instance to use

spellsManager - the spells manager instance to use

mapUpdaterState - the map updater state instance to use

skillSet - the skill set for looking up skill names

Throws:

java.io.IOException - if the script cannot be created

Method Detail

readFromScript

@Nullable
protected @Nullable java.lang.String readFromScript()
                                                       throws java.io.IOException

Description copied from class: AbstractScriptProcess

Reads a line from the script process.

Specified by:

readFromScript in class AbstractScriptProcess

Returns:

the line or null if the script has exited

Throws:

java.io.IOException - if reading failed

waitForTermination

@Nullable
protected @Nullable java.lang.String waitForTermination()

Description copied from class: AbstractScriptProcess

Waits until the script has terminated.

Specified by:

waitForTermination in class AbstractScriptProcess

Returns:

the termination reason or null if the script exited normally

writeToScript

protected void writeToScript(@NotNull
                             @NotNull java.lang.String data)
                      throws java.io.IOException

Description copied from class: AbstractScriptProcess

Sends some data to the script process.

Specified by:

writeToScript in class AbstractScriptProcess

Parameters:

data - the data

Throws:

java.io.IOException - if sending fails

killScript

public void killScript()

Description copied from interface: ScriptProcess

Kills the script process. Does nothing if the process is not running.