org.brandao.brcache

Class Cache

java.lang.Object

org.brandao.brcache.StreamCache

org.brandao.brcache.BasicCache

org.brandao.brcache.Cache

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TXCache

public class Cache
extends BasicCache

É a classe central do BRCache.

Ele faz o mapeamento chave-valor. Uma chave somente pode estar associado a um valor. Não são permtidos chaves duplicadas.

 ex:
    
    Cache cache = ...;
    cache.put("uma_chave", meuObjeto, 1200, 0);
    
 ex2:
    
    MeuObjeto o = cache.get("uma_chave");

 

Author:

Brandao

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.brandao.concurrent.NamedLock	locks

Fields inherited from class org.brandao.brcache.BasicCache

config

Constructor Summary

Constructors

Constructor and Description
Cache() Cria um novo cache.
Cache(BRCacheConfig config) Cria um novo cache a partir de uma configuração específica.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsKey(String key) Verifica se uma chave está associado a um valor.
Object	get(String key) Obtém o valor associado à chave.
InputStream	getStream(String key) Obtém o fluxo de bytes do valor associado à chave.
boolean	isEmpty() Verifica se o cache está vazio.
boolean	put(String key, Object value, long timeToLive, long timeToIdle) Associa o valor à chave.
Object	putIfAbsent(String key, Object value, long timeToLive, long timeToIdle) Associa o valor à chave somente se a chave não estiver associada a um valor.
InputStream	putIfAbsentStream(String key, InputStream inputData, long timeToLive, long timeToIdle) Associa o fluxo de bytes do valor à chave somente se a chave não estiver associada a um valor.
boolean	putStream(String key, InputStream inputData, long timeToLive, long timeToIdle) Associa o fluxo de bytes do valor à chave.
boolean	remove(String key) Remove o valor associado à chave.
boolean	remove(String key, Object value) Remove o valor associado à chave somente se ele for igual a um determinado valor.
boolean	replace(String key, Object value, long timeToLive, long timeToIdle) Substitui o valor associado à chave somente se ele existir.
boolean	replace(String key, Object oldValue, Object newValue, long timeToLive, long timeToIdle) Substitui o valor associado à chave somente se ele for igual a um determinado valor.
boolean	replaceStream(String key, InputStream inputData, long timeToLive, long timeToIdle) Substitui o fluxo de bytes associado à chave somente se ele existir.
long	size() Obtém a quantidade de itens contido no cache.

Methods inherited from class org.brandao.brcache.BasicCache

getConfig, getTXCache, getTXCache

Methods inherited from class org.brandao.brcache.StreamCache

clear, destroy, finalize, getCountRead, getCountReadData, getCountRemoved, getCountRemovedData, getCountWrite, getCountWriteData, init, isDeleteOnExit, removeStream, setDeleteOnExit

Methods inherited from class java.lang.Object

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

Field Detail

locks

protected transient org.brandao.concurrent.NamedLock locks

Constructor Detail

Cache

public Cache()

Cria um novo cache.

Cache

public Cache(BRCacheConfig config)

Cria um novo cache a partir de uma configuração específica.

Parameters:

config - configuração.

Method Detail

replace

public boolean replace(String key,
              Object value,
              long timeToLive,
              long timeToIdle)
                throws StorageException

Substitui o valor associado à chave somente se ele existir.

Overrides:

replace in class BasicCache

Parameters:

key - chave associada ao valor.

value - valor para ser associado à chave.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

Returns:

true se o valor for substituido. Caso contrário, false.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

replaceStream

public boolean replaceStream(String key,
                    InputStream inputData,
                    long timeToLive,
                    long timeToIdle)
                      throws StorageException

Substitui o fluxo de bytes associado à chave somente se ele existir.

Overrides:

replaceStream in class BasicCache

Parameters:

key - chave associada ao valor.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

inputData - fluxo de bytes do valor.

Returns:

