ClientFile (csbase-common ERAS-1.0.2 API)

All Known Implementing Classes:

ClientProjectFile, ClientSGAFile
```
public interface ClientFile
```
Interface para representação de arquivos no lado cliente.

Author:

Tecgraf/PUC-Rio

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`OPTIMIZATION_MODE_GLOBAL` Modo de otimização: Global ou simplificado - mesmo mounting point para todos os projetos e usuários
`static int`	`OPTIMIZATION_MODE_NONE` Modo de otimização: sem otimização

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canExecute()` Retorna true se o arquivo pode ser executado, false caso contrário.
`boolean`	`canRead()` Retorna true se o arquivo pode ser lido, false caso contrário.
`boolean`	`canWrite()` Retorna true se o arquivo pode ser escrito, false caso contrário.
`void`	`close(boolean force)` Fecha este arquivo.
`boolean`	`exists()` Retorna se existe o arquivo físico.
`ClientFile[]`	`getChildren()` Retorna a lista de arquivos deste diretório.
`ClientFileType`	`getClientFileType()` Retorna item de enumeração que identifica o tipo do arquivo quanto ao local onde o arquivo está armazenado.
`InputStream`	`getInputStream()` Obtém um fluxo de entrada para leitura do arquivo.
`long`	`getModificationDate()` Consulta a data/hora da última modificação do arquivo.
`String`	`getName()` Retorna o nome do arquivo.
`OutputStream`	`getOutputStream()` Obtém um fluxo de saída para escrita no arquivo.
`ClientFile`	`getParent()` Retorna o diretório-pai
`String[]`	`getPath()` Retorna o caminho para o arquivo na forma de um array (não inclui o nome do projeto).
`String`	`getStringPath()` Retorna o path pro arquivo na forma de string.
`String`	`getType()` Informa o tipo do arquivo.
`boolean`	`isDirectory()` Consulta se um arquivo é diretório.
`void`	`open(boolean readOnly)` Abre o arquivo para leitura ou para leitura e escrita.
`long`	`position()` Informa a posição corrente deste arquivo.
`void`	`position(long newPosition)` Altera a posição corrente deste arquivo.
`int`	`read(byte[] dst, int off, int len, long position)` Lê uma seqüência de bytes deste arquivo a partir da posição fornecida.
`int`	`read(byte[] dst, long position)` Lê uma seqüência de bytes deste arquivo a partir da posição fornecida.
`long`	`size()` Informa o tamanho corrente deste arquivo.
`void`	`write(byte[] src, int off, int len, long position)` Escreve uma sequência de bytes do arquivo.
`void`	`write(byte[] src, long position)` Escreve uma sequência de bytes do arquivo.

- Field Detail
  - OPTIMIZATION_MODE_NONE
```
static final int OPTIMIZATION_MODE_NONE
```
    Modo de otimização: sem otimização
    
    See Also:
    
    Constant Field Values
  - OPTIMIZATION_MODE_GLOBAL
```
static final int OPTIMIZATION_MODE_GLOBAL
```
    Modo de otimização: Global ou simplificado - mesmo mounting point para todos os projetos e usuários
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getChildren
```
ClientFile[] getChildren()
                  throws Exception
```
    Retorna a lista de arquivos deste diretório.
    
    Returns:
    
    A lista de arquivos deste diretório.
    
    Throws:
    
    Exception - Erro na busca de arquivos do diretório.
  - getInputStream
```
InputStream getInputStream()
                    throws IOException
```
    Obtém um fluxo de entrada para leitura do arquivo.
    
    Returns:
    
    Fluxo de entrada para leitura do arquivo.
    
    Throws:
    
    IOException - Caso ocorra algum erro de IO durante o procedimento.
  - exists
```
boolean exists()
        throws IOException
```
    Retorna se existe o arquivo físico.
    
    Returns:
    
    indicativo
    
    Throws:
    
    IOException - em caso de falha e I/O no procedimento.
  - getModificationDate
```
long getModificationDate()
```
    Consulta a data/hora da última modificação do arquivo.
    
    Returns:
    
    a data
  - getName
```
String getName()
```
    Retorna o nome do arquivo.
    
    Returns:
    
    Nome do arquivo.
  - getOutputStream
```
OutputStream getOutputStream()
                      throws IOException
```
    Obtém um fluxo de saída para escrita no arquivo.
    
    Returns:
    
    Fluxo de saída para escrita no arquivo.
    
    Throws:
    
    IOException - Caso ocorra algum erro de IO durante o procedimento.
  - getParent
```
ClientFile getParent()
```
    Retorna o diretório-pai
    
    Returns:
    
    o diretório que contem este arquivo.
  - getPath
```
String[] getPath()
```
    Retorna o caminho para o arquivo na forma de um array (não inclui o nome do projeto).
    
    Returns:
    
    Caminho para o arquivo na forma de um array (não inclui o nome do projeto).
  - getStringPath
```
String getStringPath()
```
    Retorna o path pro arquivo na forma de string.
    
    Returns:
    
    O path pro arquivo na forma de string.
  - getType
```
String getType()
```
    Informa o tipo do arquivo.
    
    Returns:
    
    O tipo do arquivo.
  - isDirectory
```
boolean isDirectory()
```
    Consulta se um arquivo é diretório.
    
    Returns:
    
    indicativo
  - canRead
```
boolean canRead()
```
    Retorna true se o arquivo pode ser lido, false caso contrário.
    
    Returns:
    
    true se o arquivo pode ser lido, false caso contrário.
  - canWrite
```
boolean canWrite()
```
    Retorna true se o arquivo pode ser escrito, false caso contrário.
    
    Returns:
    
    - true se o arquivo pode ser escrito, false caso contrário.
  - canExecute
```
boolean canExecute()
```
    Retorna true se o arquivo pode ser executado, false caso contrário.
    
    Returns:
    
    true se o arquivo pode ser executado, false caso contrário.
  - open
```
void open(boolean readOnly)
   throws Exception
