csbase.logic.algorithms

Class CommandLineBuilder

java.lang.Object

csbase.logic.algorithms.CommandLineBuilder

public class CommandLineBuilder
extends Object

Construtor de linhas de comando simples ou de scripts. Contém métodos utilitários para facilitar e padronizar as linhas de comando geradas pelo sistema.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_SEPARATOR Caractere separador de comandos.
static String	COMMENT Caractere indicador de comentários.
static String	REFERENCE_VAR_CHAR Caractere utilizado em referências a variáveis de ambiente.
static String	SCRIPT_LINE_SEPARATOR O separador de linha do script.
static String	SHELL Shell utilizado para executar a linha de comando

Constructor Summary

Constructors

Constructor and Description
CommandLineBuilder(boolean isScript) Construror.

Method Summary

Modifier and Type	Method and Description
CommandLineBuilder	append(String string) Adiciona uma string ao final da linha de comando.
CommandLineBuilder	appendCommand(String command) Adiciona uma string ao final da linha de comando seguida do separador de comando.
CommandLineBuilder	appendComment(String comment) Adiciona uma string de comentário ao final da linha de comando.
CommandLineBuilder	appendCommentSeparator() Adiciona uma linha de separação de comentário ao final da linha de comando.
CommandLineBuilder	appendEmptyLine() Adiciona uma linha vazia ao final da linha de comando.
CommandLineBuilder	appendEnvironmentVariableDeclaration(EnvironmentVariable var, String varValue) Adiciona a declaração de uma variável de ambiente ao final da linha de comando.
CommandLineBuilder	appendEnvironmentVariableDeclaration(String varName, String varValue) Adiciona a declaração de uma variável de ambiente ao final da linha de comando.
CommandLineBuilder	appendExitCodeCaptureCommand(String exitCodeFilePath, CommandLineContext context) Adiciona a captura do código de saída de execução do último comando ao final da linha de comando.
CommandLineBuilder	appendScriptHeader(CommandLineContext context) Adiciona um cabeçalho com o shell utilizado pelo script ao final da linha de comando.
CommandLineBuilder	discardOutput() Adiciona o código necessário para fazer o descarte da saída padrão do comando ao final da linha de comando.
CommandLineBuilder	discardStdErrAndStdOutput() Adiciona o código necessário para fazer o descarte da saída padrão e de erro do último comando ao final da linha de comando.
static String	escapeReferenceChar(String cmd) Retorna o comando com escape para o caractere de referência a variáveis de ambiente.
static String	makeEnvironmentVariableReference(EnvironmentVariable var) Retorna a string que representa uma referência à variável de ambiente na linha de comando.
static String	makeFromPipeName(Integer nodeId, String paramName) Monta o nome de um named pipe de um nó de origem de uma ligação em um fluxo.
static String	makeLinkDirName(Integer nodeId, String paramName) Monta o nome de um diretório de ligação de um nó de um fluxo.
static String	makePathWithEnvironmentVariable(EnvironmentVariable var, String path, char fileSeparator) Monta um caminho começando com a variável de ambiente especificada.
static String	makeToPipeName(Integer nodeId, String paramName) Monta o nome de um named pipe de um nó de destino de uma ligação em um fluxo.
static String	makeVariableReference(String var) Retorna a string que representa uma referência à variável de ambiente na linha de comando.
CommandLineBuilder	redirectStdErrAndStdOutputToFile(String standardOutputFile) Adiciona o código necessário para fazer o redirecionamento da saída padrão e de erro do último comando para um arquivo ao final da linha de comando.
CommandLineBuilder	redirectStdErrToStdOutput() Adiciona o código necessário para fazer o redirecionamento da saída de erro para a saída padrão do último comando ao final da linha de comando.
CommandLineBuilder	redirectStdOutputToFile(String standardOutputFile) Adiciona o código necessário para fazer o redirecionamento da saída padrão do último comando para um arquivo ao final da linha de comando.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REFERENCE_VAR_CHAR

