001package org.apache.maven.rtinfo;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * Provides information about the current Maven runtime.
024 *
025 * @since 3.0.2
026 */
027public interface RuntimeInformation
028{
029
030    /**
031     * Retrieves the current Maven version, for example "3.0.2".
032     *
033     * @return The current Maven version or an empty string if unknown, never {@code null}.
034     */
035    String getMavenVersion();
036
037    /**
038     * Checks whether the current Maven runtime matches the specified version range. A version range can either use the
039     * 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
040     * "[2.2.1,)", i.e. denotes the minimum version required.
041     *
042     * @param versionRange The version range to match the current Maven runtime against, must not be {@code null}.
043     * @return {@code true} if the current Maven runtime matches the specified version range, {@code false} otherwise.
044     * @throws IllegalArgumentException If the specified version range is {@code null}, empty or otherwise not a valid
045     *             version specification.
046     */
047    boolean isMavenVersion( String versionRange );
048
049}