fieldormethoddescriptor.java

A static analysis tool to find bugs in Java programs

/*
 * 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;

/**
 * Common superclass for FieldDescriptor and MethodDescriptor.
 * 
 * @author David Hovemeyer
 */
public abstract class FieldOrMethodDescriptor {
	private String className;
	private String name;
	private String signature;
	private boolean isStatic;

	public FieldOrMethodDescriptor(String className, String name, String signature, boolean isStatic) {
		this.className = className;
		this.name = name;
		this.signature = signature;
		this.isStatic = isStatic;
	}

	/**
	 * @return Returns the class name
	 */
	public String getClassName() {
		return className;
	}

	/**
	 * @return Returns the method name
	 */
	public String getName() {
		return name;
	}

	/**
	 * @return Returns the method signature
	 */
	public String getSignature() {
		return signature;
	}

	/**
	 * @return Returns true if method is static, false if not
	 */
	public boolean isStatic() {
		return isStatic;
	}

	protected int compareTo(FieldOrMethodDescriptor o) {
		int cmp;
		cmp = this.className.compareTo(o.className);
		if (cmp != 0) {
			return cmp;
		}
		cmp = this.name.compareTo(o.name);
		if (cmp != 0) {
			return cmp;
		}
		cmp = this.signature.compareTo(o.signature);
		if (cmp != 0) {
			return cmp;
		}
		return (this.isStatic ? 1 : 0) - (o.isStatic ? 1 : 0);
	}

	/* (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;
		}
		FieldOrMethodDescriptor other = (FieldOrMethodDescriptor) obj;
		return this.className.equals(other.className)
			&& this.name.equals(other.name)
			&& this.signature.equals(other.signature)
			&& this.isStatic == other.isStatic;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public int hashCode() {
		return className.hashCode() * 7919
			+ name.hashCode() * 3119  
			+ signature.hashCode() * 131
			+ (isStatic ? 1 : 0);
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		// FIXME: format more nicely
		return (isStatic ? "static " : "") + className + "." + name + ":" + signature;
	}
}