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