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.resources;
021    
022    import org.apache.commons.lang.StringUtils;
023    import org.apache.commons.lang.builder.ToStringBuilder;
024    import org.sonar.api.utils.WildcardPattern;
025    
026    /**
027     * @since 1.10
028     */
029    public class Directory implements Resource {
030    
031      public static final String SEPARATOR = "/";
032      public static final String ROOT = "[root]";
033    
034      private String key;
035      private Language language;
036    
037      public Directory(String key) {
038        this(key, null);
039      }
040    
041      public Directory(String key, Language language) {
042        this.key = parseKey(key);
043        this.language = language;
044      }
045    
046      public String getKey() {
047        return key;
048      }
049    
050      public String getName() {
051        return key;
052      }
053    
054      public String getLongName() {
055        return null;
056      }
057    
058      public String getDescription() {
059        return null;
060      }
061    
062      public Language getLanguage() {
063        return language;
064      }
065    
066      public String getScope() {
067        return Resource.SCOPE_SPACE;
068      }
069    
070      public String getQualifier() {
071        return Resource.QUALIFIER_DIRECTORY;
072      }
073    
074      public Resource getParent() {
075        return null;
076      }
077    
078      public boolean matchFilePattern(String antPattern) {
079        WildcardPattern matcher = WildcardPattern.create(antPattern, "/");
080        return matcher.match(getKey());
081      }
082    
083      public static String parseKey(String key) {
084        if (StringUtils.isBlank(key)) {
085          return ROOT;
086        }
087    
088        key = key.replace('\\', '/');
089        key = StringUtils.trim(key);
090        key = StringUtils.removeStart(key, Directory.SEPARATOR);
091        key = StringUtils.removeEnd(key, Directory.SEPARATOR);
092        return key;
093      }
094    
095      @Override
096      public boolean equals(Object obj) {
097        if (!(obj instanceof Directory)) {
098          return false;
099        }
100        if (this == obj) {
101          return true;
102        }
103        Directory other = (Directory) obj;
104        return StringUtils.equals(key, other.getKey());
105      }
106    
107      @Override
108      public int hashCode() {
109        return key.hashCode();
110      }
111    
112      @Override
113      public String toString() {
114        return new ToStringBuilder(this)
115            .append("key", key)
116            .append("language", language)
117            .toString();
118      }
119    }