true se o valor for substituido. Caso contrário, false.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

replace

public boolean replace(String key,
              Object oldValue,
              Object newValue,
              long timeToLive,
              long timeToIdle)
                throws StorageException

Substitui o valor associado à chave somente se ele for igual a um determinado valor.

Parameters:

key - chave associada ao valor.

oldValue - valor esperado associado à chave.

newValue - valor para ser associado à chave.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

Returns:

true se o valor for substituido. Caso contrário, false.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

putIfAbsent

public Object putIfAbsent(String key,
                 Object value,
                 long timeToLive,
                 long timeToIdle)
                   throws StorageException

Associa o valor à chave somente se a chave não estiver associada a um valor.

Overrides:

putIfAbsent in class BasicCache

Parameters:

key - chave associada ao valor.

value - valor para ser associado à chave.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

Returns:

valor anterior associado à chave.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

putIfAbsentStream

public InputStream putIfAbsentStream(String key,
                            InputStream inputData,
                            long timeToLive,
                            long timeToIdle)
                              throws StorageException

Associa o fluxo de bytes do valor à chave somente se a chave não estiver associada a um valor.

Overrides:

putIfAbsentStream in class BasicCache

Parameters:

key - chave associada ao valor.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

inputData - fluxo de bytes do valor.

Returns:

fluxo associado à chave ou null.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

put

public boolean put(String key,
          Object value,
          long timeToLive,
          long timeToIdle)
            throws StorageException

Associa o valor à chave.

Overrides:

put in class BasicCache

Parameters:

key - chave associada ao valor.

value - valor para ser associado à chave.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

Returns:

true se o item for substituido. Caso contrário, false

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

putStream

public boolean putStream(String key,
                InputStream inputData,
                long timeToLive,
                long timeToIdle)
                  throws StorageException

Associa o fluxo de bytes do valor à chave.

Overrides:

putStream in class BasicCache

Parameters:

key - chave associada ao fluxo.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

inputData - fluxo de bytes do valor.

Returns:

true se o item for substituido. Caso contrário, false

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

get

public Object get(String key)
           throws RecoverException

Obtém o valor associado à chave.

Overrides:

get in class BasicCache

Parameters:

key - chave associada ao valor.

Returns:

valor associado à chave ou null.

Throws:

RecoverException - Lançada se ocorrer alguma falha ao tentar obter o item.

getStream

public InputStream getStream(String key)
                      throws RecoverException

Obtém o fluxo de bytes do valor associado à chave.

Overrides:

getStream in class BasicCache

Parameters:

key - chave associada ao fluxo.

Returns:

fluxo de bytes do valor ou null.

Throws:

RecoverException - Lançada se ocorrer alguma falha ao tentar obter o item.

remove

public boolean remove(String key,
             Object value)
               throws StorageException

Remove o valor associado à chave somente se ele for igual a um determinado valor.

Parameters:

key - chave associada ao valor.

value - valor esperado associado à chave.

Returns:

true se o valor for removido. Caso contrário, false.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar remover o item.

remove

public boolean remove(String key)
               throws StorageException

Remove o valor associado à chave.

Overrides:

remove in class BasicCache

Parameters:

key - chave associada ao valor.

Returns:

true se o valor for removido. Caso contrário false.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar remover o item.

size

public long size()

Obtém a quantidade de itens contido no cache.

Returns:

quantidade de itens.

isEmpty

public boolean isEmpty()

Verifica se o cache está vazio.

Returns:

true se o cache estiver vazio. Caso contrário, false.

containsKey

public boolean containsKey(String key)
                    throws RecoverException

Verifica se uma chave está associado a um valor.

Overrides:

containsKey in class StreamCache

Parameters:

key - chave associada ao valor.

Returns:

true se existir um valor associado à chave. Caso contrário, false.

Throws:

RecoverException - Lançada se ocorrer alguma falha ao tentar obter o item.