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 extends Resource {
030    
031      public static final String SEPARATOR = "/";
032      public static final String ROOT = "[root]";
033    
034      private Language language;
035    
036      public Directory(String key) {
037        this(key, null);
038      }
039    
040      public Directory(String key, Language language) {
041        setKey(parseKey(key));
042        this.language = language;
043      }
044    
045      public String getName() {
046        return getKey();
047      }
048    
049      public String getLongName() {
050        return null;
051      }
052    
053      public String getDescription() {
054        return null;
055      }
056    
057      public Language getLanguage() {
058        return language;
059      }
060    
061      public String getScope() {
062        return Resource.SCOPE_SPACE;
063      }
064    
065      public String getQualifier() {
066        return Resource.QUALIFIER_DIRECTORY;
067      }
068    
069      public Resource getParent() {
070        return null;
071      }
072    
073      public boolean matchFilePattern(String antPattern) {
074        WildcardPattern matcher = WildcardPattern.create(antPattern, "/");
075        return matcher.match(getKey());
076      }
077    
078      public static String parseKey(String key) {
079        if (StringUtils.isBlank(key)) {
080          return ROOT;
081        }
082    
083        key = key.replace('\\', '/');
084        key = StringUtils.trim(key);
085        key = StringUtils.removeStart(key, Directory.SEPARATOR);
086        key = StringUtils.removeEnd(key, Directory.SEPARATOR);
087        return key;
088      }
089    
090      @Override
091      public String toString() {
092        return new ToStringBuilder(this)
093            .append("key", getKey())
094            .append("language", language)
095            .toString();
096      }
097    }