org.brandao.brcache.collections.Swapper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of brcache Show documentation

The BRCache is a general-purpose caching system with transaction support.

There is a newer version: 1.0-b4

/*
 * BRCache http://brcache.brandao.org/
 * Copyright (C) 2015 Afonso Brandao. ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.brandao.brcache.collections;

/**
 * Permite o envio e recebimento de entidades de outro nível. 
 * Por exemplo, as entidades podem ser enviadas para o disco ou outro cache.
 * 
 * @author Brandao
 */
public interface Swapper {
    
    /**
     * Define a identificação do agrupamento de entidades.
     * @param value Identificação do agrupamento.
     */
    void setId(String value);
    
    /**
     * Envia uma entidade para o agrupamento.
     * @param index Índice da entidade.
     * @param item Item.
     */
    void sendItem(Integer index, Entry item);

    /**
     * Recupera uma entidade do agrupamento.
     * @param index Índice
     * @return item.
     */
    Entry getItem(Integer index);
    
    /**
     * Remove todas as entidade do agrupamento.
     */
    void clear();
    
}