public static final String REFERENCE_VAR_CHAR

Caractere utilizado em referências a variáveis de ambiente.

See Also:

Constant Field Values

COMMAND_SEPARATOR

public static final String COMMAND_SEPARATOR

Caractere separador de comandos.

See Also:

Constant Field Values

SCRIPT_LINE_SEPARATOR

public static final String SCRIPT_LINE_SEPARATOR

O separador de linha do script. *Precisa* que seja o "\n". Não pode ser o do sistema, para o script conseguir ser rodado pelos sgas de todas as plataformas (até no caso do windows, por causa do cygwin).

See Also:

Constant Field Values

SHELL

public static final String SHELL

Shell utilizado para executar a linha de comando

See Also:

Constant Field Values

COMMENT

public static final String COMMENT

Caractere indicador de comentários.

See Also:

Constant Field Values

Constructor Detail

CommandLineBuilder

public CommandLineBuilder(boolean isScript)

Construror.

Parameters:

isScript - indica se o comando deve ser construido como um script.

Method Detail

escapeReferenceChar

public static String escapeReferenceChar(String cmd)

Retorna o comando com escape para o caractere de referência a variáveis de ambiente. Para uso de comandos diretamente no shell, é necessário "escapar" esse caractere.

Parameters:

cmd - O comando

Returns:

O comando com espaços "escapados"

makeEnvironmentVariableReference

public static String makeEnvironmentVariableReference(EnvironmentVariable var)

Retorna a string que representa uma referência à variável de ambiente na linha de comando.

Parameters:

var - variável de ambiente (EnvironmentVariable)

Returns:

A string com a referência à variável de ambiente.

makePathWithEnvironmentVariable

public static String makePathWithEnvironmentVariable(EnvironmentVariable var,
                                                     String path,
                                                     char fileSeparator)

Monta um caminho começando com a variável de ambiente especificada.

Parameters:

var - a variável de ambiente

path - O caminho

fileSeparator - o separador de arquivos

Returns:

O caminho completo, começando com a variável de ambiente.

makeLinkDirName

public static String makeLinkDirName(Integer nodeId,
                                     String paramName)

Monta o nome de um diretório de ligação de um nó de um fluxo.

Parameters:

nodeId - o identificador do nó origem da ligação.

paramName - o nome do parâmetro de saída do nó envolvido na ligação.

Returns:

o nome do diretório.

makeFromPipeName

public static String makeFromPipeName(Integer nodeId,
                                      String paramName)

Monta o nome de um named pipe de um nó de origem de uma ligação em um fluxo.

Parameters:

nodeId - o identificador do nó origem da ligação.

paramName - o nome do parâmetro de saída do nó envolvido na ligação.

Returns:

o nome do named pipe.

makeToPipeName

public static String makeToPipeName(Integer nodeId,
                                    String paramName)

Monta o nome de um named pipe de um nó de destino de uma ligação em um fluxo.

Parameters:

nodeId - o identificador do nó destino da ligação.

paramName - o nome do parâmetro de entrada do nó envolvido na ligação.

Returns:

o nome do named pipe.

makeVariableReference

public static String makeVariableReference(String var)

Retorna a string que representa uma referência à variável de ambiente na linha de comando.

Parameters:

var - variável de ambiente (EnvironmentVariable)

Returns:

A string com a referência à variável de ambiente.

append

public CommandLineBuilder append(String string)

Adiciona uma string ao final da linha de comando.

Parameters:

string - a string.

Returns:

o próprio construtor do comando, para facilitar o encadeamento de chamadas de métodos como esse.

appendCommand

public CommandLineBuilder appendCommand(String command)

Adiciona uma string ao final da linha de comando seguida do separador de comando. No caso de script, também adiciona o separador de linha.

Parameters:

command - A string.

Returns:

o próprio construtor do comando, para facilitar o encadeamento de chamadas de métodos como esse.

appendComment

