001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info 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.batch.postjob;
021
022/**
023 * Describe what a {@link PostJob} is doing. Information may be used by the platform
024 * to log interesting information or perform some optimization.
025 * See {@link PostJob#describe(PostJobDescriptor)}
026 * @since 5.2
027 */
028public interface PostJobDescriptor {
029
030  /**
031   * Displayable name of the {@link PostJob}. Will be displayed in logs.
032   */
033  PostJobDescriptor name(String postJobName);
034
035  /**
036   * Property this {@link PostJob} depends on. Used by the platform to skip execution of the {@link PostJob} when
037   * property is not set.
038   */
039  PostJobDescriptor requireProperty(String... propertyKey);
040
041  /**
042   * List properties this {@link PostJob} depends on. Used by the platform to skip execution of the {@link PostJob} when
043   * property is not set.
044   */
045  PostJobDescriptor requireProperties(String... propertyKeys);
046
047}