PrepareCmd

java.lang.Object
- org.vishia.cmd.PrepareCmd

Deprecated.
since 2016-12. Use the JZtxtcmdExecuter instead. It has more capability.
```
public final class PrepareCmd
extends java.lang.Object
```
This class prepares a command and holds it maybe with place holder for files. A command may be written in form for example ">cmd <*file1> -option <*dirAbs>". The optional first char determines how the command should be executed. The preparation finds out the textual given placeholder and stores it in an internal format. The method PrepareCmd() returns the command with given actual parameter in the form, which is able to execute with java.lang.Process

First char of command maybe the kind of execution. See { @link #PrepareCmd(char)}

Placeholder
- <*file>: The file how it is given in arguments, maybe a relative path.
- <*dir>: The dir how it is given in arguments, maybe a relative path.
- <*name>: The name of the file, without path, without extension. It is the string after the last '/' and before the last '.'
- <*nameExt>: The name of the file without path, but with extension. It is the string after the last '/'
- <*ext>: The extension. It is the string after the last '.'
- <*localFile>: The local path of the file. A local path is supported by some calling conventions. It makes it possible to use a path, but starting from any given directory.
- <*absFile>: The absolute canonical path of the file.
- <*localDir>: The local path of the directory where the file is placed.
- <*absDir>: The absolute canonical path of the directory where the file is placed.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`PrepareCmd.CmdReplace` Deprecated. Element in the `listPlaceholderForCmdArgsTemplate`.
`private static class`	`PrepareCmd.File3Parts` Deprecated. Instance combines 4 instances to get parts from given files.
`private static class`	`PrepareCmd.FileParts` Deprecated. Helper class to get parts from the file path.

Field Summary

Fields
Modifier and Type	Field and Description
`private char`	`cKindOfExecutionDefault` Deprecated. Kind of the execution as default value given on ctor
`private char`	`cKindOfExecutionPrepared` Deprecated. Kind of the execution of the prepared command
`private java.lang.String[]`	`cmdArgsTemplate` Deprecated. Command string without placeholder.
`private java.lang.String[]`	`cmdSrc` Deprecated. The command how it is given with place holder.
`static char`	`executeInShellClose` Deprecated. Kind of command execution: A system shell should be opened while execution and close after them.
`static char`	`executeInShellOpened` Deprecated. Kind of command execution: A system shell should be opened and let open after execution.
`static char`	`executeJavaMain` Deprecated. Kind of command execution: A java class's main method is invoked.
`static char`	`executeLocalPipes` Deprecated. Kind of command execution: The execution is done using local pipes.
`static char`	`executeQuest` Deprecated. Kind of command execution: A java class's main method is invoked.
`static char`	`executeStartProcess` Deprecated. Kind of command execution: A new system process is started.
`private boolean`	`isWindows` Deprecated.
`private java.util.List<PrepareCmd.CmdReplace>`	`listPlaceholderForCmdArgsTemplate` Deprecated. List of positions where somewhat is to be preplaced.
`private java.lang.String`	`name` Deprecated. Name of the command which it is showing to select.
`private PrepareCmd.File3Parts`	`part` Deprecated.
`static java.lang.String`	`version` Deprecated. Version, history and license: 2016-12-27 Hartmut deprecated.

Constructor Summary

Constructors
Constructor and Description

PrepareCmd()
Deprecated.

PrepareCmd(char cKindOfExecution)
Deprecated.

Creates an instance of a Preparer for a command.

Constructors
Constructor and Description
`PrepareCmd()` Deprecated.
`PrepareCmd(char cKindOfExecution)` Deprecated. Creates an instance of a Preparer for a command.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`private boolean`	`checkIsWindows()` Deprecated.
`java.lang.Class`	`getJavaClass()` Deprecated. If the command is a Java class call, returns the Java class from class loader.
`char`	`getKindOfExecution()` Deprecated.
`java.lang.String[]`	`prepareCmd(CmdGetFileArgs_ifc args)` Deprecated. Prepares a command for execution.
`void`	`prepareListCmdReplace()` Deprecated.
`void`	`set_cmd(java.lang.String cmd)` Deprecated. Sets the command and prepares it.
`void`	`set_name(java.lang.String name)` Deprecated. Sets the name of the command.
`java.lang.String`	`toString()` Deprecated.
`boolean`	`usePipes()` Deprecated. Returns true if the stdin, stdout and stderr should be used and the end of execution is awaiting.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - version
```
public static java.lang.String version
```
    Deprecated.
    Version, history and license:
    - 2016-12-27 Hartmut deprecated. Use the JZtxtcmdExecuter instead. It has more capability.
    - 2012-06-09 Hartmut bugfix the detection of <*file1> 2 or 3 may be erroneous.
    - 2012-06-09 Hartmut new or bugfix for windows: Now the slashs are converted to backslash in file paths, see checkIsWindows(). The environment variabls "os" will be tested whether it starts with "windows" (converted non-case sensitive).
    - 2011-10-08 Hartmut new Detection of >& to select kind of command, getJavaClass() prepared (not ready)
    Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:
    1. You can use this source without any restriction for any desired purpose.
    2. You can redistribute copies of this source to everybody.
    3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
    4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
    5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.
    If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.
  - executeInShellOpened
```
public static final char executeInShellOpened
```
    Deprecated.
    
    Kind of command execution: A system shell should be opened and let open after execution. The user can view the output after execution and invoke commands after execution of the started command.
    
    See Also:
    
    Constant Field Values
  - executeInShellClose
```
public static final char executeInShellClose
```
    Deprecated.
    
    Kind of command execution: A system shell should be opened while execution and close after them. The user can view the output while execution. After execution neither the return value (errorlevel) nor console outputs are visible. This kind of operation can use if any pause commands are part of the command script, or the command window should inform only, or the execution paused on errors only.
    
    See Also:
    
    Constant Field Values
  - executeStartProcess
```
public static final char executeStartProcess
```
    Deprecated.
    
    Kind of command execution: A new system process is started. This kind of execution is proper to start any process, which has its own window.
    
    See Also:
    
    Constant Field Values
  - executeLocalPipes
```
public static final char executeLocalPipes
```
    Deprecated.
    
    Kind of command execution: The execution is done using local pipes. This kind of execution starts a new process for execution outside the Java VM sphere but it redirects the pipes (input, output, errorOutput) to the local pipes. So the pipes can be used from the caller level. The process has no window on the users display if it is a command line process.
    
    See Also:
    
    Constant Field Values
  - executeJavaMain
```
public static final char executeJavaMain
```
    Deprecated.
    
    Kind of command execution: A java class's main method is invoked.
    
    See Also:
    
    Constant Field Values
  - executeQuest
```
public static final char executeQuest
```
    Deprecated.
    
    Kind of command execution: A java class's main method is invoked.
    
    See Also:
    
    Constant Field Values
  - part
```
private final PrepareCmd.File3Parts part
```
    Deprecated.
  - listPlaceholderForCmdArgsTemplate
```
private java.util.List<PrepareCmd.CmdReplace> listPlaceholderForCmdArgsTemplate
```
    Deprecated.
    
    List of positions where somewhat is to be preplaced.
  - cmdArgsTemplate
```
private java.lang.String[] cmdArgsTemplate
```
    Deprecated.
    
    Command string without placeholder. The positions of the placeholder are contained in listPlaceholderForCmdArgsTemplate. It may be a template of the command because the correct files to use are not contained, instead the listPlaceholderForCmdArgsTemplate contains the kind of placeholder.
  - cKindOfExecutionDefault
```
private final char cKindOfExecutionDefault
```
    Deprecated.
    
    Kind of the execution as default value given on ctor
  - isWindows
```
private final boolean isWindows
```
    Deprecated.
  - cKindOfExecutionPrepared
```
private char cKindOfExecutionPrepared
```
    Deprecated.
    
    Kind of the execution of the prepared command
  - cmdSrc
```
private java.lang.String[] cmdSrc
```
    Deprecated.
    
    The command how it is given with place holder. Maybe from ZBNF2Java-parsing. This value is used only as parameter in prepareListCmdReplace(). It isn't use after them.
  - name
```
private java.lang.String name
```
    Deprecated.
    
    Name of the command which it is showing to select.
- Constructor Detail
  - PrepareCmd
```
PrepareCmd(char cKindOfExecution)
```
    Deprecated.
    Creates an instance of a Preparer for a command. The argument determines the kind of execution. It is the default if the given command doesn't contain a first char which determines the kind of execution. See one of executeInShellClose, executeInShellClose, executeLocalPipes and executeStartProcess.
    - '%': invocation of command with output and error output
    - '&' invocation of command without in/out pipe, typical start another process without feedback.
    - '$' opens a shell for invocation of command.
    - '>' opens a shell for invocation of command.
    - 'm' call of a java class. Class path after '*'.
    Parameters:
    
    cKindOfExecution - One of 0 or '%', '>', '&', '$' or '*'
  - PrepareCmd
```
PrepareCmd()
```
    Deprecated.
- Method Detail
  - checkIsWindows
```
private final boolean checkIsWindows()
```
    Deprecated.
  - prepareListCmdReplace
```
@Deprecated
public void prepareListCmdReplace()
```
    Deprecated.
    
    Prepares the string given #cmd with placeholder in the internal form. This method can be invoked on creation of this class or if a new cmd is assigned.
  - set_cmd
```
public void set_cmd(java.lang.String cmd)
```
    Deprecated.
    
    Sets the command and prepares it. This method may be invoked using ZbnfJavaOutput with the ZBNF parser.
    
    Parameters:
    
    cmd - The command with placeholder.
  - set_name
```
public void set_name(java.lang.String name)
```
    Deprecated.
    
    Sets the name of the command. Note that the name isn't necessary internal. It is only given to present commands with a short name in a list. This method may be invoked using ZbnfJavaOutput with the ZBNF parser.
    
    Parameters:
    
    name - The string given name.
  - prepareCmd
```
public java.lang.String[] prepareCmd(CmdGetFileArgs_ifc args)
```
    Deprecated.
    
    Prepares a command for execution.
    
    Parameters:
    
    args - Interface to get the input files for the command. Getting the file is optimized. CmdGetFileArgs_ifc.getFile1() etc. is only called one time in this method. It means the getting process can be complex in the implementor of CmdGetFileArgs_ifc. Getting of file parts is optimized, for example only one time getCanonicalPath().
    
    Returns:
    
    The command how it is executable as parameter for java.lang.Process or any other command invocation.
  - getJavaClass
```
public java.lang.Class getJavaClass()
```
    Deprecated.
    
    If the command is a Java class call, returns the Java class from class loader. Elsewhere returns null.
    
    Returns:
  - usePipes
```
public boolean usePipes()
```
    Deprecated.
    
    Returns true if the stdin, stdout and stderr should be used and the end of execution is awaiting.
    
    Returns:
  - getKindOfExecution
```
public char getKindOfExecution()
```
    Deprecated.
  - toString
```
public java.lang.String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class java.lang.Object

Class PrepareCmd

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

executeInShellOpened

executeInShellClose

executeStartProcess

executeLocalPipes

executeJavaMain

executeQuest

part

listPlaceholderForCmdArgsTemplate

cmdArgsTemplate

cKindOfExecutionDefault

isWindows

cKindOfExecutionPrepared

cmdSrc

name

Constructor Detail

PrepareCmd

PrepareCmd

Method Detail

checkIsWindows

prepareListCmdReplace

set_cmd

set_name

prepareCmd

getJavaClass

usePipes

getKindOfExecution

toString