com.force.api

Class ExtendedApiVersion

java.lang.Object

com.force.api.ExtendedApiVersion

All Implemented Interfaces:

Comparable<ExtendedApiVersion>

public class ExtendedApiVersion
extends Object
implements Comparable<ExtendedApiVersion>

represents a single supported API version as reported by the /services/data resource for the instance endpoint returned on authentication. com.frejo.api.ApiVersion was originally used to set the current API version and manage the complete list of versions as an enum. It will likely be phased out in favor of using plain version strings along with this class for more extended version information. This is a tweak to an original proposal by @cswendrowski.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtendedApiVersion.Season

Constructor Summary

Constructors

Constructor and Description
ExtendedApiVersion()
ExtendedApiVersion(ExtendedApiVersion.Season s, int y)
ExtendedApiVersion(float version)
ExtendedApiVersion(String version)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ExtendedApiVersion o)
boolean	equals(Object other)
String	getLabel()
String	getUrl()
float	getVersion()
String	getVersionString()
void	setLabel(String label)
void	setUrl(String url)
void	setVersion(float version) sets version number as a float.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedApiVersion

public ExtendedApiVersion()

ExtendedApiVersion

public ExtendedApiVersion(float version)

ExtendedApiVersion

public ExtendedApiVersion(ExtendedApiVersion.Season s,
                          int y)

ExtendedApiVersion

public ExtendedApiVersion(String version)

Parameters:

version - formatted as a string: "vX.Y", e.g. "v39.0"

Method Detail

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getVersion

public float getVersion()

getVersionString

public String getVersionString()

setVersion

public void setVersion(float version)

sets version number as a float. This would more correct have been called setNumber but the field name in REST API is version.

Parameters:

version - version number as float, e.g. 25.0

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(ExtendedApiVersion o)

Specified by:

compareTo in interface Comparable<ExtendedApiVersion>