/*
 * FindBugs - Find bugs in Java programs
 * Copyright (C) 2003,2004 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;

A BugCode is an abbreviation that is shared among some number of BugPatterns.
For example, the code "HE" is shared by all of the BugPatterns that represent
hashcode/equals violations.
Author:
David Hovemeyer
See Also:
BugPattern/**
 * A BugCode is an abbreviation that is shared among some number of BugPatterns.
 * For example, the code "HE" is shared by all of the BugPatterns that represent
 * hashcode/equals violations.
 *
 * @author David Hovemeyer
 * @see BugPattern
 */
public class BugCode implements Comparable<BugCode> {
    private final String abbrev;

    private final int cweid;

    private final String description;

    
Constructor.
Params:
abbrev – 
           the abbreviation for the bug code
description – 
           a short textual description of the class of bug pattern
           represented by this bug code/**
     * Constructor.
     *
     * @param abbrev
     *            the abbreviation for the bug code
     * @param description
     *            a short textual description of the class of bug pattern
     *            represented by this bug code
     */
    public BugCode(String abbrev, String description) {
        this.abbrev = abbrev;
        this.description = description;
        this.cweid = 0;
    }

    public BugCode(String abbrev, String description, int cweid) {
        this.abbrev = abbrev;
        this.description = description;
        this.cweid = cweid;
    }

    
Get the abbreviation for this bug code.
/**
     * Get the abbreviation for this bug code.
     */
    public String getAbbrev() {
        return abbrev;
    }

    
Get the short textual description of the bug code.
/**
     * Get the short textual description of the bug code.
     */
    public String getDescription() {
        return description;
    }

    
Get the abbreviation fo this bug code.
/**
     * Get the abbreviation fo this bug code.
     */
    @Override
    public String toString() {
        return "BugCode[" + abbrev + "]";
    }

    
Returns:
Returns the cweid./**
     * @return Returns the cweid.
     */
    public int getCWEid() {
        return cweid;
    }

    @Override
    public int compareTo(BugCode o) {
        return abbrev.compareTo(o.abbrev);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof BugCode)) {
            return false;
        }
        BugCode other = (BugCode) o;
        return abbrev.equals(other.abbrev);
    }

    @Override
    public int hashCode() {
        return abbrev.hashCode();
    }
}