001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube 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 * SonarQube 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.BatchExtension;
023import org.sonar.api.user.User;
024
025import javax.annotation.Nullable;
026
027/**
028 * @since 3.6
029 */
030public interface IssueHandler extends BatchExtension {
031
032  interface Context {
033    Issue issue();
034
035    boolean isNew();
036
037    boolean isEndOfLife();
038
039    Context setLine(@Nullable Integer i);
040
041    Context setMessage(@Nullable String s);
042
043    Context setSeverity(String s);
044
045    Context setEffortToFix(@Nullable Double d);
046
047    Context setAuthorLogin(@Nullable String s);
048
049    Context setAttribute(String key, @Nullable String value);
050
051    /**
052     * @deprecated since 3.7.1
053     */
054    @Deprecated
055    Context assign(@Nullable String login);
056
057    Context assign(@Nullable User user);
058
059    Context addComment(String text);
060
061  }
062
063  void onIssue(Context context);
064
065}