ScriptDependency (T-Plan Robot Enterprise 8.1.2 Code Documentation)

java.lang.Object
- com.tplan.robot.scripting.ScriptDependency

```
public class ScriptDependency
extends Object
```
Script dependency on a particular OS, on an installed plugin or an external file or on data stored in the user configuration file. Data about script dependencies are collected during customized compilation process (see ScriptingContext.isDependencyTracking() to verify whether the script is portable onto another environment, for example in form of an executable package.

Since:

7.0.2

T-Plan Robot Enterprise, (C) 2009-2025 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors
Constructor and Description
`ScriptDependency()` Create a vanilla dependency.
`ScriptDependency(ScriptingContext context)` Create a dependency and initialize its location (source script and line number) from the argument context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScriptDependency`	`forCurrentElement(ScriptingContext context)` Populate the dependency location (source script and line number) from the argument context.
`File`	`getFile()`
`ScriptLocation`	`getLocation()`
`String`	`getName()`
`String`	`getPluginCode()` Get code of the plugin the script depends on.
`boolean`	`isConfigFile()`
`boolean`	`isCritical()`
`boolean`	`isLinux()`
`boolean`	`isMac()`
`boolean`	`isSystemSpecific()`
`boolean`	`isWindows()`
`ScriptDependency`	`makeCritical()` Indicate that the dependency is critical and must be strictly enforced.
`ScriptDependency`	`makeCurrentSystemSpecific()` Create dependency on the current OS.
`ScriptDependency`	`makeSystemSpecific()` Indicate that the dependency is system specific and enable the OS support flags.
`String`	`toString()`
`ScriptDependency`	`withConfigFile()` Create dependency on the Robot configuration file.
`ScriptDependency`	`withFile(File f)` Create dependency on an external file or a file referenced with full path.
`ScriptDependency`	`withLinux()` Indicate Linux support.
`ScriptDependency`	`withMac()` Indicate Mac OS support.
`ScriptDependency`	`withName(String name)` Set the dependency display name.
`ScriptDependency`	`withPlugin(String plugin)` Create dependency on an optional plugin.
`ScriptDependency`	`withWindows()` Indicate MS Windows support.

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

- Constructor Detail
  - ScriptDependency
```
public ScriptDependency()
```
    Create a vanilla dependency.
  - ScriptDependency
```
public ScriptDependency(ScriptingContext context)
```
    Create a dependency and initialize its location (source script and line number) from the argument context.
    
    Parameters:
    
    context - a script compilation context.
- Method Detail
  - forCurrentElement
```
public ScriptDependency forCurrentElement(ScriptingContext context)
```
    Populate the dependency location (source script and line number) from the argument context.
    
    Parameters:
    
    context - a script compilation context.
    
    Returns:
    
    this instance.
  - withFile
```
public ScriptDependency withFile(File f)
```
    Create dependency on an external file or a file referenced with full path.
    
    Parameters:
    
    f - a file.
    
    Returns:
    
    this instance.
  - withPlugin
```
public ScriptDependency withPlugin(String plugin)
```
    Create dependency on an optional plugin.
    
    Parameters:
    
    plugin - the plugin code.
    
    Returns:
    
    this instance.
  - withName
```
public ScriptDependency withName(String name)
```
    Set the dependency display name.
    
    Parameters:
    
    name - a name.
    
    Returns:
    
    this instance.
  - withConfigFile
```
public ScriptDependency withConfigFile()
```
    Create dependency on the Robot configuration file. This is typically interpreted that the configuration file must be copied to the new environment to preserve the script functionality.
    
    Returns:
    
    this instance.
  - makeCritical
```
public ScriptDependency makeCritical()
```
    Indicate that the dependency is critical and must be strictly enforced.
    
    Returns:
    
    this instance.
  - withMac
```
public ScriptDependency withMac()
```
    Indicate Mac OS support. System specific flags are usually taken into account only if makeSystemSpecific() or makeCurrentSystemSpecific() is called too.
    
    Returns:
    
    this instance.
  - withWindows
```
public ScriptDependency withWindows()
```
    Indicate MS Windows support. System specific flags are usually taken into account only if makeSystemSpecific() or makeCurrentSystemSpecific() is called too.
    
    Returns:
    
    this instance.
  - withLinux
```
public ScriptDependency withLinux()
```
    Indicate Linux support. System specific flags are usually taken into account only if makeSystemSpecific() or makeCurrentSystemSpecific() is called too.
    
    Returns:
    
    this instance.
  - makeSystemSpecific
```
public ScriptDependency makeSystemSpecific()
```
    Indicate that the dependency is system specific and enable the OS support flags.
    
    Returns:
    
    this instance.
  - makeCurrentSystemSpecific
```
public ScriptDependency makeCurrentSystemSpecific()
```
    Create dependency on the current OS.
    
    Returns:
    
    this instance.
  - getPluginCode
```
public String getPluginCode()
```
    Get code of the plugin the script depends on.
    
    Returns:
    
    the plugin code;
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - isCritical
```
public boolean isCritical()
```
    Returns:
    
    the critical
  - getFile
```
public File getFile()
```
    Returns:
    
    the file
  - isMac
```
public boolean isMac()
```
    Returns:
    
    the mac
  - isWindows
```
public boolean isWindows()
```
    Returns:
    
    the windows
  - isLinux
```
public boolean isLinux()
```
    Returns:
    
    the linux
  - isSystemSpecific
```
public boolean isSystemSpecific()
```
    Returns:
    
    the systemSpecific
  - isConfigFile
```
public boolean isConfigFile()
```
    Returns:
    
    the configFile
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getLocation
```
public ScriptLocation getLocation()
```
    Returns:
    
    the location

Class ScriptDependency

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScriptDependency

ScriptDependency

Method Detail

forCurrentElement

withFile

withPlugin

withName

withConfigFile

makeCritical

withMac

withWindows

withLinux

makeSystemSpecific

makeCurrentSystemSpecific

getPluginCode

getName

isCritical

getFile

isMac

isWindows

isLinux

isSystemSpecific

isConfigFile

toString

getLocation