001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.tasklist.trampoline;
043:
044: import java.awt.Image;
045: import java.util.List;
046:
047: /**
048: * A class that describes Task group, e.g. Error, Warning, TODO etc. Task groups are
049: * visible to the user in Task List's window.
050: *
051: * @author S. Aubrecht
052: */
053: public final class TaskGroup implements Comparable<TaskGroup> {
054:
055: private String name;
056: private String displayName;
057: private String description;
058: private Image icon;
059: private int index;
060:
061: /**
062: * Creates a new instance of TaskGroup
063: *
064: * @param name Group's id
065: * @param displayName Group's display name
066: * @param description Group's description (for tooltips)
067: * @param icon Group's icon
068: */
069: public TaskGroup(String name, String displayName,
070: String description, Image icon) {
071: assert null != name;
072: assert null != displayName;
073: assert null != icon;
074:
075: this .name = name;
076: this .displayName = displayName;
077: this .description = description;
078: this .icon = icon;
079: }
080:
081: /**
082: * @return List of all available TaskGroups.
083: */
084: public static List<? extends TaskGroup> getGroups() {
085: return TaskGroupFactory.getDefault().getGroups();
086: }
087:
088: /**
089: * @return Identification of the group.
090: */
091: public String getName() {
092: return name;
093: }
094:
095: /**
096: * @return Group's display name
097: */
098: public String getDisplayName() {
099: return displayName;
100: }
101:
102: /**
103: * @return Group's description (for tooltips etc)
104: */
105: public String getDescription() {
106: return description;
107: }
108:
109: /**
110: * @return Group's icon.
111: */
112: public Image getIcon() {
113: return icon;
114: }
115:
116: public int compareTo(TaskGroup otherGroup) {
117: return index - otherGroup.index;
118: }
119:
120: void setIndex(int index) {
121: this .index = index;
122: }
123:
124: @Override
125: public String toString() {
126: return getDisplayName();
127: }
128:
129: @Override
130: public boolean equals(Object o) {
131: if (o == null)
132: return false;
133: if (getClass() != o.getClass())
134: return false;
135: final TaskGroup test = (TaskGroup) o;
136:
137: if (this .name != test.name && this .name != null
138: && !this .name.equals(test.name))
139: return false;
140: return true;
141: }
142:
143: @Override
144: public int hashCode() {
145: int hash = 3;
146: hash = 73 * hash
147: + (this .name != null ? this .name.hashCode() : 0);
148: return hash;
149: }
150: }
|