/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2000 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.vcscore.cache;

/**
 * Class that extends SoftReference (for performance reasons) and is used by the filesystem to
 * store reference to the FileObject. It also stores some dynamic fileobject-related
 * information.
 * @author  mkleint
 */

import java.lang.ref.*;
import java.io.File;

public class CacheReference extends java.lang.ref.SoftReference implements Runnable {
    
    private boolean virtual;
    
    /** Creates new CacheReference *
    public CacheReference(Object referent, File file, String cacheName) {
        super(referent);
        cacheFile = file;
        name = cacheName;
        important = true;
        virtual = false;
    }
     */
   
    /** Creates new CacheReference */
    public CacheReference(Object referent, ReferenceQueue q) {
        super(referent, q);
        virtual = false;
    }
   
    /**
     * Set the reference (fileobject) as being virtual. 
     * Virtual means the fileobject has no local file bound to itself.
     */
    public void setVirtual(boolean virt) {
        virtual = virt;
    }
    
    /**
     * 
     */
    public boolean isVirtual() {
        return virtual;
    }
    
    /**
     * This method is called when the reference is cleared.
     * The reference queue must be org.openide.util.Utilities.ACTIVE_REFERENCE_QUEUE
     */
    public void run() {
        //Don't do anything here. We want to keep the data in memory
        //as long as possible
    }
    
}