org.sonar.api.technicaldebt.server.Characteristic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation

There is a newer version: 5.1

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

package org.sonar.api.technicaldebt.server;

import org.sonar.api.rule.RuleKey;
import org.sonar.api.utils.WorkUnit;
import org.sonar.api.utils.internal.WorkDuration;

import javax.annotation.CheckForNull;

/**
 * @since 4.1
 * @deprecated since 4.3.
 */
@Deprecated
public interface Characteristic {

  Integer id();

  String key();

  String name();

  Integer order();

  @CheckForNull
  Integer parentId();

  /**
   * @deprecated since 4.3. return null
   */
  @Deprecated
  @CheckForNull
  Integer rootId();

  /**
   * @deprecated since 4.3. return null
   */
  @Deprecated
  RuleKey ruleKey();

  /**
   * @deprecated since 4.3. return null
   */
  @Deprecated
  String function();

  /**
   * @deprecated since 4.2
   */
  @Deprecated
  @CheckForNull
  WorkUnit factor();

  /**
   * @since 4.2
   */
  @CheckForNull
  Integer factorValue();

  /**
   * @since 4.2
   */
  @CheckForNull
  WorkDuration.UNIT factorUnit();

  /**
   * @deprecated since 4.2
   */
  @Deprecated
  @CheckForNull
  WorkUnit offset();

  /**
   * @since 4.2
   */
  @CheckForNull
  Integer offsetValue();

  /**
   * @since 4.2
   */
  @CheckForNull
  WorkDuration.UNIT offsetUnit();

  boolean isRoot();

  /**
   * @deprecated since 4.3
   */
  @Deprecated
  boolean isRequirement();

}