TagName.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 *
 * Copyright 2013-2020 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.datamodel;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Objects;

public class TagName implements Comparable<TagName>, Serializable {

        private static final long serialVersionUID = 1L;

        public enum HTML_COLOR {

                NONE("None", ""), //NON-NLS
                WHITE("White", "#FFFFFF"), //NON-NLS
                SILVER("Silver", "#C0C0C0"), //NON-NLS
                GRAY("Gray", "#808080"), //NON-NLS
                BLACK("Black", "#000000"), //NON-NLS
                RED("Red", "#FF0000"), //NON-NLS
                MAROON("Maron", "#800000"), //NON-NLS
                YELLOW("Yellow", "#FFFF00"), //NON-NLS
                OLIVE("Olive", "#808000"), //NON-NLS
                LIME("Lime", "#00FF00"), //NON-NLS
                GREEN("Green", "#008000"), //NON-NLS
                AQUA("Aqua", "#00FFFF"), //NON-NLS
                TEAL("Teal", "#008080"), //NON-NLS
                BLUE("Blue", "#0000FF"), //NON-NLS
                NAVY("Navy", "#000080"), //NON-NLS
                FUCHSIA("Fuchsia", "#FF00FF"), //NON-NLS
                PURPLE("Purple", "#800080"); //NON-NLS
                private final static HashMap<String, HTML_COLOR> colorMap = new HashMap<String, HTML_COLOR>();
                private final String name;
                private final String hexString;

                static {
                        for (HTML_COLOR color : HTML_COLOR.values()) {
                                colorMap.put(color.getName(), color);
                        }
                }

                HTML_COLOR(String name, String hexString) {
                        this.hexString = hexString;
                        this.name = name;
                }

                String getName() {
                        return name;
                }

                public String getRgbValue() {
                        return hexString;
                }

                public static HTML_COLOR getColorByName(String colorName) {
                        if (colorMap.containsKey(colorName)) {
                                return colorMap.get(colorName);
                        } else {
                                return NONE;
                        }
                }
        }
        private final long id;
        private final String displayName;
        private final String description;
        private final HTML_COLOR color;
        private final TskData.FileKnown knownStatus;
        private final long tagSetId;
        private final int rank;

        // Clients of the org.sleuthkit.datamodel package should not directly create these objects.
        TagName(long id, String displayName, String description, HTML_COLOR color, TskData.FileKnown knownStatus, long tagSetId, int rank) {
                this.id = id;
                this.displayName = displayName;
                this.description = description;
                this.color = color;
                this.knownStatus = knownStatus;
                this.tagSetId = tagSetId;
                this.rank = rank;
        }

        public long getId() {
                return id;
        }

        public String getDisplayName() {
                return displayName;
        }

        public String getDescription() {
                return description;
        }

        public HTML_COLOR getColor() {
                return color;
        }

        public TskData.FileKnown getKnownStatus() {
                return knownStatus;
        }

        long getTagSetId() {
                return tagSetId;
        }

        public int getRank() {
                return rank;
        }

        @Override
        public int compareTo(TagName other) {
                return this.getDisplayName().compareTo(other.getDisplayName());
        }

        @Override
        public int hashCode() {
                int hash = 5;
                hash = 89 * hash + (int) (this.id ^ (this.id >>> 32));
                hash = 89 * hash + (this.displayName != null ? this.displayName.hashCode() : 0);
                hash = 89 * hash + (this.description != null ? this.description.hashCode() : 0);
                hash = 89 * hash + (this.color != null ? this.color.hashCode() : 0);
                hash = 89 * hash + (this.knownStatus != null ? this.knownStatus.hashCode() : 0);
                hash = 89 * hash + (int) (this.id ^ (this.tagSetId >>> 32));
                return hash;
        }

        @Override
        public boolean equals(Object obj) {
                if (obj == null) {
                        return false;
                }
                if (getClass() != obj.getClass()) {
                        return false;
                }
                final TagName other = (TagName) obj;
                return (this.id == other.getId()
                                && Objects.equals(this.displayName, other.getDisplayName())
                                && Objects.equals(this.description, other.getDescription())
                                && Objects.equals(this.color, other.getColor())
                                && Objects.equals(this.knownStatus, other.getKnownStatus())
                                && this.tagSetId == other.getTagSetId());
        }
}