|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.util.Version
public class Version
The Version class is a helper class that describes version information about a particular type of service.
Field Summary | |
---|---|
static int |
ANY
The ANY value indicates a version component that will match any revision. |
Constructor Summary | |
---|---|
Version(java.lang.Class<? extends Service> serviceClass,
int major,
int minor,
Version... impliedVersions)
Creates a new Version instance for the specified service and defines the major and minor versions for the service. |
|
Version(java.lang.Class<? extends Service> serviceClass,
java.lang.String versionDescription,
Version... impliedVersions)
Creates a new Version instance using a version description with the format [{service}]{major}.{minor} . |
Method Summary | |
---|---|
static Version |
anyMinorVersionOf(Version v)
Returns a version that matches the input service type and major version but ANY minor version. |
boolean |
equals(java.lang.Object o)
|
static Version |
findServiceVersion(java.util.Collection<? extends Version> versionList,
java.lang.Class<? extends Service> serviceClass)
Finds a matching version for serviceClass in a list of versions,
or returns null otherwise. |
java.util.List<Version> |
getImpliedVersions()
Returns the list of related services versions that are implied by this version. |
int |
getMajor()
Returns the major revision of the version. |
int |
getMinor()
Returns the minor revision of the version. |
java.lang.Class<? extends Service> |
getServiceClass()
Returns the service type of the version. |
java.lang.String |
getVersionString()
Returns the String representation of the version. |
int |
hashCode()
|
boolean |
isAfter(Version v)
Returns true if this version is a later version than the argument,
on the basis of comparing the major and minor versions. |
boolean |
isBefore(Version v)
Returns true if this version is a earlier version than the
argument, on the basis of comparing the major and minor versions. |
boolean |
isCompatible(Version v)
Returns true if the specified version is compatible with this
version or one of its implied versions. |
boolean |
isSameService(Version v)
Returns true if the target version is for the same service. |
boolean |
matches(Version v)
Returns true if the specified version is a match with this version
or one of its implied versions. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ANY
Constructor Detail |
---|
public Version(java.lang.Class<? extends Service> serviceClass, int major, int minor, Version... impliedVersions) throws java.lang.NullPointerException, java.lang.IllegalArgumentException
serviceClass
- the service type.major
- the major revision number of the service.minor
- the minor revision number of the service.
java.lang.NullPointerException
- if the service type is null
.
java.lang.IllegalArgumentException
- if revision values are invalid.public Version(java.lang.Class<? extends Service> serviceClass, java.lang.String versionDescription, Version... impliedVersions) throws java.lang.IllegalArgumentException
[{service}]{major}.{minor}
.
serviceClass
- the service type.versionDescription
- the service description.
java.lang.IllegalArgumentException
- if the versionDescription has an invalid
syntax or includes a service name that does not match the service
type.Method Detail |
---|
public static Version findServiceVersion(java.util.Collection<? extends Version> versionList, java.lang.Class<? extends Service> serviceClass)
serviceClass
in a list of versions,
or returns null
otherwise.
versionList
- the list of versions to search.serviceClass
- the service class to match.
null
.public static Version anyMinorVersionOf(Version v)
ANY
minor version.
v
- input version type
public final java.lang.Class<? extends Service> getServiceClass()
public final int getMajor()
public final int getMinor()
public final java.lang.String getVersionString()
public final boolean isSameService(Version v)
true
if the target version is for the same service.
v
- target version to check.
true
if service matches.public final boolean isCompatible(Version v)
true
if the specified version is compatible with this
version or one of its implied versions. Two versions are compatible if they
are for the same service and have a matching major version number (or one
of them has a major version of ANY
).
public final boolean matches(Version v)
true
if the specified version is a match with this version
or one of its implied versions. Two versions are compatible if they are for
the same service and have matching major and minor version numbers. A
version number is a match if it is the same or one is ANY
.
public final boolean isAfter(Version v)
true
if this version is a later version than the argument,
on the basis of comparing the major and minor versions. For the purposes of
comparison, a value of ANY
is considered to be
Integer.MAX_VALUE
, so no finite version number may come after it.
v
- version to compare against
true
if this version is later than the argument
java.lang.IllegalArgumentException
- if the provided version is not for the
same service as this version or for one implied by this version.public final boolean isBefore(Version v)
true
if this version is a earlier version than the
argument, on the basis of comparing the major and minor versions. For the
purposes of comparison, a value of ANY
is considered to be
Integer.MIN_VALUE
, so no finite version number may come before it.
v
- version to compare against
true
if this version is later than the argument
java.lang.IllegalArgumentException
- if the provided version is not for the
same service as this version or for one implied by this version.public java.util.List<Version> getImpliedVersions()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |