1 package org.apache.maven.api;
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 import org.apache.maven.api.annotations.Experimental;
23 import org.apache.maven.api.annotations.Nonnull;
24
25 /**
26 * A range of versions.
27 *
28 * @since 4.0
29 */
30 @Experimental
31 public interface VersionRange
32 {
33
34 // TODO: add access to the version information
35
36 /**
37 * Determines whether the specified version is contained within this range.
38 *
39 * @param version The version to test, must not be {@code null}.
40 * @return {@code true} if this range contains the specified version, {@code false} otherwise.
41 */
42 boolean contains( @Nonnull Version version );
43
44 /**
45 * Returns a string representation of this version range
46 * @return the string representation of this version range
47 */
48 @Nonnull
49 String asString();
50 }