OS
Performs the execution of commands in the operating system, manipulation of files and folders.
command
_os.command(command: java.lang.String[]) : OSCommand
Description
Executes a command in the operating system and obtains the result of the execution, the first item is the command and the following are parameters.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| command | java.lang.String[] | The command and optional parameters that will be executed. |
Return
( OSCommand )
Result of executing the command in the operating system, including the output.
_os.command(command: java.util.List) : OSCommand
Description
Executes a command in the operating system and obtains the result of the execution, the first item is the command and the following are parameters.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| command | java.util.List | The command and optional parameters that will be executed. |
Return
( OSCommand )
Result of executing the command in the operating system, including the output.
_os.command(command: Values) : OSCommand
Description
Executes a command in the operating system and obtains the result of the execution, the first item is the command and the following are parameters.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| command | Values | The command and optional parameters that will be executed. |
Return
( OSCommand )
Result of executing the command in the operating system, including the output.
directory
_os.directory() : string
Description
Gets the path where the commands will be executed.
Return
( string )
The location where the command will be executed.
_os.directory(directory: string) : OS
Description
Defines the path where the commands will be executed.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| directory | string | The location where the command will be executed. |
Return
( OS )
Instance of the operating system resource.
_os.directory(directory: File) : OS
Description
Defines the path where the commands will be executed.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| directory | File | The location where the command will be executed. |
Return
( OS )
Instance of the operating system resource.
_os.directory(directory: Storage) : OS
Description
Defines the path where the commands will be executed.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| directory | Storage | The location where the command will be executed. |
Return
( OS )
Instance of the operating system resource.
env
_os.env() : Values
Return
( Values )
_os.env(env: Values) : OS
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| env | Values |
Return
( OS )
file
_os.file(path: string) : File
Description
Gets the object of manipulation of files and folders relative to the passed path, in this case the path must be a file.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| path | string | The path of folder that the manipulation object should obtain. |
Return
( File )
Instance of the file and folder manipulation object relative to the passed path, in this case a file.
folder
_os.folder(path: string) : File
Description
Gets the object of manipulation of folders and files relative to the passed path, in this case the path must be a folder.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| path | string | The path of folder that the manipulation object should obtain. |
Return
( File )
Instance of the file and folder manipulation object relative to the passed path, in this case a folder.
getDirectory
_os.getDirectory() : string
Description
Gets the path where the commands will be executed.
Return
( string )
The location where the command will be executed.
getEnv
_os.getEnv() : Values
Return
( Values )
getFile
_os.getFile(path: string) : File
Description
Gets the object of manipulation of files and folders relative to the passed path, in this case the path must be a file.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| path | string | The path of folder that the manipulation object should obtain. |
Return
( File )
Instance of the file and folder manipulation object relative to the passed path, in this case a file.
getFolder
_os.getFolder(path: string) : File
Description
Gets the object of manipulation of folders and files relative to the passed path, in this case the path must be a folder.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| path | string | The path of folder that the manipulation object should obtain. |
Return
( File )
Instance of the file and folder manipulation object relative to the passed path, in this case a folder.
getName
_os.getName() : string
Description
Gets the name of the operating system.
Return
( string )
The name of the operating system.
getShell
_os.getShell() : boolean
Return
( boolean )
getWaitFor
_os.getWaitFor() : long
Return
( long )
init
_os.init() : OS
Description
Starts a new instance of the OS.
Return
( OS )
The new instance of the OS resource.
isFile
_os.isFile(path: string) : boolean
Description
Checks whether the path is a file.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| path | string |
Return
( boolean )
Whether or not it is a file.
isFolder
_os.isFolder(path: string) : boolean
Description
Checks whether the path is a folder.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| path | string |
Return
( boolean )
Whether or not it is a folder.
isLinux
_os.isLinux() : boolean
Description
Checks whether the operating system is Linux.
Return
( boolean )
Whether or not the operating system Linux.
isMac
_os.isMac() : boolean
Description
Checks whether the operating system is Mac OS X.
Return
( boolean )
Whether or not the operating system Mac OS X.
isOS
_os.isOS(osType: string) : boolean
Description
Checks the operating system based on the past name which can be Linux, Mac or Windows.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| osType | string | The type of operating system that can be Linux, Mac, or Windows. |
Return
( boolean )
Whether or not the operating system is indicated.
isReadCommandError
_os.isReadCommandError() : boolean
Return
( boolean )
isReadCommandOutput
_os.isReadCommandOutput() : boolean
Return
( boolean )
isWindows
_os.isWindows() : boolean
Description
Checks whether the operating system is Windows.
Return
( boolean )
Whether or not the operating system Windows.
name
_os.name() : string
Description
Gets the name of the operating system.
Return
( string )
The name of the operating system.
readCommandError
_os.readCommandError() : boolean
Return
( boolean )
_os.readCommandError(readCommandError: boolean) : OS
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| readCommandError | boolean |
Return
( OS )
readCommandOutput
_os.readCommandOutput() : boolean
Return
( boolean )
_os.readCommandOutput(readCommandOutput: boolean) : OS
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| readCommandOutput | boolean |
Return
( OS )
setDirectory
_os.setDirectory(directory: string) : OS
Description
Defines the path where the commands will be executed.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| directory | string | The location where the command will be executed. |
Return
( OS )
Instance of the operating system resource.
_os.setDirectory(directory: File) : OS
Description
Defines the path where the commands will be executed.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| directory | File | The location where the command will be executed. |
Return
( OS )
Instance of the operating system resource.
_os.setDirectory(directory: Storage) : OS
Description
Defines the path where the commands will be executed.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| directory | Storage | The location where the command will be executed. |
Return
( OS )
Instance of the operating system resource.
setEnv
_os.setEnv(shell: Values) : OS
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| shell | Values |
Return
( OS )
setReadCommandError
_os.setReadCommandError(readCommandError: boolean) : OS
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| readCommandError | boolean |
Return
( OS )
setReadCommandOutput
_os.setReadCommandOutput(readCommandOutput: boolean) : OS
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| readCommandOutput | boolean |
Return
( OS )
setShell
_os.setShell(shell: boolean) : OS
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| shell | boolean |
Return
( OS )
setWaitFor
_os.setWaitFor(waitFor: long) : OS
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| waitFor | long |
Return
( OS )
shell
_os.shell() : boolean
Return
( boolean )
_os.shell(shell: boolean) : OS
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| shell | boolean |
Return
( OS )
waitFor
_os.waitFor() : long
Return
( long )
_os.waitFor(waitFor: long) : OS
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| waitFor | long |
Return
( OS )