001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * SonarQube is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.api.config;
021    
022    import org.apache.commons.lang.StringUtils;
023    
024    import java.util.Locale;
025    
026    /**
027     * @since 3.7
028     */
029    public class Category {
030    
031      private final String originalKey;
032      private final boolean special;
033    
034      Category(String originalKey) {
035        this(originalKey, false);
036      }
037    
038      Category(String originalKey, boolean special) {
039        this.originalKey = originalKey;
040        this.special = special;
041      }
042    
043      public String originalKey() {
044        return originalKey;
045      }
046    
047      public String key() {
048        return StringUtils.lowerCase(originalKey, Locale.ENGLISH);
049      }
050    
051      public boolean isSpecial() {
052        return special;
053      }
054    
055      @Override
056      public int hashCode() {
057        return key().hashCode();
058      }
059    
060      @Override
061      public boolean equals(Object obj) {
062        if (!(obj instanceof Category)) {
063          return false;
064        }
065        return StringUtils.equalsIgnoreCase(((Category) obj).originalKey, this.originalKey);
066      }
067    
068      @Override
069      public String toString() {
070        return this.originalKey;
071      }
072    
073    }