View Javadoc

1   /*
2    * Copyright 2008-2013 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.maven.issues.bugzilla;
17  
18  import org.apache.maven.artifact.versioning.ArtifactVersion;
19  
20  /**
21   * Arbiter to exclude or include versions in a report.
22   *
23   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
24   * @version $Revision:591 $
25   */
26  public interface VersionSkipper
27  {
28    // ********************************* Fields *********************************
29  
30    // --- constants ------------------------------------------------------------
31  
32    // ****************************** Initializer *******************************
33  
34    // ****************************** Inner Classes *****************************
35  
36    // ********************************* Methods ********************************
37  
38    // --- get&set --------------------------------------------------------------
39  
40    // --- business -------------------------------------------------------------
41  
42    /**
43     * Checks if the <code>version</code> should be skipped so that issues
44     * associated with this version are not rendered in the report.
45     *
46     * @param releaseVersion the version of the release.
47     * @param version the version to check for skipping its issues.
48     * @return <code>true</code> if the issues should be skipped and not rendered
49     *         in the report, <code>false</code> otherwise.
50     */
51    boolean skipVersion(final ArtifactVersion releaseVersion,
52        final ArtifactVersion version);
53  
54    // --- object basics --------------------------------------------------------
55  
56  }