/*
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * "The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations under
 * the License.
 *
 * The Original Code is ICEpdf 3.0 open source software code, released
 * May 1st, 2009. The Initial Developer of the Original Code is ICEsoft
 * Technologies Canada, Corp. Portions created by ICEsoft are Copyright (C)
 * 2004-2009 ICEsoft Technologies Canada, Corp. All Rights Reserved.
 *
 * Contributor(s): _____________________.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"
 * License), in which case the provisions of the LGPL License are
 * applicable instead of those above. If you wish to allow use of your
 * version of this file only under the terms of the LGPL License and not to
 * allow others to use your version of this file under the MPL, indicate
 * your decision by deleting the provisions above and replace them with
 * the notice and other provisions required by the LGPL License. If you do
 * not delete the provisions above, a recipient may use your version of
 * this file under either the MPL or the LGPL License."
 *
 */
package com.softwareimaging.jpdf.core.util;

import java.io.File;
import java.util.Vector;

import com.softwareimaging.logger.Logger;

/**
 * <p>
 * The <code>CacheManager</code> class has one very simple task which is to
 * ensure that when a document is closed there are no temporary
 * <code>ByteCache</code> or <code>ImageCache</code> objects left in the user's
 * temporary folder.
 * </p>
 * <p/>
 * <p>
 * Whenever a new <code>ByteCache</code> or <code>ImageCache</code> object is
 * created, the corresponding cached file name is registered with the
 * <code>CacheManger</code>. When the document is closed and the
 * <code>CacheManager</code> <code>despose()</code> method is called, all of the
 * registered files are deleted from the file system.
 * </p>
 * 
 * @since 1.1
 */
public class CacheManager {

	private int fileCount = 0;
	private Vector cachedFiles;

	/**
	 * Create a new instance of a CacheManager.
	 */
	public CacheManager() {
		cachedFiles = new Vector(128);
	}

	/**
	 * Add the file name of either a ByteCache or ImageCache object cached file.
	 * 
	 * @param filePath
	 *            the absolulte path to a temporary file.
	 */
	public synchronized void addCachedFile(String filePath) {
		// increment file count
		fileCount++;
		cachedFiles.add(filePath);
	}

	/**
	 * Remove all files specified by the addCachedFile method along with the
	 * temporary file created by this class.
	 */
	public void dispose() {
		for (Object cachedFile : cachedFiles) {
			String fileName = (String) cachedFile;
			try {
				boolean success = (new File(fileName)).delete();
				if (!success && Logger.areErrorsSupported()) {
					Logger.outputError("Error deleting cached file " + fileName);
				}
			} catch (SecurityException e) {
				if (Logger.areErrorsSupported()) {
					Logger.outputError("Security error removing cached file " + fileName, e);
				}
			}
		}
	}
}
