tecgraf.ftc_1_4.common

Class FileDataChannel

java.lang.Object

tecgraf.ftc_1_4.common.FileDataChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, IDataChannel

public class FileDataChannel
extends Object
implements IDataChannel

Classe que adapta um FileChannel para ser utilizado como um IDataChannel

Author:

Tecgraf

Field Summary

Fields inherited from interface tecgraf.ftc_1_4.common.IDataChannel

OP_GET_POSITION, OP_GET_SIZE, OP_READ, OP_SET_POSITION, OP_SET_SIZE, OP_TRANSFER_FROM, OP_TRANSFER_TO, OP_WRITE

Constructor Summary

Constructors

Constructor and Description
FileDataChannel(FileChannel channel)

Method Summary

Modifier and Type	Method and Description
void	close() Solicita o fechamento do canal.
FileChannel	getChannel() Retorna o FileChannel encapsulado
long	getPosition() Obtém a posição atual do canal.
long	getSize() Obtém a quantidade de bytes no canal a partir da posição inicial.
boolean	isOpen() Verifica se o canal está aberto.
int	read(ByteBuffer target) Lê uma sequência de bytes do arquivo.
int	read(ByteBuffer target, long position) Lê uma sequência de bytes do arquivo.
long	remaining() Retorna a quantidade de bytes no canal a partir da posição atual.
void	setPosition(long position) Define a nova posição do arquivo.
void	setSize(long size) Define a quantidade de bytes para o canal.
long	skip(long bytes) Metodo que pula/ignora uma quantidade de bytes a partir da posicao atual.
short	supportedOperations() Retornas os metodos/operações suportados pela implementação do canal de dados.
long	transferFrom(ReadableByteChannel source, long position, long count) Transfere os dados de um fluxo de entrada para o arquivo.
long	transferTo(long position, long count, WritableByteChannel output) Transfere os dados do arquivo para um fluxo de saída.
int	write(ByteBuffer source) Escreve uma sequência de bytes no arquivo.
int	write(ByteBuffer source, long position) Escreve uma sequência de bytes no arquivo.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDataChannel

public FileDataChannel(FileChannel channel)

Parameters:

channel -

Method Detail

supportedOperations

public short supportedOperations()

Retornas os metodos/operações suportados pela implementação do canal de dados. Todas as implementações devem definir as operações suportadas. Se as operações não forem conhecidas, a constante ALL_OPS deve ser utilizada. Implementação obrigatoria.

Specified by:

supportedOperations in interface IDataChannel

Returns:

operacoes suportadas

isOpen

public boolean isOpen()

Verifica se o canal está aberto. Implementação obrigatoria.

Specified by:

isOpen in interface Channel

Specified by:

isOpen in interface IDataChannel

Returns:

true caso o canal esteja aberto, ou false, caso contrário.

close

public void close()
           throws IOException

Solicita o fechamento do canal. Implementação obrigatoria.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface IDataChannel

Throws:

IOException - Caso ocorra alguma falha no procedimento.

remaining

public long remaining()
               throws IOException,
                      DataChannelException

Description copied from interface: IDataChannel

Retorna a quantidade de bytes no canal a partir da posição atual. O valor -1 significa end-of-stream. O valor 0 significa que atualmente não há dados, mas pode vir a ter. Utilizado em live-streams Implementação obrigatoria.

Specified by:

remaining in interface IDataChannel

Returns:

quantidades de bytes existentes no canal.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

DataChannelException - Caso ocorra alguma situação excepcional no canal.

skip

public long skip(long bytes)
          throws IOException,
                 DataChannelException

Description copied from interface: IDataChannel

Metodo que pula/ignora uma quantidade de bytes a partir da posicao atual. Implementação obrigatoria.

Specified by:

skip in interface IDataChannel

Parameters:

bytes - quantidade de bytes a serem pulados. Quantidade de bytes a serem pulados deve ser maior ou igual a zero.

Returns:

Quantidade de bytes pulados

Throws:

IOException - Caso ocorra alguma falha no procedimento.

DataChannelException - Caso ocorra alguma situação excepcional no canal.

getSize

public long getSize()
             throws IOException

Obtém a quantidade de bytes no canal a partir da posição inicial. Implementação opcional. No caso da operação de não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

getSize in interface IDataChannel

Returns:

O tamanho do arquivo ou -1, caso ocorra algum erro.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

setSize

public void setSize(long size)
             throws IOException

Define a quantidade de bytes para o canal. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

setSize in interface IDataChannel

Parameters:

size - O novo tamanho.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

getPosition

public long getPosition()
                 throws IOException

Obtém a posição atual do canal. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

getPosition in interface IDataChannel

Returns:

A posição atual do arquivo ou -1, caso ocorra algum erro.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

setPosition

public void setPosition(long position)
                 throws IOException

Define a nova posição do arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

setPosition in interface IDataChannel

Parameters:

position - A nova posição.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

read

public int read(ByteBuffer target)
         throws IOException

Lê uma sequência de bytes do arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

read in interface IDataChannel

Parameters:

target - O buffer.

Returns:

A quantidade de bytes lidos.

Throws:

IOException - Caso ocorra alguma falha I/O no procedimento.

read

public int read(ByteBuffer target,
                long position)
         throws IOException

Lê uma sequência de bytes do arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

read in interface IDataChannel

Parameters:

target - O buffer.

position - A posição do arquivo a partir da qual a leitura vai ser iniciada.

Returns:

A quantidade de bytes lidos.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

write

public int write(ByteBuffer source)
          throws IOException

Escreve uma sequência de bytes no arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

write in interface IDataChannel

Parameters:

source - O buffer.

Returns:

A quantidade de bytes escritos.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

write

public int write(ByteBuffer source,
                 long position)
          throws IOException

Escreve uma sequência de bytes no arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

write in interface IDataChannel

Parameters:

source - O buffer.

position - A posição do arquivo a partir da qual a escrita vai ser iniciada.

Returns:

A quantidade de bytes escritos.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

transferTo

public long transferTo(long position,
                       long count,
                       WritableByteChannel output)
                throws IOException

Transfere os dados do arquivo para um fluxo de saída. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

transferTo in interface IDataChannel

Parameters:

position - A posição inicial a partir daqual o arquivo será lido.

count - A quantidade de bytes que serão transferidos.

output - O fluxo de saída que receberá os dados do arquivo.

Returns:

A quantidade de bytes efetivamente transferidos.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

transferFrom

public long transferFrom(ReadableByteChannel source,
                         long position,
                         long count)
                  throws IOException

Transfere os dados de um fluxo de entrada para o arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

transferFrom in interface IDataChannel

Parameters:

source - O fluxo de entrada.

position - A posição inicial a partir daqual o arquivo será escrito.

count - A quantidade de bytes que serão transferidos.

Returns:

A quantidade de bytes efetivamente transferidos.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

getChannel

public FileChannel getChannel()

Retorna o FileChannel encapsulado

Returns:

FileChannel