com.jparams.store.reference.ReferenceManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of data-store Show documentation

Data Store

There is a newer version: 3.1.4

package com.jparams.store.reference;

import java.util.Collection;
import java.util.Optional;

/**
 * The reference managed is internal to a store and should not be exposed outside the class. It is responsible
 * for storing, managing and creating references to objects held with a store.
 *
 * @param  type of item referenced
 */
public interface ReferenceManager
{
    /**
     * Return all references as a collection. This MUST return a modifiable collection.
     *
     * @return modifiable reference collection
     */
    Collection> getReferences();

    /**
     * Find a reference matching the item if one exists
     *
     * @param item item to lookup
     * @return reference
     */
    Optional> findReference(Object item);

    /**
     * Total number of references held by the manager
     *
     * @return total number of references held
     */
    int size();

    /**
     * clear all references held
     */
    void clear();

    /**
     * Create a new reference for the given object. If a reference already exists for this item, return
     * existing reference without adding duplicate.
     *
     * @param item item to on to reference manager
     * @return reference
     */
    Reference add(T item);

    /**
     * Create a copy of the reference manager
     *
     * @return copy
     */
    ReferenceManager copy();

    /**
     * Remove item in store
     *
     * @param item item to remove
     * @return reference removed
     */
    Reference remove(Object item);
}