com.highqsoft.fwk

Class FwkExecuteCommand

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkExecuteCommand

All Implemented Interfaces:

FwkDescriptionInterface, FwkInterface, FwkTransferableInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable, java.lang.Runnable

public class FwkExecuteCommand
extends FwkDescription
implements java.lang.Runnable

This class executes an OS command string in a new thread.

Since:

$Date: 2017/04/06 13:28:59 $

Version:

$Revision: 1.14 $

Author:

Andreas Hofmann

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FwkExecuteCommand.OutputEvent
class	FwkExecuteCommand.OutputListener
static class	FwkExecuteCommand.StandardOutputListener
class	FwkExecuteCommand.StateListener

Field Summary

Fields

Modifier and Type	Field and Description
protected static FwkDescriptionInterface	descriptor
protected java.lang.Process	process
protected java.lang.Thread	processReadThread
protected static FwkExecuteCommand.StandardOutputListener	standardOutputListener
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Constructor Summary

Constructors

Constructor and Description
FwkExecuteCommand() Constructor.
FwkExecuteCommand(java.lang.String command) Constructor receiving the command to be executed.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExecuteOutputListener(FwkExecuteOutputListenerInterface listener) Add an FwkExecuteOutput listener.
void	addExecuteStateListener(FwkExecuteStateListenerInterface listener) Add an FwkExecuteState listener.
void	addStandardOutputListener() Add the standard output listener to the listener list.
void	appendArgument(java.lang.String arg) Append an argument.
protected void	execute()
protected void	fireOutputEvent(java.lang.String outString, java.lang.String errString) Fire a state event.
protected void	fireStateEvent(int state) Fire a state event.
java.lang.String[]	getArguments() Get the arguments
protected java.lang.String[]	getCmdArray() Get the string array for the execute command.
java.lang.String	getCommandLine() Return the command line string.
static FwkDescriptionInterface	getDescriptor()
java.lang.String	getErrorString() Get the error string.
int	getExitValue() Get the exit value.
java.lang.String	getOSCommand() Get the command string.
java.lang.String	getOutputString() Get the output string.
int	getState() Returns the last state.
java.lang.String	getStateString() Returns the last state.
java.lang.String	getVersion() Return the version string of the FWK component.
java.io.File	getWorkingDirectory() Set the working directory.
void	insertArgument(java.lang.String arg, int index) Insert an argument.
static void	main(java.lang.String[] args)
protected void	printStackTrace(java.lang.Throwable t) Print the stacktrace to the error buffer.
protected void	readExecuteStreamContent()
void	removeArgument(int index) Remove an argument.
void	removeArgument(java.lang.String arg) Remove an argument.
void	removeExecuteOutputListener(FwkExecuteOutputListenerInterface listener) Remove an FwkExecuteOutput listener.
void	removeExecuteStateListener(FwkExecuteStateListenerInterface listener) Remove an FwkExecuteState listener.
void	removeStandardOutputListener() Remove the standard output listener from the listener list.
void	run()
void	setArguments(java.lang.String[] args) Set the arguments
void	setOSCommand(java.lang.String command) Set the command string.
void	setWorkingDirectory(java.io.File dir) Set the working directory.
void	setWorkingDirectory(java.lang.String dir) Set the working directory.
protected void	start()
protected void	stop()

Methods inherited from class com.highqsoft.fwk.FwkDescription

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

descriptor

protected static final FwkDescriptionInterface descriptor

standardOutputListener

protected static FwkExecuteCommand.StandardOutputListener standardOutputListener

processReadThread

protected java.lang.Thread processReadThread

process

protected java.lang.Process process

Constructor Detail

FwkExecuteCommand

public FwkExecuteCommand()

Constructor.

FwkExecuteCommand

public FwkExecuteCommand(java.lang.String command)

Constructor receiving the command to be executed.

Parameters:

command - the OS command string.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkDescription

getDescriptor

public static FwkDescriptionInterface getDescriptor()

setWorkingDirectory

public void setWorkingDirectory(java.io.File dir)
                         throws java.io.FileNotFoundException

Set the working directory.

Parameters:

dir - the working directory.

Throws:

