org.conqat.engine.index.shared

Class CommitDescriptor

java.lang.Object

org.conqat.engine.index.shared.CommitDescriptor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CommitDescriptor>

Direct Known Subclasses:

ParentedCommitDescriptor

public class CommitDescriptor
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<CommitDescriptor>

Immutable class describing a single commit by its branch name and a timestamp. The timestamp must be unique within the branch. They are comparable by timestamp, where equal timestamps are resolved alphabetically by the branch name. This class is used for communication with IDE clients (via the org.conqat.engine.service.shared.client.IdeServiceClient), so special care has to be taken when changing its signature!

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<CommitDescriptor>	BY_TIMESTAMP_COMPARATOR A comparator for comparison by timestamps.
static java.lang.String	HEAD_TIMESTAMP Special value to indicate the HEAD of a branch.
static byte[]	SEPARATOR The separator used between branch name and timestamp in toBranchTimestampKeyWithSeparator().

Constructor Summary

Constructors

Constructor and Description
CommitDescriptor(CommitDescriptor other)
CommitDescriptor(java.lang.String branchName, long timestamp) Constructor.

Method Summary

Modifier and Type	Method and Description
CommitDescriptor	cloneWithDecrementedTimestamp() Create a copy of this commit descriptor with timestamp - 1.
CommitDescriptor	cloneWithIncrementedTimestamp() Create a copy of this commit descriptor with timestamp + 1.
int	compareTo(CommitDescriptor other)
static CommitDescriptor	createUnbranchedDescriptor(long timestamp) Create a CommitDescriptor without branch specification.
boolean	equals(java.lang.Object obj)
static CommitDescriptor	fromBranchTimestampKey(byte[] key) Parses a branchN+timestamp key/byte[] representation.
static CommitDescriptor	fromJson(java.lang.String json) Reads a CommitDescriptor from a JSON string.
static CommitDescriptor	fromStringRepresentation(java.lang.String representation) Parses a commit descriptor from its toString() representation.
static CommitDescriptor	fromTimestampBranchKey(byte[] key) Parses a timestamp+branchName key/byte[] representation.
java.lang.String	getBranchName()
long	getTimestamp()
int	hashCode()
boolean	isHeadCommit() Returns whether this commit is a head timestamp
boolean	isUnbranched() Return true if no branch is specified.
static CommitDescriptor	latestOnBranch(java.lang.String branchName) Creates a commit descriptor for the latest revision on a branch
byte[]	toBranchTimestampKey() Returns a branchName+timestamp key/byte[] representation.
byte[]	toBranchTimestampKeyWithSeparator() Returns a branchName+timestamp key/byte[] representation with SEPARATOR in between.
java.lang.String	toEncodedPathParam() Returns a url-encoded format used for service calls ("branch:timestamp", or "timestamp" if no branch is specified).
java.lang.String	toEncodedQueryParam() Returns a url-encoded format used for service calls ("branch:timestamp", or "timestamp" if no branch is specified).
java.lang.String	toJson() Converts this to a JSON representation.
java.lang.String	toServiceCallFormat() Returns a format used for service calls ("branch:timestamp", or "timestamp" if no branch is specified).
java.lang.String	toString()
byte[]	toTimestampBranchKey() Returns a timestamp+branchName key/byte[] representation.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final byte[] SEPARATOR

The separator used between branch name and timestamp in toBranchTimestampKeyWithSeparator().

HEAD_TIMESTAMP

public static final java.lang.String HEAD_TIMESTAMP

Special value to indicate the HEAD of a branch.

See Also:

Constant Field Values

BY_TIMESTAMP_COMPARATOR

public static final java.util.Comparator<CommitDescriptor> BY_TIMESTAMP_COMPARATOR

A comparator for comparison by timestamps. Null commits are ordered to the front. If there are commits with identical timestamps, we order them by comparing the branch names to guarantee a stable order. This should only happen in special cases since teamscale ensures that no timestamp is given to two commits.

Constructor Detail

CommitDescriptor

public CommitDescriptor(java.lang.String branchName,
                        long timestamp)

Constructor.
use createUnbranchedDescriptor(long) to create a unbranched commit descriptor.

CommitDescriptor

public CommitDescriptor(CommitDescriptor other)

Method Detail

createUnbranchedDescriptor

public static CommitDescriptor createUnbranchedDescriptor(long timestamp)

Create a CommitDescriptor without branch specification.
Should be used with caution.

cloneWithDecrementedTimestamp

public CommitDescriptor cloneWithDecrementedTimestamp()

Create a copy of this commit descriptor with timestamp - 1. Using this CommitDescriptor to store a new commit might overwrite an existing commit if the timestamp is already used.

cloneWithIncrementedTimestamp

public CommitDescriptor cloneWithIncrementedTimestamp()

Create a copy of this commit descriptor with timestamp + 1. Using this CommitDescriptor to store a new commit might overwrite an existing commit if the timestamp is already used.

getBranchName

public java.lang.String getBranchName()

See Also:

branchName

isUnbranched

public boolean isUnbranched()

Return true if no branch is specified.

isHeadCommit

public boolean isHeadCommit()

Returns whether this commit is a head timestamp

getTimestamp

public long getTimestamp()

See Also:

timestamp

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(CommitDescriptor other)

Specified by:

compareTo in interface java.lang.Comparable<CommitDescriptor>

toJson

public java.lang.String toJson()

Converts this to a JSON representation.

fromJson

public static CommitDescriptor fromJson(java.lang.String json)
                                 throws ConQATException

Reads a CommitDescriptor from a JSON string.

Throws:

ConQATException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toTimestampBranchKey

public byte[] toTimestampBranchKey()

Returns a timestamp+branchName key/byte[] representation.

fromStringRepresentation

public static CommitDescriptor fromStringRepresentation(java.lang.String representation)

Parses a commit descriptor from its toString() representation.

fromTimestampBranchKey

public static CommitDescriptor fromTimestampBranchKey(byte[] key)

Parses a timestamp+branchName key/byte[] representation.

toBranchTimestampKey

public byte[] toBranchTimestampKey()

Returns a branchName+timestamp key/byte[] representation. NOTE: This is *DANGEROUS* since keys generated with this function may cause unwanted branch names (prefixes of wanted branch names) to be returned from store scans (TS-16367). To protect against this, use toBranchTimestampKeyWithSeparator().

toBranchTimestampKeyWithSeparator

public byte[] toBranchTimestampKeyWithSeparator()

Returns a branchName+timestamp key/byte[] representation with SEPARATOR in between.

fromBranchTimestampKey

public static CommitDescriptor fromBranchTimestampKey(byte[] key)

Parses a branchN+timestamp key/byte[] representation.

latestOnBranch

public static CommitDescriptor latestOnBranch(java.lang.String branchName)

Creates a commit descriptor for the latest revision on a branch

toServiceCallFormat

public java.lang.String toServiceCallFormat()

Returns a format used for service calls ("branch:timestamp", or "timestamp" if no branch is specified).

See Also:

toEncodedPathParam(), toEncodedQueryParam()

toEncodedQueryParam

public java.lang.String toEncodedQueryParam()

Returns a url-encoded format used for service calls ("branch:timestamp", or "timestamp" if no branch is specified). The format is suitable for calls that include the commit as query parameter or in the arguments of the navigation hash.

toEncodedPathParam

public java.lang.String toEncodedPathParam()

Returns a url-encoded format used for service calls ("branch:timestamp", or "timestamp" if no branch is specified). The format is suitable for calls that include the commit as path parameter.