```
    Abre o arquivo para leitura ou para leitura e escrita.
    
    Parameters:
    
    readOnly - Boolean indicando se o arquivo deve ser aberto para leitura ou para leitura e escrita.
    
    Throws:
    
    Exception - Erro na abertura do arquivo.
  - read
```
int read(byte[] dst,
         long position)
  throws Exception
```
    Lê uma seqüência de bytes deste arquivo a partir da posição fornecida.
    
    Parameters:
    
    dst - O array no qual os bytes serão escritos.
    
    position - A posição do arquivo a partir do qual os bytes serão lidos.
    
    Returns:
    
    O número de bytes lidos.
    
    Throws:
    
    Exception - Em caso de erro.
  - read
```
int read(byte[] dst,
         int off,
         int len,
         long position)
  throws Exception
```
    Lê uma seqüência de bytes deste arquivo a partir da posição fornecida.
    
    Parameters:
    
    dst - O array no qual os bytes serão escritos.
    
    off - O índice do array a partir do qual os bytes serão escritos.
    
    len - O número de bytes a ler do arquivo e escrever no array.
    
    position - A posição do arquivo a partir do qual os bytes serão lidos.
    
    Returns:
    
    O número de bytes lidos.
    
    Throws:
    
    Exception - Em caso de erro.
  - close
```
void close(boolean force)
    throws IOException
```
    Fecha este arquivo. Após chamado este método, o objeto que representa o arquivo não poderá mais ser utilizado para leitura e/ou escrita.
    
    Parameters:
    
    force - Indica que o arquivo deve ser considerado fechado mesmo em caso de erro.
    
    Throws:
    
    IOException - se houver falha no acesso ao arquivo.
  - size
```
long size()
```
    Informa o tamanho corrente deste arquivo. Reflete o número corrente de bytes do arquivo.
    
    Returns:
    
    Tamanho corrente do arquivo.
  - getClientFileType
```
ClientFileType getClientFileType()
```
    Retorna item de enumeração que identifica o tipo do arquivo quanto ao local onde o arquivo está armazenado.
    
    Returns:
    
    Item de enumeração que identifica o tipo do arquivo quanto ao local onde o arquivo está armazenado.
  - write
```
void write(byte[] src,
           int off,
           int len,
           long position)
    throws IOException,
           FileLockedException
```
    Escreve uma sequência de bytes do arquivo. Esse método tenta fazer escritas consecutivas até conseguir enviar a quantidade de bytes solicitada. Caso não consiga, o método lança uma exceção.
    
    Parameters:
    
    src - O array contendo os bytes a serem escritos no arquivo.
    
    off - O deslocamento no array a partir do qual os bytes serão lidos.
    
    len - A quantidade de bytes a serem escritos do arquivo.
    
    position - A posição do arquivo a partir da qual a escrita deve ser iniciada.
    
    Throws:
    
    IOException - Em caso de erro.
    
    FileLockedException - caso o arquivo esteja bloqueado para escrita por outra sessão de usuário
  - write
```
void write(byte[] src,
           long position)
    throws IOException,
           FileLockedException
```
    Escreve uma sequência de bytes do arquivo. Esse método tenta fazer escritas consecutivas até conseguir enviar a quantidade de bytes solicitada. Caso não consiga, o método lança uma exceção.
    
    Parameters:
    
    src - O array contendo os bytes a serem escritos no arquivo.
    
    position - A posição do arquivo a partir da qual a escrita deve ser iniciada.
    
    Throws:
    
    IOException - Em caso de erro.
    
    FileLockedException - caso o arquivo esteja bloqueado para escrita por outra sessão de usuário
  - position
```
long position()
       throws IOException
```
    Informa a posição corrente deste arquivo. Reflete o número de bytes a partir do início do arquivo até a posição corrente.
    
    Returns:
    
    Posição corrente do arquivo.
    
    Throws:
    
    IOException - Em caso de erro.
  - position
```
void position(long newPosition)
       throws IOException
```
    Altera a posição corrente deste arquivo. Reflete o número de bytes a partir do início do arquivo até a posição corrente.
    
    Parameters:
    
    newPosition - Nova posição corrente do arquivo.
    
    Throws:
    
    IOException - Em caso de erro.

Interface ClientFile

Field Summary

Method Summary

Field Detail

OPTIMIZATION_MODE_NONE

OPTIMIZATION_MODE_GLOBAL

Method Detail

getChildren

getInputStream

exists

getModificationDate

getName

getOutputStream

getParent

getPath

getStringPath

getType

isDirectory

canRead

canWrite

canExecute

open

read

read

close

size

getClientFileType

write

write

position

position