DataHolder

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jpel.util.dataholder
Interface DataHolder

All Known Implementing Classes:: AbstractDataHolder

public interface DataHolder

Indica uma fonte de recursos para a linguagem.

Field Summary

static int BINARYSTREAM
          Indica uma fonte do tipo stream binário.

static int CHARACTERSTREAM
          Indica uma fonte do tipo stream de caracteres.

static long DATE_UNKNOWN
          Valor do lastModified quando não é possível determinar o valor exato.

static int FILE
          Indica uma fonte do tipo java.io.File.

static int OTHER
          Indica uma fonte do tipo qualquer.

static int URL
          Indica uma fonte do tipo java.net.URL.

Method Summary

void close()
          Libera todos os recursos utilizados pela fonte de recursos.

java.io.InputStream getInputStream()
          Retorna o buffer binário associado a fonte de recursos.

java.io.OutputStream getOutputStream()
          Retorna o buffer binário associado a fonte de recursos.

java.io.Reader getReader()
          Retorna um buffer de caracteres associado a fonte de recursos.

java.lang.Object getReference()
          Retorna o objeto java associado a fonte de recursos.

int getType()
          Indica o tipo do manipulador de recursos.

java.io.Writer getWriter()
          Retorna um buffer de caracteres associado a fonte de recursos.

long lastModified()
          Retorna data da última modificação feita nos dados.

jpel.util.dataholder.DataHolder relative(jpel.util.dataholder.DataHolder absolute)
          Converte uma referencia absoluta em uma referência relativa a este manipulador.

jpel.util.dataholder.DataHolder resolve(jpel.util.dataholder.DataHolder relative)
          Quando há a utilização de recursos com relação entre si pode haver a necessidade de resolução de nomes relativos.

void setReference(java.lang.Object reference)
          Ajusta o objeto usado como referencia pela pelo manipulador de dados.

void setType(int type)
          Ajusta o tipo do manipulador de recursos.

Field Detail

BINARYSTREAM

public static final int BINARYSTREAM

Indica uma fonte do tipo stream binário.

See Also:: Constant Field Values

CHARACTERSTREAM

public static final int CHARACTERSTREAM

Indica uma fonte do tipo stream de caracteres.

See Also:: Constant Field Values

FILE

public static final int FILE

Indica uma fonte do tipo java.io.File.

See Also:: Constant Field Values

URL

public static final int URL

Indica uma fonte do tipo java.net.URL.

See Also:: Constant Field Values

OTHER

public static final int OTHER

Indica uma fonte do tipo qualquer.

See Also:: Constant Field Values

DATE_UNKNOWN

public static final long DATE_UNKNOWN

Valor do lastModified quando não é possível determinar o valor exato.

See Also:: Constant Field Values

Method Detail

setType

public void setType(int type)

Ajusta o tipo do manipulador de recursos.

Parameters:: type - Tipo da fonte.

getType

public int getType()

Indica o tipo do manipulador de recursos.

Returns:: O inteiro correspondente ao tipo de fonte. Pode ser INPUTSTREAM, READER, FILE, URL ou OTHER.

setReference

public void setReference(java.lang.Object reference)

Ajusta o objeto usado como referencia pela pelo manipulador de dados.

Parameters:: reference - Referência do manipulador de dados.

getReference

public java.lang.Object getReference()

Retorna o objeto java associado a fonte de recursos. No caso do tipo FILE pode ser um java.io.File, no caso do tipo URL um objeto java do tipo java.net.URL.

Returns:: O objeto Java utilizado.

resolve

public jpel.util.dataholder.DataHolder resolve(jpel.util.dataholder.DataHolder relative)
                                        throws DataHolderException

Quando há a utilização de recursos com relação entre si pode haver a necessidade de resolução de nomes relativos. Por exemplo, a relação entre arquivos.

Parameters:: relative - O recurso ao qual se deseja resolver para o universo do recurso atual.
Por exemplo: Se a fonte atual de recursos(a) fosse o arquivo examples/full/name.cfg e houvesse outra fonte de recursos(b) com o nome ../resource.cfg, após a aplicação do a.resolve(b) haveria um fonte de recursos com uma referência para o arquivo examples/resource.cfg.
Returns:: A nova fonte de recursos resolvida.
Throws:: DataHolderException - Quando não é possível construir esta nova fonte de recursos.

relative

public jpel.util.dataholder.DataHolder relative(jpel.util.dataholder.DataHolder absolute)
                                         throws DataHolderException

Converte uma referencia absoluta em uma referência relativa a este manipulador.

Parameters:: absolute - Referência absoluta a ser convertida.
Por exemplo: Se a fonte atual de recursos(a) fosse o arquivo c:/examples/full/name.cfg e houvesse outra fonte de recursos(b) com o nome c:/subdir/resource.cfg, após a aplicação do a.relative(b) haveria um fonte de recursos com uma referencia para o arquivo ../../subdir/resource.cfg.
Returns:: A fonte de dados relativa.
Throws:: DataHolderException - Quando não é possível construir esta nova fonte de recursos.

lastModified

public long lastModified()
                  throws DataHolderException

Retorna data da última modificação feita nos dados.

Returns:: O tempo em milisegundos da ultima modificação.
Throws:: DataHolderException - Quando não foi possível descrever a data.

getInputStream

public java.io.InputStream getInputStream()
                                   throws DataHolderException

Retorna o buffer binário associado a fonte de recursos.

Returns:: Um buffer p/a leitura do recurso.
Throws:: DataHolderException - Quando há erro no fornecimento deste buffer.

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws DataHolderException