SFIToolkit (Stata-Java API)

java.lang.Object
- com.stata.sfi.SFIToolkit

```
public final class SFIToolkit
extends Object
```
This class provides a set of core tools for interacting with Stata.

Field Summary

Fields
Modifier and Type Field and Description

static int RC_BREAK

static int RC_GENERAL_ERROR

static int RC_GENERAL_EXCEPTION

static int RC_SYNTAX_ERROR

Fields
Modifier and Type	Field and Description
`static int`	`RC_BREAK`
`static int`	`RC_GENERAL_ERROR`
`static int`	`RC_GENERAL_EXCEPTION`
`static int`	`RC_SYNTAX_ERROR`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`callGC()` Call the Java garbage collector. Calling this method should generally be avoided.
`static void`	`display(String s)` Output a string to the Stata Results window.
`static void`	`display(String s, boolean asis)` Output a string to the Stata Results window.
`static void`	`displayln(String s)` Output a string to the Stata Results window and automatically add a line terminator at the end.
`static int`	`error(int rc)` Deprecated. Use `SFIToolkit.errorMsg(int)` instead. This function will cease to exist in Stata 17.
`static void`	`error(String s)` Output a string to the Stata Results window as an error.
`static void`	`error(String s, boolean asis)` Output a string to the Stata Results window as an error.
`static boolean`	`errorDebug(String s)` Output a string to the Stata Results window as an error if set debug on is enabled.
`static boolean`	`errorDebug(String s, boolean asis)` Output a string to the Stata Results window as an error if set debug on is enabled.
`static void`	`errorln(String s)` Output a string to the Stata Results window and automatically add a line terminator at the end.
`static int`	`errorMsg(int rc)` Output the standard Stata error message associated with return code rc to the Stata Results window.
`static int`	`executeCommand(String command, boolean echo)` Execute a Stata command.
`static String`	`formatValue(double val, String format)` Format a value using a Stata format.
`static double`	`getCallerVersion()` Get the version number of the calling program.
`static String`	`getTempFile()` Get a valid Stata temporary filename.
`static String`	`getTempName()` Get a valid Stata temporary name.
`static String`	`getWorkingDir()` Get the current Stata working directory.
`static boolean`	`isValidName(String s)` Check if a `String` is a valid Stata name.
`static boolean`	`isValidVariableName(String s)` Check if a `String` is a valid Stata variable name.
`static void`	`loadStataProxySettings()` Apply Stata's proxy settings to Java.
`static int`	`pollnow()` Request that Stata poll its GUI immediately.
`static int`	`pollstd()` Request that Stata poll its GUI at the standard interval.
`static String`	`processTildePath(String path)` Stata utility to convert a path beginning with a tilde to a user's home directory.
`static File`	`resolvePath(String path)` Resolve a path to a `File`; the path may be relative to Stata's current working directory, a path beginning with a tilde, or an absolute path.
`static String`	`stackTraceToString(Exception e)` Convert the stack trace from an `Exception` to a `String`.

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

- Field Detail
  - RC_BREAK
```
public static final int RC_BREAK
```
    See Also:
    
    Constant Field Values
  - RC_GENERAL_ERROR
```
public static final int RC_GENERAL_ERROR
```
    See Also:
    
    Constant Field Values
  - RC_GENERAL_EXCEPTION
```
public static final int RC_GENERAL_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - RC_SYNTAX_ERROR
```
public static final int RC_SYNTAX_ERROR
```
    See Also:
    
    Constant Field Values
- Method Detail
  - callGC
```
@Synchronized
public static void callGC()
```
    Call the Java garbage collector. Calling this method should generally be avoided.
  - display
```
@SynchronizedOnMain
public static void display(String s)
```
    Output a string to the Stata Results window. Before the string is printed, it is run through the Stata SMCL interpreter.
    
    Parameters:
    
    s - The string to output.
  - display
```
@SynchronizedOnMain
public static void display(String s,
                                               boolean asis)
```
    Output a string to the Stata Results window.
    
    Parameters:
    
    s - The string to output.
    
    asis - When true, the string is printed without using the Stata SMCL interpreter.
  - displayln
```
@SynchronizedOnMain
public static void displayln(String s)
```
    Output a string to the Stata Results window and automatically add a line terminator at the end. Before the string is printed, it is run through the Stata SMCL interpreter.
    
    Parameters:
    
    s - The string to output.
  - error
```
@SynchronizedOnMain
public static int error(int rc)
```
    Deprecated. Use SFIToolkit.errorMsg(int) instead. This function will cease to exist in Stata 17.
    
    Output the standard Stata error message associated with return code rc to the Stata Results window.
    
    Parameters:
    
    rc - The return code for the error.
    
    Returns:
    
    The return code for the error.
  - error
```
@SynchronizedOnMain
public static void error(String s)
```
    Output a string to the Stata Results window as an error. Before the string is printed, it is run through the Stata SMCL interpreter.
    
    Parameters:
    
    s - The string to output.
  - error
```
@SynchronizedOnMain
public static void error(String s,
                                             boolean asis)
