001/* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2012 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * Sonar 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 * Sonar 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 017 * License along with Sonar; if not, write to the Free Software 018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 019 */ 020package org.sonar.api.workflow.condition; 021 022import com.google.common.annotations.Beta; 023import org.sonar.api.workflow.Review; 024import org.sonar.api.workflow.WorkflowContext; 025 026import javax.annotation.Nullable; 027 028/** 029 * Conditions control who can perform a command (i.e. who can see the screen 030 * associated to the command). 031 * 032 * @since 3.1 033 */ 034@Beta 035public abstract class Condition { 036 037 private final boolean onContext; 038 039 protected Condition(boolean onContext) { 040 this.onContext = onContext; 041 } 042 043 /** 044 * @return true if the condition relates to a review, false if it relates to the resource 045 * context (selected file, end-user, ...) 046 */ 047 public final boolean isOnContext() { 048 return onContext; 049 } 050 051 /** 052 * @param review the review on "review conditions" like StatusCondition, null on "context conditions" 053 * like AdminRoleCondition or ProjectPropertyCondition 054 * @param context 055 * @return is the condition verified ? 056 */ 057 public abstract boolean doVerify(@Nullable Review review, WorkflowContext context); 058 059}