com.solidfire.core.client

Class VersioningUtils

Object

VersioningUtils

public class VersioningUtils
extends Object

Helper methods for determining if the version of a connection is compatible with a constructor, service method, or parameters.

Constructor Summary

Constructors

Constructor and Description
VersioningUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> List<Method>	getMethodsOfGreaterVersion(T object, String baseVersion) Creates a list of version annotated methods, greater than a base version, for a given object.
static <T> Map<Method,Object>	getValuesOfMethodsWithGreaterVersion(T object, String baseVersion) Creates a map of version annotated methods, greater than a base version, for a given object, and the values returned by each method
static String	getVersionFromEndpoint(URL endpoint) Extracts the Element OS version from a URL endpoint
static boolean	isVersionGreater(String baseVersion, String checkedVersion) Confirms a version string is greater than a base version string
static boolean	isVersionGreaterOrEqual(String baseVersion, String checkedVersion) Confirms a version string is greater than or equal to a base version string
static boolean	isVersionLess(String baseVersion, String checkedVersion) Confirms a version string is less than a base version string
static boolean	isVersionLessOrEqual(String baseVersion, String checkedVersion) Confirms a version string is less than or equal to a base version string
static boolean	isVersionString(String possibleVersion) Checks the format of the version.
static <T> Map<String,Constructor<T>>	mapConstructorVersions(T object) Creates a map of version annotated constructors for a given object.
static <T> Map<String,Constructor<T>>	mapConstructorVersionsLargerThan(T object, String baseVersion) Creates a map of version annotated constructors, greater than a base version, for a given object.
static String	methodParametersToString(Collection<Method> methods) Creates a concatenated string of parameter names, from a collection of methods
static List<String>	transformMethodsToParameterNames(List<Method> methods) Creates a list of parameter names from a list of methods

Methods inherited from class Object

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

Constructor Detail

VersioningUtils

public VersioningUtils()

Method Detail

getVersionFromEndpoint

public static String getVersionFromEndpoint(URL endpoint)

Extracts the Element OS version from a URL endpoint

Parameters:

endpoint - an Element OS connection endpoint

Returns:

the version of the connection endpoint

isVersionString

public static boolean isVersionString(String possibleVersion)

Checks the format of the version. Format: XXX.XX

Parameters:

possibleVersion - a possible Version string

Returns:

true if the string matches the version format, otherwise false

isVersionGreater

public static boolean isVersionGreater(String baseVersion,
                       String checkedVersion)

Confirms a version string is greater than a base version string

Parameters:

baseVersion - the base version for comparison

checkedVersion - the version of comparison

Returns:

true if the checked version is greater than the base version, otherwise false

isVersionGreaterOrEqual

public static boolean isVersionGreaterOrEqual(String baseVersion,
                              String checkedVersion)

Confirms a version string is greater than or equal to a base version string

Parameters:

baseVersion - the base version for comparison

checkedVersion - the version of comparison

Returns:

true if the checked version is greater than or equal to the base version, otherwise false

isVersionLess

public static boolean isVersionLess(String baseVersion,
                    String checkedVersion)

Confirms a version string is less than a base version string

Parameters:

baseVersion - the base version for comparison

checkedVersion - the version of comparison

Returns:

true if the checked version is less than the base version, otherwise false

isVersionLessOrEqual

public static boolean isVersionLessOrEqual(String baseVersion,
                           String checkedVersion)

Confirms a version string is less than or equal to a base version string

Parameters:

baseVersion - the base version for comparison

checkedVersion - the version of comparison

Returns:

true if the checked version is less than or equal to the base version, otherwise false

mapConstructorVersions

public static <T> Map<String,Constructor<T>> mapConstructorVersions(T object)

Creates a map of version annotated constructors for a given object.

Parameters:

object - an object with one or more constructors annotated with the @Since annotation

Returns:

the map of constructor versions (key), and constructors (value)

mapConstructorVersionsLargerThan

public static <T> Map<String,Constructor<T>> mapConstructorVersionsLargerThan(T object,
                                                              String baseVersion)

Creates a map of version annotated constructors, greater than a base version, for a given object.

Parameters:

object - an object with one or more constructors annotated with the @Since annotation

baseVersion - the base version for comparison

Returns:

the map of constructor versions greater than the base version (key), and constructors (value)

getMethodsOfGreaterVersion

public static <T> List<Method> getMethodsOfGreaterVersion(T object,
                                          String baseVersion)

Creates a list of version annotated methods, greater than a base version, for a given object.

Parameters:

object - an object with one or more methods annotated with the @Since annotation

baseVersion - the base version for comparison

Returns:

the list of methods with versions greater than the base version

getValuesOfMethodsWithGreaterVersion

public static <T> Map<Method,Object> getValuesOfMethodsWithGreaterVersion(T object,
                                                          String baseVersion)

Creates a map of version annotated methods, greater than a base version, for a given object, and the values returned by each method

Parameters:

object - an object with one or more methods annotated with the @Since annotation

baseVersion - the base version for comparison

Returns:

the map of methods with versions greater than the base version (key), and the value returned by each method (value)

transformMethodsToParameterNames

public static List<String> transformMethodsToParameterNames(List<Method> methods)

Creates a list of parameter names from a list of methods

Parameters:

methods - a list of methods

Returns:

a list of parameter names

methodParametersToString

public static String methodParametersToString(Collection<Method> methods)

Creates a concatenated string of parameter names, from a collection of methods

Parameters:

methods - a collection of methods

Returns:

a single string containing all corresponding parameter names