alfresco-community-repo/source/java/org/alfresco/repo/avm/LookupKey.java

/*
 * Copyright (C) 2005-2010 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 */
package org.alfresco.repo.avm;

import java.io.Serializable;

import org.alfresco.repo.avm.util.SimplePath;

/**
 * This is the key by which Lookup's are retrieved from the cache.
 * @author britt
 */
public class LookupKey implements Serializable
{
    private static final long serialVersionUID = 8471482833953423406L;

    /**
     * The name of the store.
     */
    private String fStoreName;

    /**
     * The path being looked up.
     */
    private SimplePath fPath;

    /**
     * The version being looked up.
     */
    private int fVersion;

    /**
     * Whether the lookup is a write lookup.
     */
    private boolean fWrite;

    /**
     * Whether the lookup includes deleted nodes.
     */
    private boolean fIncludeDeleted;

    /**
     * Create one from whole cloth.
     * @param version The version we're looking under.
     * @param path The path.
     * @param storeName The name of the store.
     * @param write Whether this is a write lookup.
     * @param includeDeleted Whether this lookup should include deleted items.
     */
    public LookupKey(int version,
                     SimplePath path,
                     String storeName,
                     boolean write,
                     boolean includeDeleted)
    {
        fVersion = version;
        fPath = path;
        fStoreName = storeName;
        fWrite = write;
        fIncludeDeleted = includeDeleted;
    }

    public LookupKey(LookupKey other)
    {
        fVersion = other.fVersion;
        fPath = other.fPath;
        fStoreName = other.fStoreName;
        fWrite = other.fWrite;
        fIncludeDeleted = other.fIncludeDeleted;
    }

    /**
     * Set the writeness of this key.
     */
    public void setWrite(boolean write)
    {
        fWrite = write;
    }

    /**
     * Get the store name for this key.
     * @return The store name.
     */
    public String getStoreName()
    {
        return fStoreName;
    }

    /**
     * Is this a write lookup.
     * @return Whether this is a write lookup.
     */
    public boolean isWrite()
    {
        return fWrite;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj)
    {
        if (this == obj)
        {
            return true;
        }
        if (!(obj instanceof LookupKey))
        {
            return false;
        }
        LookupKey o = (LookupKey)obj;
        return fStoreName.equalsIgnoreCase(o.fStoreName) &&
               fVersion == o.fVersion &&
               fPath.equals(o.fPath) &&
               fWrite == o.fWrite &&
               fIncludeDeleted == o.fIncludeDeleted;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode()
    {
        int hash = fStoreName.toLowerCase().hashCode();
        hash += fPath.hashCode();
        hash += fVersion;
        hash += fWrite ? 1 : 0;
        hash += fIncludeDeleted ? 1 : 0;
        return hash;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString()
    {
        return fStoreName + ":" + fPath + "-" + fVersion + "-" + fWrite + "-" + fIncludeDeleted;
    }
}