001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
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     */
020    package org.sonar.api.batch;
021    
022    /**
023     * Barriers are used to define the order of execution of Decorators.
024     * 
025     * @since 2.3
026     */
027    public interface DecoratorBarriers {
028    
029      String START_VIOLATIONS_GENERATION = "START_VIOLATIONS_GENERATION";
030    
031      /**
032       * This barrier is used by a decorator in order to :
033       * <ul>
034       * <li>be executed after all the decorators which generate violations :
035       * <code>@DependsUpon(value=DecoratorBarriers.END_OF_VIOLATIONS_GENERATION</code></li>
036       * <li>declare that it generates violations : <code>@DependedUpon(value=DecoratorBarriers.END_OF_VIOLATIONS_GENERATION</code></li>
037       * </ul>
038       */
039      String END_OF_VIOLATIONS_GENERATION = "END_OF_VIOLATIONS_GENERATION";
040    
041      /**
042       * Any kinds of time machine data are calculated before this barrier. Decorators executed after this barrier can use
043       * Measure#getVariationValue() and Measure#getTendency() methods.
044       * 
045       * @since 2.5
046       */
047      String END_OF_TIME_MACHINE = "END_OF_TIME_MACHINE";
048    }