java.io.FileNotFoundException

setWorkingDirectory

public void setWorkingDirectory(java.lang.String dir)
                         throws java.io.FileNotFoundException

Set the working directory.

Parameters:

dir - the working directory.

Throws:

java.io.FileNotFoundException

getWorkingDirectory

public java.io.File getWorkingDirectory()

Set the working directory.

Parameters:

dir - the working directory.

getCmdArray

protected java.lang.String[] getCmdArray()

Get the string array for the execute command.

Returns:

a string array. The first component is the command.

setArguments

public void setArguments(java.lang.String[] args)

Set the arguments

Parameters:

args - The array of argument strings.

getArguments

public java.lang.String[] getArguments()

Get the arguments

Returns:

The array of argument strings.

insertArgument

public void insertArgument(java.lang.String arg,
                  int index)

Insert an argument.

Parameters:

arg - the argument string.

index - The position of the new argument in argument array.

appendArgument

public void appendArgument(java.lang.String arg)

Append an argument.

Parameters:

arg - the argument string.

removeArgument

public void removeArgument(java.lang.String arg)

Remove an argument.

Parameters:

arg - the argument string.

removeArgument

public void removeArgument(int index)

Remove an argument.

Parameters:

index - the index of the arguments.

setOSCommand

public void setOSCommand(java.lang.String command)

Set the command string. This command will stop the currnet execution thread.

Parameters:

command - the OS command string.

getOSCommand

public java.lang.String getOSCommand()

Get the command string.

Returns:

the OS command string.

getCommandLine

public java.lang.String getCommandLine()

Return the command line string.

Returns:

the command line string.

getState

public int getState()

Returns the last state.

Returns:

the last occurred state.

See Also:

com.highqsoft.interfaces.fwk.FwkStateEventInterface

getOutputString

public java.lang.String getOutputString()

Get the output string.

Returns:

the output string.

getErrorString

public java.lang.String getErrorString()

Get the error string.

Returns:

the error string.

getExitValue

public int getExitValue()
                 throws java.lang.IllegalThreadStateException

Get the exit value.

Returns:

the exit value.

Throws:

java.lang.IllegalThreadStateException

See Also:

Process

execute

protected void execute()

readExecuteStreamContent

protected void readExecuteStreamContent()

printStackTrace

protected void printStackTrace(java.lang.Throwable t)

Print the stacktrace to the error buffer.

Parameters:

t - The exception

run

public void run()

Specified by:

run in interface java.lang.Runnable

start

protected void start()

stop

protected void stop()

addStandardOutputListener

public void addStandardOutputListener()

Add the standard output listener to the listener list. The standard output listener prints the output string to the standard output stream and the error string to the standard error stream.

removeStandardOutputListener

public void removeStandardOutputListener()

Remove the standard output listener from the listener list. The standard output listener prints the output string to the standard output stream and the error string to the standard error stream.

addExecuteStateListener

public void addExecuteStateListener(FwkExecuteStateListenerInterface listener)

Add an FwkExecuteState listener.

Parameters:

listener - the listener.

removeExecuteStateListener

public void removeExecuteStateListener(FwkExecuteStateListenerInterface listener)

Remove an FwkExecuteState listener.

Parameters:

listener - the listener.

addExecuteOutputListener

public void addExecuteOutputListener(FwkExecuteOutputListenerInterface listener)

Add an FwkExecuteOutput listener.

Parameters:

listener - the listener.

removeExecuteOutputListener

public void removeExecuteOutputListener(FwkExecuteOutputListenerInterface listener)

Remove an FwkExecuteOutput listener.

Parameters:

listener - the listener.

fireStateEvent

protected void fireStateEvent(int state)

Fire a state event.

Parameters:

state - the state to be publiched.

fireOutputEvent

protected void fireOutputEvent(java.lang.String outString,
                   java.lang.String errString)

Fire a state event.

Parameters:

state - the state to be publiched.

getStateString

public java.lang.String getStateString()

Returns the last state.

Returns:

the last occurred state.

See Also:

com.highqsoft.interfaces.fwk.FwkStateEventInterface

main

public static void main(java.lang.String[] args)