HistoryCache.java revision f4216ce32e4859fd256a197d10d19a0fdb9f468c
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* See LICENSE.txt included in this distribution for the specific
* language governing permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at LICENSE.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2008 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
interface HistoryCache {
/**
* Create and initialize an empty history cache if one doesn't exist
* already.
*
* @throws HistoryException if initalization fails
*/
void initialize() throws HistoryException;
/**
* Retrieve the history for the given file, either from the cache or by
* parsing the history information in the repository.
*
* @param file The file to retrieve history for
* @param parserClass The class that implements the parser to use
* @param repository The external repository to read the history from (can
* be <code>null</code>)
* @param withFiles A flag saying whether or not the returned history
* should include a list of files touched by each changeset. If false,
* the implementation is allowed to skip the file list, but it doesn't
* have to.
* @throws HistoryException if the history cannot be fetched
*/
throws HistoryException;
/**
* Store the history for a repository.
*
* @param history The history to store
* @param repository The repository whose history to store
* @throws HistoryException if the history cannot be stored
*/
throws HistoryException;
/**
* Optimize how the history is stored on disk. This method is typically
* called after the cache has been populated, or after large modifications
* to the cache. The exact effect of this method is specific to each
* implementation, but it may for example include compressing, compacting
* or reordering the disk image of the cache in order to optimize
* performance or space usage.
*
* @throws HistoryException if an error happens during optimization
*/
void optimize() throws HistoryException;
/**
* Check if the specified directory is present in the cache.
* @param directory the directory to check
* @param repository the repository in which the directory is stored
* @return {@code true} if the directory is in the cache, {@code false}
* otherwise
*/
throws HistoryException;
/**
* Get the revision identifier for the latest cached revision in a
* repository.
*
* @param repository the repository whose latest revision to return
* @return a string representing the latest revision in the cache, or
* {@code null} if it is unknown
*/
throws HistoryException;
/**
* Get a string with information about the history cache.
*
* @return a free form text string describing the history cache instance
* @throws HistoryException if an error occurred while getting the info
*/
}