```
    Output a string to the Stata Results window as an error.
    
    Parameters:
    
    s - The string to output.
    
    asis - When true, the string is printed without using the Stata SMCL interpreter.
  - errorDebug
```
@SynchronizedOnMain
public static boolean errorDebug(String s)
```
    Output a string to the Stata Results window as an error if set debug on is enabled. Before the string is printed, it is run through the Stata SMCL interpreter.
    
    Parameters:
    
    s - The string to output.
    
    Returns:
    
    True if set debug on is enabled.
  - errorDebug
```
@SynchronizedOnMain
public static boolean errorDebug(String s,
                                                     boolean asis)
```
    Output a string to the Stata Results window as an error if set debug on is enabled.
    
    Parameters:
    
    s - The string to output.
    
    asis - When true, the string is printed without using the Stata SMCL interpreter.
    
    Returns:
    
    True if set debug on is enabled.
  - errorln
```
@SynchronizedOnMain
public static void errorln(String s)
```
    Output a string to the Stata Results window and automatically add a line terminator at the end. Before the string is printed, it is run through the Stata SMCL interpreter.
    
    Parameters:
    
    s - The string to output.
  - errorMsg
```
@SynchronizedOnMain
public static int errorMsg(int rc)
```
    Output the standard Stata error message associated with return code rc to the Stata Results window.
    
    Parameters:
    
    rc - The return code for the error.
    
    Returns:
    
    The return code for the error.
  - executeCommand
```
@SynchronizedOnMain
public static int executeCommand(String command,
                                                     boolean echo)
```
    Execute a Stata command.
    
    Parameters:
    
    command - The command to execute.
    
    echo - Echo the command.
    
    Returns:
    
    Return code from Stata; 0 if successful.
  - formatValue
```
@ThreadSafe
public static String formatValue(double val,
                                             String format)
```
    Format a value using a Stata format.
    
    Parameters:
    
    val - The value to format.
    
    format - A valid Stata format.
    
    Returns:
    
    The formatted value in String form. Returns a null String if an error occurs.
  - getCallerVersion
```
@Synchronized
public static double getCallerVersion()
```
    Get the version number of the calling program. This function can be used to implement Stata version control.
    
    Returns:
    
    The caller's version number.
  - getTempFile
```
@Synchronized
public static String getTempFile()
```
    Get a valid Stata temporary filename.
    
    Returns:
    
    The filename, including its path.
  - getTempName
```
@Synchronized
public static String getTempName()
```
    Get a valid Stata temporary name.
    
    Returns:
    
    The temparory name.
  - getWorkingDir
```
@Synchronized
public static String getWorkingDir()
```
    Get the current Stata working directory.
    
    Returns:
    
    The path of the current working directory.
  - isValidName
```
@ThreadSafe
public static boolean isValidName(String s)
```
    Check if a String is a valid Stata name.
    
    Parameters:
    
    s - Name to test.
    
    Returns:
    
    True if the String represents a valid Stata name.
  - isValidVariableName
```
@ThreadSafe
public static boolean isValidVariableName(String s)
```
    Check if a String is a valid Stata variable name.
    
    Parameters:
    
    s - Name to test.
    
    Returns:
    
    True if the String represents a valid Stata variable name.
  - loadStataProxySettings
```
public static void loadStataProxySettings()
```
    Apply Stata's proxy settings to Java. Call this prior to making a web request where you want proxy settings to be applied. This method only needs to be called once.
  - pollnow
```
@ThreadSafe
public static int pollnow()
```
    Request that Stata poll its GUI immediately. Use this method inside a time-consuming task so that the Stata interface is responsive to user inputs. Generally, pollstd should be used instead.
    
    Returns:
    
    A 0 unless the Break key has been pressed.
  - pollstd
```
@ThreadSafe
public static int pollstd()
```
    Request that Stata poll its GUI at the standard interval. Use this method inside a time-consuming task so that the Stata interface is responsive to user inputs.
    
    Returns:
    
    A 0 unless the Break key has been pressed.
  - processTildePath
```
@Synchronized
public static String processTildePath(String path)
```
    Stata utility to convert a path beginning with a tilde to a user's home directory. If the path does not begin with a tilde, then the path will not be modified.
    
    Parameters:
    
    path - Path to process.
    
    Returns:
    
    The processed path.
  - resolvePath
```
@Synchronized
public static File resolvePath(String path)
                                      throws InvalidPathException
```
    Resolve a path to a File; the path may be relative to Stata's current working directory, a path beginning with a tilde, or an absolute path.
    
    Parameters:
    
    path - Path to process.
    
    Returns:
    
    A File.
    
    Throws:
    
    InvalidPathException
  - stackTraceToString
```
@ThreadSafe
public static String stackTraceToString(Exception e)
```
    Convert the stack trace from an Exception to a String.
    
    Parameters:
    
    e - Exception
    
    Returns:
    
    The String representation of the stack trace.

Class SFIToolkit

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RC_BREAK

RC_GENERAL_ERROR

RC_GENERAL_EXCEPTION

RC_SYNTAX_ERROR

Method Detail

callGC

display

display

displayln

error

error

error

errorDebug

errorDebug

errorln

errorMsg

executeCommand

formatValue

getCallerVersion

getTempFile

getTempName

getWorkingDir

isValidName

isValidVariableName

loadStataProxySettings

pollnow

pollstd

processTildePath

resolvePath

stackTraceToString