com.google.api.tools.framework.aspects.versioning.model

Class ApiVersionUtil

java.lang.Object

com.google.api.tools.framework.aspects.versioning.model.ApiVersionUtil

public class ApiVersionUtil
extends java.lang.Object

Util class that handles api version in //google/protobuf/api.proto

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	MAJOR_VERSION_REGEX_PATTERN
static java.util.regex.Pattern	SEMANTIC_VERSION_REGEX_PATTERN

Constructor Summary

Constructors

Constructor and Description
ApiVersionUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	appendVersionSuffix(java.lang.String apiVersion, java.lang.String versionSuffix) Append version suffix, if defined, to the given apiVersion.
static java.lang.String	extractDefaultMajorVersionFromPackageName(java.lang.String packageName) Extract major version from package name.
static java.lang.String	extractDefaultMajorVersionFromRestName(java.lang.String restName) Extract major version from REST element name.
static java.lang.String	extractMajorVersionFromSemanticVersion(java.lang.String semanticVersion) Return major version of the given semantic version.
static java.util.List<java.lang.String>	getReachableRestVersions(Model model) Return the list of API versions for all reachable API methods.
static boolean	isValidApiVersion(java.lang.String apiVersion) Return true if apiVersion is a valid semantic version (http://semver.org).
static boolean	isValidMajorVersion(java.lang.String apiVersion) Return true if apiVersion has a valid major version format.
static java.lang.String	stripVersionFromRestName(java.lang.String restName) Returns the REST name with version prefix stripped if it has.

Methods inherited from class java.lang.Object

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

Field Detail

MAJOR_VERSION_REGEX_PATTERN

public static final java.util.regex.Pattern MAJOR_VERSION_REGEX_PATTERN

SEMANTIC_VERSION_REGEX_PATTERN

public static final java.util.regex.Pattern SEMANTIC_VERSION_REGEX_PATTERN

Constructor Detail

ApiVersionUtil

public ApiVersionUtil()

Method Detail

extractDefaultMajorVersionFromPackageName

public static java.lang.String extractDefaultMajorVersionFromPackageName(java.lang.String packageName)

Extract major version from package name. The major version is reflected in the package name of the API, which must end in `v{major-version}`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. For that case, `v1` is returned.

extractDefaultMajorVersionFromRestName

public static java.lang.String extractDefaultMajorVersionFromRestName(java.lang.String restName)

Extract major version from REST element name. Rest element name has the form of "v1.foo.bar" or "foo.bar". For the later case, "v1" will be returned.

stripVersionFromRestName

public static java.lang.String stripVersionFromRestName(java.lang.String restName)

Returns the REST name with version prefix stripped if it has. Returns empty if the rest name only contains the version.

extractMajorVersionFromSemanticVersion

@Nullable
public static java.lang.String extractMajorVersionFromSemanticVersion(java.lang.String semanticVersion)

Return major version of the given semantic version. For example, `v2` is returned from `v2.10`. Return null if major version cannot be extracted.

isValidApiVersion

public static boolean isValidApiVersion(java.lang.String apiVersion)

Return true if apiVersion is a valid semantic version (http://semver.org). Otherwise, false.

isValidMajorVersion

public static boolean isValidMajorVersion(java.lang.String apiVersion)

Return true if apiVersion has a valid major version format.

appendVersionSuffix

public static java.lang.String appendVersionSuffix(java.lang.String apiVersion,
                                                   java.lang.String versionSuffix)

Append version suffix, if defined, to the given apiVersion.

getReachableRestVersions

public static java.util.List<java.lang.String> getReachableRestVersions(Model model)

Return the list of API versions for all reachable API methods.