001/* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2014 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.batch.postjob; 021 022import com.google.common.annotations.Beta; 023 024/** 025 * Describe what a {@link PostJob} is doing. Information may be used by the platform 026 * to log interesting information or perform some optimization. 027 * See {@link PostJob#describe(PostJobDescriptor)} 028 * @since 5.2 029 */ 030@Beta 031public interface PostJobDescriptor { 032 033 /** 034 * Displayable name of the {@link PostJob}. Will be displayed in logs. 035 */ 036 PostJobDescriptor name(String postJobName); 037 038 /** 039 * Property this {@link PostJob} depends on. Used by the platform to skip execution of the {@link PostJob} when 040 * property is not set. 041 */ 042 PostJobDescriptor requireProperty(String... propertyKey); 043 044 /** 045 * List properties this {@link PostJob} depends on. Used by the platform to skip execution of the {@link PostJob} when 046 * property is not set. 047 */ 048 PostJobDescriptor requireProperties(String... propertyKeys); 049 050 /** 051 * Should this PostJob be disabled in issues mode. Default is to run all PostJobs in preview mode. 052 */ 053 PostJobDescriptor disabledInIssues(); 054 055}