001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar 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     * Sonar 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
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.checks.templates;
021    
022    import java.util.Locale;
023    
024    /**
025     * EXPERIMENTAL - will be used in version 2.2
026     * 
027     * @since 2.1
028     */
029    public abstract class CheckTemplateProperty implements Comparable<CheckTemplateProperty> {
030    
031      protected String key;
032      
033      public String getKey() {
034        return key;
035      }
036    
037      public void setKey(String s) {
038        this.key = s;
039      }
040    
041      public abstract String getTitle(Locale locale);
042    
043      public String getDescription() {
044        return getDescription(Locale.ENGLISH);
045      }
046    
047    
048      public abstract String getDescription(Locale locale);
049    
050      @Override
051      public final boolean equals(Object o) {
052        if (this == o) {
053          return true;
054        }
055        if (!(o instanceof CheckTemplateProperty)) {
056          return false;
057        }
058    
059        CheckTemplateProperty that = (CheckTemplateProperty) o;
060        return key.equals(that.key);
061      }
062    
063      @Override
064      public final int hashCode() {
065        return key.hashCode();
066      }
067    
068      public int compareTo(CheckTemplateProperty o) {
069        return getKey().compareTo(o.getKey());
070      }
071    }