com.google.cloud.tools.jib.plugins.common

Class VersionChecker<V extends Comparable<? super V>>

java.lang.Object

com.google.cloud.tools.jib.plugins.common.VersionChecker<V>

public class VersionChecker<V extends Comparable<? super V>>
extends Object

A simple version-range checker, intended to check whether a Jib plugin version falls in some range. A version range can be in one of two forms:

1. An interval such as [1.0,3.5), where square brackets indicate an closed boundary (includes the value) and parentheses indicates an open boundary (excludes the actual value). Either of the left or right bounds can be dropped (but not both!) to to indicate an half-bound. For example, [,4) will include any version up to but not including version 4.0.
2. a single version such a 1.0 which acts as an interval with an open left bound and akin to [1.0,)

To support custom version representations, the actual version object type (<V>) is pluggable. It must implement Comparable. The versions in the range must have at most 3 components (e.g., major.minor.micro).

This class exists as Gradle has no version-range-type class and Maven's org.apache.maven.artifact.versioning.VersionRange treats a single version as an exact bound. Note that Gradle's org.gradle.util.GradleVersion class does not support major-version-only versions.

Constructor Summary

Constructors

Constructor and Description
VersionChecker(Function<String,V> converter)

Method Summary

Modifier and Type	Method and Description
boolean	compatibleVersion(String acceptableVersionRange, String actualVersion) Return true if actualVersion is contained within the version range represented by acceptableVersionRange.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VersionChecker

public VersionChecker(Function<String,V> converter)

Method Detail

compatibleVersion

public boolean compatibleVersion(String acceptableVersionRange,
                                 String actualVersion)

Return true if actualVersion is contained within the version range represented by acceptableVersionRange.

Parameters:

acceptableVersionRange - the encoded version range

actualVersion - the version to be compared

Returns:

true if the version is acceptable

Throws:

IllegalArgumentException - if the version could not be parsed