public CommandLineBuilder appendComment(String comment)

Adiciona uma string de comentário ao final da linha de comando.

Parameters:

comment - A string.

Returns:

o próprio construtor do comando, para facilitar o encadeamento de chamadas de métodos como esse.

appendCommentSeparator

public CommandLineBuilder appendCommentSeparator()

Adiciona uma linha de separação de comentário ao final da linha de comando.

Returns:

o próprio construtor do comando, para facilitar o encadeamento de chamadas de métodos como esse.

appendEmptyLine

public CommandLineBuilder appendEmptyLine()

Adiciona uma linha vazia ao final da linha de comando.

Returns:

o próprio construtor do comando, para facilitar o encadeamento de chamadas de métodos como esse.

appendEnvironmentVariableDeclaration

public CommandLineBuilder appendEnvironmentVariableDeclaration(EnvironmentVariable var,
                                                               String varValue)

Adiciona a declaração de uma variável de ambiente ao final da linha de comando. Caso o valor da variável seja nulo ou vazio, nada é adicionado.

Parameters:

var - A variável

varValue - O valor da variável

Returns:

o próprio construtor do comando, para facilitar o encadeamento de chamadas de métodos como esse.

appendEnvironmentVariableDeclaration

public CommandLineBuilder appendEnvironmentVariableDeclaration(String varName,
                                                               String varValue)

Adiciona a declaração de uma variável de ambiente ao final da linha de comando. Caso o valor da variável seja nulo ou vazio, nada é adicionado.

Parameters:

varName - O nome da variável

varValue - O valor da variável

Returns:

o próprio construtor do comando, para facilitar o encadeamento de chamadas de métodos como esse.

appendExitCodeCaptureCommand

public CommandLineBuilder appendExitCodeCaptureCommand(String exitCodeFilePath,
                                                       CommandLineContext context)

Adiciona a captura do código de saída de execução do último comando ao final da linha de comando.

Parameters:

exitCodeFilePath - Caminho para o arquivo onde será armazenado o código de saída do comando

context - O contexto de execução do comando

Returns:

o próprio construtor do comando, para facilitar o encadeamento de chamadas de métodos como esse.

discardOutput

public CommandLineBuilder discardOutput()

Adiciona o código necessário para fazer o descarte da saída padrão do comando ao final da linha de comando.

Returns:

a linha de comando.

discardStdErrAndStdOutput

public CommandLineBuilder discardStdErrAndStdOutput()

Adiciona o código necessário para fazer o descarte da saída padrão e de erro do último comando ao final da linha de comando.

Returns:

a linha de comando.

redirectStdErrAndStdOutputToFile

public CommandLineBuilder redirectStdErrAndStdOutputToFile(String standardOutputFile)

Adiciona o código necessário para fazer o redirecionamento da saída padrão e de erro do último comando para um arquivo ao final da linha de comando.

Parameters:

standardOutputFile - O arquivo para onde será redirecionada as saídas.

Returns:

a linha de comando.

redirectStdErrToStdOutput

public CommandLineBuilder redirectStdErrToStdOutput()

Adiciona o código necessário para fazer o redirecionamento da saída de erro para a saída padrão do último comando ao final da linha de comando.

Returns:

a linha de comando.

redirectStdOutputToFile

public CommandLineBuilder redirectStdOutputToFile(String standardOutputFile)

Adiciona o código necessário para fazer o redirecionamento da saída padrão do último comando para um arquivo ao final da linha de comando.

Parameters:

standardOutputFile - O arquivo para onde será redirecionada a saída.

Returns:

a linha de comando.

toString

public String toString()

Overrides:

toString in class Object

appendScriptHeader

public CommandLineBuilder appendScriptHeader(CommandLineContext context)

Adiciona um cabeçalho com o shell utilizado pelo script ao final da linha de comando.

Parameters:

context - o contexto de execução do comando.

Returns:

o próprio construtor do comando, para facilitar o encadeamento de chamadas de métodos como esse.