com.android.ide.common.repository

Class GradleVersion

java.lang.Object

com.android.ide.common.repository.GradleVersion

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GradleVersion>

public class GradleVersion
extends java.lang.Object
implements java.lang.Comparable<GradleVersion>, java.io.Serializable

Supports versions in the given formats:

• major (e.g. 1)
• major.minor (e.g. 1.0)
• major.minor.micro (e.g. 1.1.1)

A version can also be a "preview" (e.g. 1-alpha1, 1.0.0-rc2) or an unreleased version (or "snapshot") (e.g. 1-SNAPSHOT, 1.0.0-alpha1-SNAPSHOT).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GradleVersion.VersionSegment

Constructor Summary

Constructors

Constructor and Description
GradleVersion(int major, int minor)
GradleVersion(int major, int minor, int micro)

Method Summary

Modifier and Type	Method and Description
int	compareIgnoringQualifiers(GradleVersion version)
int	compareIgnoringQualifiers(java.lang.String version)
int	compareTo(GradleVersion version)
int	compareTo(java.lang.String version)
boolean	equals(java.lang.Object o)
java.util.List<GradleVersion.VersionSegment>	getAdditionalSegments()
int	getMajor()
GradleVersion.VersionSegment	getMajorSegment()
int	getMicro()
GradleVersion.VersionSegment	getMicroSegment()
int	getMinor()
GradleVersion.VersionSegment	getMinorSegment()
int	getPreview()
java.lang.String	getPreviewType()
int	hashCode()
boolean	isAtLeast(int major, int minor, int micro) Is this GradleVersion at least as high as the given major, minor, micro version?
boolean	isAtLeast(int major, int minor, int micro, java.lang.String previewType, int previewVersion, boolean isSnapshot) Is this GradleVersion at least as high as the given major, minor, micro version?
boolean	isPreview()
boolean	isSnapshot()
static GradleVersion	max(GradleVersion version1, GradleVersion version2) Returns the max of the two versions
static GradleVersion	parse(java.lang.String value) Parses the given version.
java.lang.String	toString()
static GradleVersion	tryParse(java.lang.String value) Parses the given version.
static GradleVersion	tryParseAndroidGradlePluginVersion(java.lang.String value) Parses the given string into a GradleVersion instance if it represents a valid Android Gradle plugin version, or returns null otherwise.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GradleVersion

public GradleVersion(int major,
                     int minor)

GradleVersion

public GradleVersion(int major,
                     int minor,
                     int micro)

Method Detail

tryParse

@Nullable
public static GradleVersion tryParse(@NonNull
                                               java.lang.String value)

Parses the given version. This method does the same as parse(String), but it does not throw exceptions if the given value does not conform with any of the supported version formats.

Parameters:

value - the version to parse.

Returns:

the created Version object, or null if the given value does not conform with any of the supported version formats.

parse

@NonNull
public static GradleVersion parse(@NonNull
                                           java.lang.String value)

Parses the given version.

Parameters:

value - the version to parse.

Returns:

the created Version object.

Throws:

java.lang.IllegalArgumentException - if the given value does not conform with any of the supported version formats.

getMajor

public int getMajor()

getMajorSegment

@NonNull
public GradleVersion.VersionSegment getMajorSegment()

getMinor

public int getMinor()

getMinorSegment

@Nullable
public GradleVersion.VersionSegment getMinorSegment()

getMicro

public int getMicro()

getMicroSegment

@Nullable
public GradleVersion.VersionSegment getMicroSegment()

getPreview

public int getPreview()

isPreview

public boolean isPreview()

getPreviewType

@Nullable
public java.lang.String getPreviewType()

isSnapshot

public boolean isSnapshot()

compareTo

public int compareTo(@NonNull
                     java.lang.String version)

compareTo

public int compareTo(@NonNull
                     GradleVersion version)

Specified by:

compareTo in interface java.lang.Comparable<GradleVersion>

compareIgnoringQualifiers

public int compareIgnoringQualifiers(@NonNull
                                     java.lang.String version)

compareIgnoringQualifiers

public int compareIgnoringQualifiers(@NonNull
                                     GradleVersion version)

isAtLeast

public boolean isAtLeast(int major,
                         int minor,
                         int micro)

Is this GradleVersion at least as high as the given major, minor, micro version?

isAtLeast

public boolean isAtLeast(int major,
                         int minor,
                         int micro,
                         @Nullable
                         java.lang.String previewType,
                         int previewVersion,
                         boolean isSnapshot)

Is this GradleVersion at least as high as the given major, minor, micro version?

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAdditionalSegments

@NonNull
public java.util.List<GradleVersion.VersionSegment> getAdditionalSegments()

Returns:

version segments present after the "micro" segments. For example, parsing "1.2.3.4.5" will result in "4" and "5" to be considered "additional" version segments.

max

@Nullable
public static GradleVersion max(@Nullable
                                          GradleVersion version1,
                                          @Nullable
                                          GradleVersion version2)

Returns the max of the two versions

tryParseAndroidGradlePluginVersion

@Nullable
public static GradleVersion tryParseAndroidGradlePluginVersion(@NonNull
                                                                         java.lang.String value)

Parses the given string into a GradleVersion instance if it represents a valid Android Gradle plugin version, or returns null otherwise.

This method is similar to tryParse(String) but has stricter constraints on what will be accepted as a valid Android Gradle plugin version. For example, this method does not accept "3.1.0.0" as a valid plugin version, but the other method does.

Parameters:

value - the string to parse

Returns:

the created GradleVersion instance, or null if the given string does not represent a valid Android Gradle plugin version.

See Also:

tryParse(String)