A version range is used to check in various operations whether a given object should be considered. Its main purpose is to serve as a programmatic representation of an user specified version range input string.
An instance of this interface can be constructed using the valueOf(
This interface is not intended to be subclassed by clients.
Instances of this interface can be serialized.
public < | accept( Invokes the argument visitor based on the kind of this version range object. |
public boolean | Indicates whether some other object is "equal to" this one. |
public int | hashCode() Returns a hash code value for the object. |
public boolean | Checks if this version range can accept the argument version number. |
public String | toString() Converts this version range to a semantically same string version range representation. |
public static VersionRange | Parses a string in version range format and creates a VersionRange object. |
This method equals to the following based on the type of this object:
return visitor.accept(this, param);
null
.
The equals
method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The equals
method for class Object
implements the most discriminating possible equivalence
relation on objects; that is, for any non-null reference values x
and y
, this method returns
true
if and only if x
and y
refer to the same object (x == y
has the value
true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden,
so as to maintain the general contract for the hashCode
method, which states that equal objects must have
equal hash codes.
true
if this object is the same as the obj argument; false
otherwise.
The general contract of hashCode
is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
Object.equals(
Object) method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class Object
does return distinct
integers for distinct objects. (This is typically implemented by converting the internal address of the object
into an integer, but this implementation technique is not required by the Java™ programming language.)
Note that when working with BundleIdentifiers, any version qualifiers should be converted to version numbers.
true
if the range includes the version number.null
.false
result.)this
.
Returns a string representation of the object.In general, the toString
method returns a string that
"textually represents" this object. The result should be a concise but informative representation that is easy
for a person to read. It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of
which the object is an instance, the at-sign character `@
', and the unsigned hexadecimal representation
of the hash code of the object. In other words, this method returns a string equal to the value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
This method will analyze the argument and convert it to a VersionRange object. The expected format can contain the following:
- Number: A version number in the format defined by BundleIdentifier. It must be one or more
non-negative integers separated by dot ('
.
') characters. E.g.1.2.3
Numbers without any enclosing range declaration will allow any versions that start with the given number. E.g. the input
1.2
allows1.2
,1.2.0
,1.2.1
, and any following version numbers up until1.3
. - Range: Two version numbers separated by comma ('
,
') enclosed in either parentheses ('('
and')'
) or brackets ('['
and']'
). The kind of enclosing characters may be used together. The enclosing characters correspond to the same semantics as in the notation used by intervals in mathematics. (Parentheses for open ended (exclusive) ranges, and brackets for closed (inclusive) ranges.)The right side of the range must be greater than the left side.
E.g.
[1, 2)
includes any version starting from1
and is smaller than2
. - Singular range: A range declaration that only contains one version number. It can have three formats:
[1.0)
: meaning versions at least1.0
, without any upper bound.(1.0]
: meaning versions at most1.0
, without any lower bound. (The range is inclusive for1.0
.) This is semantically same as[0, 1.0]
, as the version0
is the first one in order.[1.0]
: meaning exactly the version1.0
- Union relation: Any of the components can be enclosed in curly braces (
'{'
and'}
) and separated by vertical bars ('|'
). This declaration will enable versions matched by any of its compontents. E.g.{[1.0] | [2.0]}
matches only the versions1.0
and2.0
. Note that an union declaration without any components is considered to include no versions. - Intersection relation: Any of the components can be enclosed in intersection relation with each other.
The
'&'
character can be used to require that all parts of the input is satisfied. This relation exists for completeness of the version range format, and we haven't found a significant use-case for it as of yet. In general, intersections can be represented in a range based way more appropriately.
1.0
: Includes any version greater or equal to1.0
and less than1.1
. Semantically same as[1.0, 1.1)
.{1 | 3}
: Includes versions starting with1
or3
, but doesn't include versions with other starting components.
Included examples:1
,1.0
,1.1
,3
,3.2
Not included examples:2
,2.0
,4.0
{}
: Doesn't include any versions. Unsatisfiable.(1.1, 1.4)
: Includes versions greater than1.1
and less than1.4
.
Included examples:1.1.0
,1.1.1
,1.2
,1.3.9
,1.3.9.0
Not included examples:1.0
,1.1
,1.4
,1.4.0
{1.0}
: Same as1.0
.
The method may return a version range that doesn't exactly match the input, but only semantically. Meaning that it may perform some optimizations.
null
.