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 */
020package org.sonar.api.issue;
021
022import org.sonar.api.batch.BatchSide;
023import org.sonar.api.ExtensionPoint;
024import org.sonar.api.user.User;
025
026import javax.annotation.Nullable;
027
028/**
029 * @since 3.6
030 */
031@BatchSide
032@ExtensionPoint
033public interface IssueHandler {
034
035  interface Context {
036    Issue issue();
037
038    boolean isNew();
039
040    boolean isEndOfLife();
041
042    Context setLine(@Nullable Integer i);
043
044    Context setMessage(@Nullable String s);
045
046    Context setSeverity(String s);
047
048    Context setEffortToFix(@Nullable Double d);
049
050    Context setAuthorLogin(@Nullable String s);
051
052    Context setAttribute(String key, @Nullable String value);
053
054    /**
055     * @deprecated since 3.7.1
056     */
057    @Deprecated
058    Context assign(@Nullable String login);
059
060    Context assign(@Nullable User user);
061
062    Context addComment(String text);
063
064  }
065
066  void onIssue(Context context);
067
068}