Package com.github.toolarium.system.command.dto

Class SystemCommand

java.lang.Object

com.github.toolarium.system.command.dto.SystemCommand

All Implemented Interfaces:

ISystemCommand

public class SystemCommand
extends java.lang.Object
implements ISystemCommand

Implements the ISystemCommand.

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.toolarium.system.command.dto.ISystemCommand

ISystemCommand.SystemCommandExecutionStatusResult

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SPACE	SPACE

Constructor Summary

Constructors

Constructor	Description
SystemCommand()	Constructor for SystemCommand
SystemCommand(IProcessEnvironment processEnvironment)	Constructor for SystemCommand

Method Summary

Modifier and Type	Method	Description
void	add(java.lang.String command)	Add an additional part of the command
void	add(java.lang.String command, java.lang.String displayCommand)	Add an additional part of the command
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	getCommandList()	The system command list which will be passed in the exact way to the system command.
IProcessEnvironment	getProcessEnvironment()	Get the process environment
java.util.List<java.lang.String>	getShell()	The shell to execute.
ISystemCommand.SystemCommandExecutionStatusResult	getSystemCommandExecutionStatusResult()	Get the system command execution status result
int	hashCode()
protected void	setCommandList(java.util.List<java.lang.String> commandList)	Set the command list
void	setShell(java.util.List<java.lang.String> shell)	Set the shell
void	setSystemCommandExecutionStatusResult(ISystemCommand.SystemCommandExecutionStatusResult systemCommandExecutionStatusResult)	Set the system command execution status result
java.lang.String	toString()
java.lang.String	toString(boolean forDisplay)	The command as string

Methods inherited from class java.lang.Object

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

Field Detail

SPACE

public static final java.lang.String SPACE

SPACE

See Also:

Constant Field Values

Constructor Detail

SystemCommand

public SystemCommand()

Constructor for SystemCommand

SystemCommand

public SystemCommand(IProcessEnvironment processEnvironment)

Constructor for SystemCommand

Parameters:

processEnvironment - the process environment

Method Detail

getProcessEnvironment

public IProcessEnvironment getProcessEnvironment()

Description copied from interface: ISystemCommand

Get the process environment

Specified by:

getProcessEnvironment in interface ISystemCommand

Returns:

the process environment

See Also:

ISystemCommand.getProcessEnvironment()

getShell

public java.util.List<java.lang.String> getShell()

Description copied from interface: ISystemCommand

The shell to execute.

Specified by:

getShell in interface ISystemCommand

Returns:

the shell to use, by default null.

See Also:

ISystemCommand.getShell()

setShell

public void setShell(java.util.List<java.lang.String> shell)

Set the shell

Parameters:

shell - the shell

getCommandList

public java.util.List<java.lang.String> getCommandList()

Description copied from interface: ISystemCommand

The system command list which will be passed in the exact way to the system command.

Specified by:

getCommandList in interface ISystemCommand

Returns:

the command list

See Also:

ISystemCommand.getCommandList()

add

public void add(java.lang.String command)

Add an additional part of the command

Parameters:

command - the additional part of the command

add

public void add(java.lang.String command,
                java.lang.String displayCommand)

Add an additional part of the command

Parameters:

command - the additional part of the command

displayCommand - the additional part of the command to display

setCommandList

protected void setCommandList(java.util.List<java.lang.String> commandList)

Set the command list

Parameters:

commandList - the command list

getSystemCommandExecutionStatusResult

public ISystemCommand.SystemCommandExecutionStatusResult getSystemCommandExecutionStatusResult()

Description copied from interface: ISystemCommand

Get the system command execution status result

Specified by:

getSystemCommandExecutionStatusResult in interface ISystemCommand

Returns:

the system command execution status result

See Also:

ISystemCommand.getSystemCommandExecutionStatusResult()

setSystemCommandExecutionStatusResult

public void setSystemCommandExecutionStatusResult(ISystemCommand.SystemCommandExecutionStatusResult systemCommandExecutionStatusResult)

Set the system command execution status result

Parameters:

systemCommandExecutionStatusResult - the system command execution status result

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

ISystemCommand.toString(boolean)

toString

public java.lang.String toString(boolean forDisplay)

Description copied from interface: ISystemCommand

The command as string

Specified by:

toString in interface ISystemCommand

Parameters:

forDisplay - true to prepare the arguments for display; otherwise false. This can be used to protect security relevant arguments e.g. java properties with a password

Returns:

the arguments as string

See Also:

ISystemCommand.toString(boolean)