View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.rtinfo;
20  
21  /**
22   * Provides information about the current Maven runtime.
23   *
24   * @since 3.0.2
25   */
26  public interface RuntimeInformation {
27  
28      /**
29       * Retrieves the current Maven version, for example "3.0.2".
30       *
31       * @return The current Maven version or an empty string if unknown, never {@code null}.
32       */
33      String getMavenVersion();
34  
35      /**
36       * Checks whether the current Maven runtime matches the specified version range. A version range can either use the
37       * usual mathematical syntax "[2.0.10,2.1.0),[3.0,)" or use a single version "2.2.1". The latter is a short form for
38       * "[2.2.1,)", i.e. denotes the minimum version required.
39       *
40       * @param versionRange The version range to match the current Maven runtime against, must not be {@code null}.
41       * @return {@code true} if the current Maven runtime matches the specified version range, {@code false} otherwise.
42       * @throws IllegalArgumentException If the specified version range is {@code null}, empty or otherwise not a valid
43       *             version specification.
44       */
45      boolean isMavenVersion(String versionRange);
46  }