edu.umd.cs.findbugs.classfile.impl.DirectoryCodeBaseEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spotbugs Show documentation
SpotBugs: Because it's easy!
The newest version!
/*
 * FindBugs - Find Bugs in Java programs
 * Copyright (C) 2006, University of Maryland
 *
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package edu.umd.cs.findbugs.classfile.impl;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;

import edu.umd.cs.findbugs.classfile.ClassDescriptor;
import edu.umd.cs.findbugs.classfile.DescriptorFactory;
import edu.umd.cs.findbugs.classfile.InvalidClassFileFormatException;

/**
 * Codebase entry class for directory codebases.
 *
 * @author David Hovemeyer
 */
public class DirectoryCodeBaseEntry extends AbstractScannableCodeBaseEntry {
    private final DirectoryCodeBase codeBase;

    private final String realResourceName;

    public DirectoryCodeBaseEntry(DirectoryCodeBase codeBase, String realResourceName) {
        this.codeBase = codeBase;
        this.realResourceName = realResourceName;
    }

    /*
     * (non-Javadoc)
     *
     * @see edu.umd.cs.findbugs.classfile.ICodeBaseEntry#getNumBytes()
     */
    @Override
    public int getNumBytes() {
        File fullPath = codeBase.getFullPathOfResource(realResourceName);
        // this is not needed but causes slowdown on a slow file system IO
        // file.length() returns zero if not found, and matches the contract of
        // this method
        // if (!fullPath.exists()) {
        // return -1;
        // }
        return (int) fullPath.length();
    }

    /*
     * (non-Javadoc)
     *
     * @see edu.umd.cs.findbugs.classfile.ICodeBaseEntry#openResource()
     */
    @Override
    public InputStream openResource() throws IOException {
        return codeBase.openFile(realResourceName);
    }

    /*
     * (non-Javadoc)
     *
     * @see
     * edu.umd.cs.findbugs.classfile.impl.AbstractScannableCodeBaseEntry#getCodeBase
     * ()
     */
    @Override
    public AbstractScannableCodeBase getCodeBase() {
        return codeBase;
    }

    /*
     * (non-Javadoc)
     *
     * @see edu.umd.cs.findbugs.classfile.impl.AbstractScannableCodeBaseEntry#
     * getRealResourceName()
     */
    @Override
    public String getRealResourceName() {
        return realResourceName;
    }

    /*
     * (non-Javadoc)
     *
     * @see edu.umd.cs.findbugs.classfile.ICodeBaseEntry#getClassDescriptor()
     */
    @Override
    public ClassDescriptor getClassDescriptor() throws InvalidClassFileFormatException {
        return DescriptorFactory.createClassDescriptorFromResourceName(getResourceName());
    }

    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if (obj == null || obj.getClass() != this.getClass()) {
            return false;
        }
        DirectoryCodeBaseEntry other = (DirectoryCodeBaseEntry) obj;
        return this.codeBase.equals(other.codeBase) && this.realResourceName.equals(other.realResourceName);
    }

    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return 7919 * codeBase.hashCode() + realResourceName.hashCode();
    }

    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return getCodeBase() + ":" + getResourceName();
    }
}