EnvironmentVariable (csbase-common 3.1.3-DBG4 API)

java.lang.Object
- java.lang.Enum<EnvironmentVariable>
- - csbase.logic.algorithms.EnvironmentVariable

All Implemented Interfaces:

Serializable, Comparable<EnvironmentVariable>
```
public enum EnvironmentVariable
extends Enum<EnvironmentVariable>
```
Author:

Tecgraf

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BINARY_DIR` Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho do diretório de binários do algoritmo.
`CLIENT_HOST` Variável de ambiente definida na linha de comando do algoritmo que armazena o nome da máquina que disparou o comando.
`EXECUTION_DIR` Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho do diretório de execução do algoritmo.
`FLOW_GUILTY_NODE_ID_LOG` Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho para o arquivo de log que armazena o nó do fluxo responsável pelo erro de execução (se houver).
`FLOW_NODE_ID` Variável de ambiente definida na linha de comando do algoritmo que armazena o identificador do nó do fluxo.
`FLOW_SANDBOX_DIR` Variável de ambiente definida pelo SGA que armazena o caminho do diretório da sandbox de execução do fluxo.
`INPUT_FILES` Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho para os arquivos de entrada do comando.
`LOG_FILE` Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho para o arquivo de log do algoritmo.
`OUTPUT_FILES` Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho para os arquivos de saída do comando.
`PROJECT_DIR` Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho do diretório de projeto do comando.
`SANDBOX_DIR` Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho do diretório da sandbox de execução do algoritmo.
`WARNINGS_FILE` Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho para o arquivo de log que o algoritmo deve usar para fazer alertas durante sua execução (se necessário).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getName()` Retorna o nome da variável de ambiente.
`String`	`toString()`
`static EnvironmentVariable`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EnvironmentVariable[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

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

- Enum Constant Detail
  - EXECUTION_DIR
```
public static final EnvironmentVariable EXECUTION_DIR
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho do diretório de execução do algoritmo.
  - BINARY_DIR
```
public static final EnvironmentVariable BINARY_DIR
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho do diretório de binários do algoritmo.
  - SANDBOX_DIR
```
public static final EnvironmentVariable SANDBOX_DIR
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho do diretório da sandbox de execução do algoritmo.
  - PROJECT_DIR
```
public static final EnvironmentVariable PROJECT_DIR
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho do diretório de projeto do comando.
  - INPUT_FILES
```
public static final EnvironmentVariable INPUT_FILES
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho para os arquivos de entrada do comando.
  - OUTPUT_FILES
```
public static final EnvironmentVariable OUTPUT_FILES
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho para os arquivos de saída do comando.
  - FLOW_GUILTY_NODE_ID_LOG
```
public static final EnvironmentVariable FLOW_GUILTY_NODE_ID_LOG
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho para o arquivo de log que armazena o nó do fluxo responsável pelo erro de execução (se houver).
  - FLOW_NODE_ID
```
public static final EnvironmentVariable FLOW_NODE_ID
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o identificador do nó do fluxo.
  - FLOW_SANDBOX_DIR
```
public static final EnvironmentVariable FLOW_SANDBOX_DIR
```
    Variável de ambiente definida pelo SGA que armazena o caminho do diretório da sandbox de execução do fluxo.
  - LOG_FILE
```
public static final EnvironmentVariable LOG_FILE
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho para o arquivo de log do algoritmo.
  - CLIENT_HOST
```
public static final EnvironmentVariable CLIENT_HOST
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o nome da máquina que disparou o comando.
  - WARNINGS_FILE
```
public static final EnvironmentVariable WARNINGS_FILE
```
    Variável de ambiente definida na linha de comando do algoritmo que armazena o caminho para o arquivo de log que o algoritmo deve usar para fazer alertas durante sua execução (se necessário).
- Method Detail
  - values
```
public static EnvironmentVariable[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (EnvironmentVariable c : EnvironmentVariable.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EnvironmentVariable valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getName
```
public String getName()
```
    Retorna o nome da variável de ambiente.
    
    Returns:
    
    O nome da variável.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<EnvironmentVariable>

Enum EnvironmentVariable

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

EXECUTION_DIR

BINARY_DIR

SANDBOX_DIR

PROJECT_DIR

INPUT_FILES

OUTPUT_FILES

FLOW_GUILTY_NODE_ID_LOG

FLOW_NODE_ID

FLOW_SANDBOX_DIR

LOG_FILE

CLIENT_HOST

WARNINGS_FILE

Method Detail

values

valueOf

getName

toString