View Javadoc

1   /*
2    * Copyright 2008-2010 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  
17  package de.smartics.maven.issues.bugzilla;
18  
19  import org.apache.maven.artifact.versioning.ArtifactVersion;
20  
21  /**
22   * Arbiter to exclude or include versions in a report.
23   *
24   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
25   * @version $Revision:591 $
26   */
27  public interface VersionSkipper
28  {
29    // ********************************* Fields *********************************
30  
31    // --- constants ------------------------------------------------------------
32  
33    // ****************************** Initializer *******************************
34  
35    // ****************************** Inner Classes *****************************
36  
37    // ********************************* Methods ********************************
38  
39    // --- get&set --------------------------------------------------------------
40  
41    // --- business -------------------------------------------------------------
42  
43    /**
44     * Checks if the <code>version</code> should be skipped so that issues
45     * associated with this version are not rendered in the report.
46     *
47     * @param releaseVersion the version of the release.
48     * @param version the version to check for skipping its issues.
49     * @return <code>true</code> if the issues should be skipped and not rendered
50     *         in the report, <code>false</code> otherwise.
51     */
52    boolean skipVersion(final ArtifactVersion releaseVersion,
53        final ArtifactVersion version);
54  
55    // --- object basics --------------------------------------------------------
56  
57  }