001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program 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 * This program 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 */
020package org.sonar.api.server.rule;
021
022import org.apache.commons.lang.StringUtils;
023
024/**
025 * The characters allowed in rule tags are the same as those on StackOverflow, basically lower-case
026 * letters, digits, plus (+), sharp (#), dash (-) and dot (.)
027 * See http://meta.stackoverflow.com/questions/22624/what-symbols-characters-are-not-allowed-in-tags
028 * @since 4.2
029 */
030public class RuleTagFormat {
031
032  private static final String VALID_CHARACTERS_REGEX = "^[a-z0-9\\+#\\-\\.]+$";
033
034  private RuleTagFormat() {
035    // only static methods
036  }
037
038  public static boolean isValid(String tag) {
039    return StringUtils.isNotBlank(tag) && tag.matches(VALID_CHARACTERS_REGEX);
040  }
041
042  public static String validate(String tag) {
043    if (!isValid(tag)) {
044      throw new IllegalArgumentException(String.format("Tag '%s' is invalid. Rule tags accept only the characters: a-z, 0-9, '+', '-', '#', '.'", tag));
045    }
046    return tag;
047  }
048}