tecgraf.ftc_1_4.common

Interface IDataChannel

All Superinterfaces:

AutoCloseable, Channel, Closeable

All Known Subinterfaces:

IRemoteDataChannel

All Known Implementing Classes:

FileDataChannel, RemoteDataChannel

public interface IDataChannel
extends Channel

Representa um canal de acesso a dados.

Author:

Tecgraf

Field Summary

Fields

Modifier and Type	Field and Description
static short	OP_GET_POSITION Constante que representa que o metodo getPosition é suportado
static short	OP_GET_SIZE Constante que representa que o metodo getSize é suportado
static short	OP_READ Constante que representa que os metodos de read são suportados
static short	OP_SET_POSITION Constante que representa que o metodo setPosition é suportado
static short	OP_SET_SIZE Constante que representa que o metodo setSize é suportado
static short	OP_TRANSFER_FROM Constante que representa que o metodo transferFrom é suportado
static short	OP_TRANSFER_TO Constante que representa que o metodo transferTo é suportado
static short	OP_WRITE Constante que representa que os metodos de write são suportados

Method Summary

Modifier and Type	Method and Description
void	close() Solicita o fechamento do canal.
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.

Field Detail

OP_GET_SIZE

static final short OP_GET_SIZE

Constante que representa que o metodo getSize é suportado

See Also:

Constant Field Values

OP_SET_SIZE

static final short OP_SET_SIZE

Constante que representa que o metodo setSize é suportado

See Also:

Constant Field Values

OP_GET_POSITION

static final short OP_GET_POSITION

Constante que representa que o metodo getPosition é suportado

See Also:

Constant Field Values

OP_SET_POSITION

static final short OP_SET_POSITION

Constante que representa que o metodo setPosition é suportado

See Also:

Constant Field Values

OP_READ

static final short OP_READ

Constante que representa que os metodos de read são suportados

See Also:

Constant Field Values

OP_WRITE

static final short OP_WRITE

Constante que representa que os metodos de write são suportados

See Also:

Constant Field Values

OP_TRANSFER_FROM

static final short OP_TRANSFER_FROM

Constante que representa que o metodo transferFrom é suportado

See Also:

Constant Field Values

OP_TRANSFER_TO

static final short OP_TRANSFER_TO

Constante que representa que o metodo transferTo é suportado

See Also:

Constant Field Values

Method Detail

supportedOperations

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.

Returns:

operacoes suportadas

isOpen

boolean isOpen()

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

Specified by:

isOpen in interface Channel

Returns:

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

close

void close()
    throws IOException

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Throws:

IOException - Caso ocorra alguma falha no procedimento.

remaining

long remaining()
        throws IOException,
               DataChannelException

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.

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

long skip(long bytes)
   throws IOException,
          DataChannelException

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

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

long getSize()
      throws IOException,
             DataChannelException,
             UnsupportedOperationException

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.

Returns:

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

Throws:

IOException - Caso ocorra alguma falha no procedimento.

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

UnsupportedOperationException - Caso a operação na seja suportada nesse canal.

setSize

void setSize(long size)
      throws IOException,
             DataChannelException,
             UnsupportedOperationException

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.

Parameters:

size - O novo tamanho.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

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

UnsupportedOperationException - Caso a operação na seja suportada nesse canal.

getPosition

long getPosition()
          throws IOException,
                 DataChannelException,
                 UnsupportedOperationException

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.

Returns:

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

Throws:

IOException - Caso ocorra alguma falha no procedimento.

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

UnsupportedOperationException - Caso a operação na seja suportada nesse canal.

setPosition

void setPosition(long position)
          throws IOException,
                 DataChannelException,
                 UnsupportedOperationException

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

Parameters:

position - A nova posição.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

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

UnsupportedOperationException - Caso a operação na seja suportada nesse canal.

read

int read(ByteBuffer target)
  throws IOException,
         DataChannelException,
         UnsupportedOperationException

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.

Parameters:

target - O buffer.

Returns:

A quantidade de bytes lidos.

Throws:

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

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

UnsupportedOperationException - Caso a operação na seja suportada nesse canal.

read

int read(ByteBuffer target,
         long position)
  throws IOException,
         DataChannelException,
         UnsupportedOperationException

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.

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.

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

UnsupportedOperationException - Caso a operação na seja suportada nesse canal.

write

int write(ByteBuffer source)
   throws IOException,
          DataChannelException,
          UnsupportedOperationException

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.

Parameters:

source - O buffer.

Returns:

A quantidade de bytes escritos.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

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

UnsupportedOperationException - Caso a operação na seja suportada nesse canal.

write

int write(ByteBuffer source,
          long position)
   throws IOException,
          DataChannelException,
          UnsupportedOperationException

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.

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.

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

UnsupportedOperationException - Caso a operação na seja suportada nesse canal.

transferTo

long transferTo(long position,
                long count,
                WritableByteChannel output)
         throws IOException,
                DataChannelException,
                UnsupportedOperationException

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.

Parameters:

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

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

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

Returns:

A quantidade de bytes efetivamente transferidos.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

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

UnsupportedOperationException - Caso a operação na seja suportada nesse canal.

transferFrom

long transferFrom(ReadableByteChannel source,
                  long position,
                  long count)
           throws IOException,
                  DataChannelException,
                  UnsupportedOperationException

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.

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.

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

UnsupportedOperationException - Caso a operação na seja suportada nesse canal.