ApplicationID (Groovy Documentation)

com.cedarsoftware.ncube.ApplicationID

This class binds together Tenant, App, version, status, and branch. These fields together completely identify the application that a given n-cube belongs to.
Authors:
John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License") you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`DEFAULT_APP`
`static java.lang.String`	`DEFAULT_STATUS`
`static java.lang.String`	`DEFAULT_TENANT`
`static java.lang.String`	`DEFAULT_VERSION`
`static java.lang.String`	`HEAD`
`static java.lang.String`	`TEST_BRANCH`
`static java.util.regex.Pattern`	`VERSION_REGEX`
`private java.lang.String`	`app`
`private java.lang.String`	`branch`
`private java.lang.String`	`status`
`private java.lang.String`	`tenant`
`static ApplicationID`	`testAppId`
`private java.lang.String`	`version`

Constructor Summary

Constructors
Constructor and description
`private ApplicationID ()`
`ApplicationID (java.lang.String tenant, java.lang.String app, java.lang.String version, java.lang.String status, java.lang.String branch)`

Methods Summary

Methods
Type	Name and description
`ApplicationID`	`asBranch(java.lang.String bran)` Convert an ApplicationID from one branch to another
`ApplicationID`	`asHead()` Creates a new ApplicationID with HEAD as the branch using all the same parameters of this ApplicationID.
`ApplicationID`	`asRelease()` Creates a new ApplicationID with a status of release using all the same parameters of this ApplicationID, but forcing the branch to HEAD (release versions can only exit on HEAD).
`ApplicationID`	`asSnapshot()` Creates a new ApplicationID with a status of SNAPSHOT using all the same parameters of this ApplicationID.
`java.util.Map`	`asType(java.lang.Class clazz)` Allow ApplicationID to be converted to Map as in `appId as Map`
`ApplicationID`	`asVersion(java.lang.String ver)` Convert an Application from one version to another
`java.lang.String`	`branchAgnosticCacheKey()`
`java.lang.String`	`cacheKey()`
`java.lang.String`	`cacheKey(java.lang.String name)`
`ApplicationID`	`createNewSnapshotId(java.lang.String ver)` Creates a new SNAPSHOT version of this application id.
`boolean`	`equals(java.lang.Object o)`
`boolean`	`equalsNotIncludingBranch(ApplicationID that)`
`java.lang.String`	`getApp()`
`static ApplicationID`	`getBootVersion(java.lang.String tenant, java.lang.String app)`
`java.lang.String`	`getBranch()`
`java.lang.String`	`getStatus()`
`java.lang.String`	`getTenant()`
`java.lang.String`	`getVersion()`
`long`	`getVersionValue()` Returns: long version as a number that can be compared.
`static long`	`getVersionValue(java.lang.String version)` @param String version in "major.minor.patch" format where all three components are numeric and each one is less than 1,000.
`int`	`hashCode()`
`boolean`	`isHead()`
`boolean`	`isRelease()`
`boolean`	`isSnapshot()`
`java.lang.String`	`toString()`
`void`	`validate()` Ensure that all components of the ApplicationID are valid (with their specs in terms of allowable characters.)
`static void`	`validateApp(java.lang.String appName)`
`static void`	`validateBranch(java.lang.String branch)`
`void`	`validateBranchIsNotHead()`
`static void`	`validateStatus(java.lang.String status)`
`void`	`validateStatusIsNotRelease()`
`static void`	`validateTenant(java.lang.String tenant)`
`static void`	`validateVersion(java.lang.String version)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.lang.String DEFAULT_APP
  - public static final java.lang.String DEFAULT_STATUS
  - public static final java.lang.String DEFAULT_TENANT
  - public static final java.lang.String DEFAULT_VERSION
  - public static final java.lang.String HEAD
  - public static final java.lang.String TEST_BRANCH
  - public static final java.util.regex.Pattern VERSION_REGEX
  - private final java.lang.String app
  - private final java.lang.String branch
  - private final java.lang.String status
  - private final java.lang.String tenant
  - public static final ApplicationID testAppId
  - private final java.lang.String version
- Constructor Detail
  - private ApplicationID()
  - ApplicationID(java.lang.String tenant, java.lang.String app, java.lang.String version, java.lang.String status, java.lang.String branch)
- Method Detail
  - ApplicationID asBranch(java.lang.String bran)
    
    Convert an ApplicationID from one branch to another
    Returns:
    new ApplicationID in terms of the passed in branch (bran)
    Parameters:
    bran - String destination branch name
  - ApplicationID asHead()
    
    Creates a new ApplicationID with HEAD as the branch using all the same parameters of this ApplicationID.
    Returns:
    a new ApplicationId that is on the HEAD branch.
  - ApplicationID asRelease()
    
    Creates a new ApplicationID with a status of release using all the same parameters of this ApplicationID, but forcing the branch to HEAD (release versions can only exit on HEAD). If the current appliationID is already RELEASE just return this.
    Returns:
    a new ApplicationId that is in RELEASE mode.
  - ApplicationID asSnapshot()
    
    Creates a new ApplicationID with a status of SNAPSHOT using all the same parameters of this ApplicationID. If the current ApplicationID is already SNAPSHOT just return this.
    Returns:
    a new ApplicationId that is in SNAPSHOT mode.
  - java.util.Map asType(java.lang.Class clazz)
    
    Allow ApplicationID to be converted to Map as in appId as Map
  - ApplicationID asVersion(java.lang.String ver)
    
    Convert an Application from one version to another
    Returns:
    new ApplicationID in terms of the passed in version (ver)
    Parameters:
    ver - String destination version
  - java.lang.String branchAgnosticCacheKey()
  - java.lang.String cacheKey()
  - java.lang.String cacheKey(java.lang.String name)
  - ApplicationID createNewSnapshotId(java.lang.String ver)
    
    Creates a new SNAPSHOT version of this application id.
    Returns:
    a new ApplicationId that is a snapshot of the new version passed in.
    Parameters:
    ver - new version.
  - boolean equals(java.lang.Object o)
  - boolean equalsNotIncludingBranch(ApplicationID that)
  - java.lang.String getApp()
  - static ApplicationID getBootVersion(java.lang.String tenant, java.lang.String app)
  - java.lang.String getBranch()
  - java.lang.String getStatus()
  - java.lang.String getTenant()
  - java.lang.String getVersion()
  - long getVersionValue()
    
    Returns:
    long version as a number that can be compared. It is one million times major, plus one thousand times minor, plus patch.
  - static long getVersionValue(java.lang.String version)
    
    Returns:
    long version as a number that can be compared. It is one million times major, plus one thousand times minor, plus patch.
    Parameters:
    String - version in "major.minor.patch" format where all three components are numeric and each one is less than 1,000.
  - int hashCode()
  - boolean isHead()
  - boolean isRelease()
  - boolean isSnapshot()
  - java.lang.String toString()
  - void validate()
    
    Ensure that all components of the ApplicationID are valid (with their specs in terms of allowable characters.)
  - static void validateApp(java.lang.String appName)
  - static void validateBranch(java.lang.String branch)
  - void validateBranchIsNotHead()
  - static void validateStatus(java.lang.String status)
  - void validateStatusIsNotRelease()
  - static void validateTenant(java.lang.String tenant)
  - static void validateVersion(java.lang.String version)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class ApplicationID

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String DEFAULT_APP

public static final java.lang.String DEFAULT_STATUS

public static final java.lang.String DEFAULT_TENANT

public static final java.lang.String DEFAULT_VERSION

public static final java.lang.String HEAD

public static final java.lang.String TEST_BRANCH

public static final java.util.regex.Pattern VERSION_REGEX

private final java.lang.String app

private final java.lang.String branch

private final java.lang.String status

private final java.lang.String tenant

public static final ApplicationID testAppId

private final java.lang.String version

Constructor Detail

private ApplicationID()

ApplicationID(java.lang.String tenant, java.lang.String app, java.lang.String version, java.lang.String status, java.lang.String branch)

Method Detail

ApplicationID asBranch(java.lang.String bran)

ApplicationID asHead()

ApplicationID asRelease()

ApplicationID asSnapshot()

java.util.Map asType(java.lang.Class clazz)

ApplicationID asVersion(java.lang.String ver)

java.lang.String branchAgnosticCacheKey()

java.lang.String cacheKey()

java.lang.String cacheKey(java.lang.String name)

ApplicationID createNewSnapshotId(java.lang.String ver)

boolean equals(java.lang.Object o)

boolean equalsNotIncludingBranch(ApplicationID that)

java.lang.String getApp()

static ApplicationID getBootVersion(java.lang.String tenant, java.lang.String app)

java.lang.String getBranch()

java.lang.String getStatus()

java.lang.String getTenant()

java.lang.String getVersion()

long getVersionValue()

static long getVersionValue(java.lang.String version)

int hashCode()

boolean isHead()

boolean isRelease()

boolean isSnapshot()

java.lang.String toString()

void validate()

static void validateApp(java.lang.String appName)

static void validateBranch(java.lang.String branch)

void validateBranchIsNotHead()

static void validateStatus(java.lang.String status)

void validateStatusIsNotRelease()

static void validateTenant(java.lang.String tenant)

static void validateVersion(java.lang.String version)