001/*
002 * SonarQube
003 * Copyright (C) 2009-2016 SonarSource SA
004 * mailto:contact 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 */
020
021package org.sonarqube.ws.client.rule;
022
023import com.google.common.collect.ImmutableSet;
024import java.util.Set;
025
026public class RulesWsParameters {
027  public static final String PARAM_REPOSITORIES = "repositories";
028  public static final String PARAM_RULE_KEY = "rule_key";
029  public static final String PARAM_ACTIVATION = "activation";
030  public static final String PARAM_QPROFILE = "qprofile";
031  public static final String PARAM_SEVERITIES = "severities";
032  public static final String PARAM_AVAILABLE_SINCE = "available_since";
033  public static final String PARAM_STATUSES = "statuses";
034  public static final String PARAM_LANGUAGES = "languages";
035  public static final String PARAM_TAGS = "tags";
036  public static final String PARAM_TYPES = "types";
037  public static final String PARAM_INHERITANCE = "inheritance";
038  public static final String PARAM_ACTIVE_SEVERITIES = "active_severities";
039  public static final String PARAM_IS_TEMPLATE = "is_template";
040  public static final String PARAM_TEMPLATE_KEY = "template_key";
041
042  public static final String FIELD_REPO = "repo";
043  public static final String FIELD_NAME = "name";
044  public static final String FIELD_CREATED_AT = "createdAt";
045  public static final String FIELD_SEVERITY = "severity";
046  public static final String FIELD_STATUS = "status";
047  public static final String FIELD_INTERNAL_KEY = "internalKey";
048  public static final String FIELD_IS_TEMPLATE = "isTemplate";
049  public static final String FIELD_TEMPLATE_KEY = "templateKey";
050  public static final String FIELD_TAGS = "tags";
051  public static final String FIELD_SYSTEM_TAGS = "sysTags";
052  public static final String FIELD_LANGUAGE = "lang";
053  public static final String FIELD_LANGUAGE_NAME = "langName";
054  public static final String FIELD_HTML_DESCRIPTION = "htmlDesc";
055  public static final String FIELD_MARKDOWN_DESCRIPTION = "mdDesc";
056  public static final String FIELD_NOTE_LOGIN = "noteLogin";
057  public static final String FIELD_MARKDOWN_NOTE = "mdNote";
058  public static final String FIELD_HTML_NOTE = "htmlNote";
059
060  /**
061   * @deprecated since 5.5, replaced by {@link #FIELD_DEFAULT_REM_FUNCTION}
062   */
063  @Deprecated
064  public static final String FIELD_DEFAULT_DEBT_REM_FUNCTION = "defaultDebtRemFn";
065  public static final String FIELD_DEFAULT_REM_FUNCTION = "defaultRemFn";
066
067  /**
068   * @deprecated since 5.5, replaced by {@link #FIELD_REM_FUNCTION}
069   */
070  @Deprecated
071  public static final String FIELD_DEBT_REM_FUNCTION = "debtRemFn";
072  public static final String FIELD_REM_FUNCTION = "remFn";
073
074  /**
075   * @deprecated since 5.5, replaced by {@link #FIELD_GAP_DESCRIPTION}
076   */
077  @Deprecated
078  public static final String FIELD_EFFORT_TO_FIX_DESCRIPTION = "effortToFixDescription";
079  public static final String FIELD_GAP_DESCRIPTION = "gapDescription";
080
081  /**
082   * @deprecated since 5.5, replaced by {@link #FIELD_REM_FUNCTION_OVERLOADED}
083   */
084  @Deprecated
085  public static final String FIELD_DEBT_OVERLOADED = "debtOverloaded";
086  public static final String FIELD_REM_FUNCTION_OVERLOADED = "remFnOverloaded";
087
088  public static final String FIELD_PARAMS = "params";
089  public static final String FIELD_ACTIVES = "actives";
090
091  public static final Set<String> OPTIONAL_FIELDS = ImmutableSet.of(FIELD_REPO, FIELD_NAME, FIELD_CREATED_AT, FIELD_SEVERITY, FIELD_STATUS, FIELD_INTERNAL_KEY, FIELD_IS_TEMPLATE,
092    FIELD_TEMPLATE_KEY, FIELD_TAGS, FIELD_SYSTEM_TAGS, FIELD_LANGUAGE, FIELD_LANGUAGE_NAME, FIELD_HTML_DESCRIPTION, FIELD_MARKDOWN_DESCRIPTION, FIELD_NOTE_LOGIN,
093    FIELD_MARKDOWN_NOTE, FIELD_HTML_NOTE,
094    FIELD_DEFAULT_DEBT_REM_FUNCTION, FIELD_EFFORT_TO_FIX_DESCRIPTION, FIELD_DEBT_OVERLOADED, FIELD_DEBT_REM_FUNCTION,
095    FIELD_DEFAULT_REM_FUNCTION, FIELD_GAP_DESCRIPTION, FIELD_REM_FUNCTION_OVERLOADED, FIELD_REM_FUNCTION,
096    FIELD_PARAMS, FIELD_ACTIVES);
097
098  private RulesWsParameters() {
099    // prevent instantiation
100  }
101}