| Methods Summary |
|---|
| protected com.starbase.starteam.View | createSnapshotView(com.starbase.starteam.View raw)Override of base-class abstract function creates an
appropriately configured view for checkouts - either
the current view or a view from this.label or the raw
view itself in the case of a revision label.
int labelID = getLabelID(raw);
// if a label has been supplied and it is a view label, use it
// to configure the view
if (this.isUsingViewLabel()) {
return new View(raw, ViewConfiguration.createFromLabel(labelID));
// if a label has been supplied and it is a revision label, use the raw
// the view as the snapshot
} else if (this.isUsingRevisionLabel()) {
return raw;
}
// if a date has been supplied use a view configured to the date.
View view = getViewConfiguredByDate(raw);
if (view != null) {
return view;
// otherwise, use this view configured as the tip.
} else {
return new View(raw, ViewConfiguration.createTip());
}
|
| private java.lang.String | describeCheckout(com.starbase.starteam.File remotefile, java.io.File localFile)provides a string showing from and to full paths for logging
StringBuffer sb = new StringBuffer();
sb.append(getFullRepositoryPath(remotefile))
.append(" --> ");
if (null == localFile) {
sb.append(remotefile.getFullName());
} else {
sb.append(localFile);
}
return sb.toString();
|
| private java.lang.String | describeCheckout(com.starbase.starteam.File remotefile)
return describeCheckout(remotefile, null);
|
| public boolean | getUseRepositoryTimeStamp()returns the value of the useRepositoryTimestamp member
return this.useRepositoryTimeStamp;
|
| protected void | logOperationDescription(com.starbase.starteam.Folder starteamrootFolder, java.io.File targetrootFolder)extenders should emit to the log an entry describing the parameters
that will be used by this operation.
log((this.isRecursive() ? "Recursive" : "Non-recursive")
+ " Checkout from: " + starteamrootFolder.getFolderHierarchy());
log(" Checking out to"
+ (null == getRootLocalFolder() ? "(default): " : ": ")
+ targetrootFolder.getAbsolutePath());
logLabel();
logAsOfDate();
logIncludes();
logExcludes();
if (this.lockStatus == Item.LockType.EXCLUSIVE) {
log(" Items will be checked out with Exclusive locks.");
} else if (this.lockStatus == Item.LockType.UNLOCKED) {
log(" Items will be checked out unlocked "
+ "(even if presently locked).");
} else {
log(" Items will be checked out with no change in lock status.");
}
log(" Items will be checked out with "
+ (this.useRepositoryTimeStamp ? "repository timestamps."
: "the current timestamp."));
log(" Items will be checked out "
+ (this.isForced() ? "regardless of" : "in accordance with")
+ " repository status.");
if (this.deleteUncontrolled) {
log(" Local items not found in the repository will be deleted.");
}
log(" Items will be checked out "
+ (this.convertEOL ? "using the local machine's EOL convention"
: "without changing the EOL convention used on the server"));
log(" Directories will be created"
+ (this.createDirs ? " wherever they exist in the repository, even if empty."
: " only where needed to check out files."));
|
| private void | processFile(com.starbase.starteam.File eachFile, java.io.File targetFolder)Processes (checks out) stFilesfiles from StarTeam folder.
String filename = eachFile.getName();
java.io.File localFile = new java.io.File(targetFolder, filename);
// If the file doesn't pass the include/exclude tests, skip it.
if (!shouldProcess(filename)) {
log("Excluding " + getFullRepositoryPath(eachFile),
Project.MSG_INFO);
return;
}
if (this.isUsingRevisionLabel()) {
if (!targetFolder.exists()) {
if (targetFolder.mkdirs()) {
log("Creating folder: " + targetFolder);
} else {
throw new BuildException(
"Failed to create local folder " + targetFolder);
}
}
boolean success = eachFile.checkoutByLabelID(
localFile,
getIDofLabelInUse(),
this.lockStatus,
!this.useRepositoryTimeStamp,
true,
false);
if (success) {
log("Checked out " + describeCheckout(eachFile, localFile));
}
} else {
boolean checkout = true;
// Just a note: StarTeam has a status for NEW which implies
// that there is an item on your local machine that is not
// in the repository. These are the items that show up as
// NOT IN VIEW in the Starteam GUI.
// One would think that we would want to perhaps checkin the
// NEW items (not in all cases! - Steve Cohen 15 Dec 2001)
// Unfortunately, the sdk doesn't really work, and we can't
// actually see anything with a status of NEW. That is why
// we can just check out everything here without worrying
// about losing anything.
int fileStatus = (eachFile.getStatus());
// We try to update the status once to give StarTeam
// another chance.
if (fileStatus == Status.MERGE
|| fileStatus == Status.UNKNOWN) {
eachFile.updateStatus(true, true);
fileStatus = (eachFile.getStatus());
}
log(eachFile.toString() + " has status of "
+ Status.name(fileStatus), Project.MSG_DEBUG);
switch (fileStatus) {
case Status.OUTOFDATE:
case Status.MISSING:
log("Checking out: " + describeCheckout(eachFile));
break;
default:
if (isForced() && fileStatus != Status.CURRENT) {
log("Forced checkout of "
+ describeCheckout(eachFile)
+ " over status " + Status.name(fileStatus));
} else {
log("Skipping: " + getFullRepositoryPath(eachFile)
+ " - status: " + Status.name(fileStatus));
checkout = false;
}
}
if (checkout) {
if (!targetFolder.exists()) {
if (targetFolder.mkdirs()) {
log("Creating folder: " + targetFolder);
} else {
throw new BuildException(
"Failed to create local folder " + targetFolder);
}
}
eachFile.checkout(this.lockStatus,
!this.useRepositoryTimeStamp, this.convertEOL, false);
}
}
|
| public void | setAsOfDate(java.lang.String asOfDateParam)List files, dates, and statuses as of this date; optional.
If not specified, the most recent version of each file will be listed.
_setAsOfDate(asOfDateParam);
|
| public void | setAsOfDateFormat(java.lang.String asOfDateFormat)Date Format with which asOfDate parameter to be parsed; optional.
Must be a SimpleDateFormat compatible string.
If not specified, and asOfDateParam is specified, parse will use ISO8601
datetime and date formats.
_setAsOfDateFormat(asOfDateFormat);
|
| public void | setConvertEOL(boolean value)Set whether or not files should be checked out using the
local machine's EOL convention.
Optional, defaults to true.
this.convertEOL = value;
|
| public void | setCreateWorkingDirs(boolean value)flag (defaults to true) to create all directories
that are in the Starteam repository even if they are empty.
this.createDirs = value;
|
| public void | setDeleteUncontrolled(boolean value)Whether or not all local files not in StarTeam should be deleted.
Optional, defaults to true.
this.deleteUncontrolled = value;
|
| public void | setLabel(java.lang.String label)Sets the label StarTeam is to use for checkout; defaults to the most recent file.
The label must exist in starteam or an exception will be thrown.
_setLabel(label);
|
| private void | setLockStatus(boolean v, int newStatus)
if (v) {
if (this.lockStatus == Item.LockType.UNCHANGED) {
this.lockStatus = newStatus;
} else if (this.lockStatus != newStatus) {
throw new BuildException(
"Error: cannot set locked and unlocked both true.");
}
}
|
| public void | setLocked(boolean v)Set to do a locked checkout; optional default is false.
setLockStatus(v, Item.LockType.EXCLUSIVE);
|
| public void | setUnlocked(boolean v)Set to do an unlocked checkout. Default is false;
setLockStatus(v, Item.LockType.UNLOCKED);
|
| public void | setUseRepositoryTimeStamp(boolean useRepositoryTimeStamp)sets the useRepositoryTimestmp member.
this.useRepositoryTimeStamp = useRepositoryTimeStamp;
|
| protected void | testPreconditions()Implements base-class abstract function to define tests for
any preconditons required by the task.
if (this.isUsingRevisionLabel() && this.createDirs) {
log("Ignoring createworkingdirs while using a revision label."
+ " Folders will be created only as needed.",
Project.MSG_WARN);
this.createDirs = false;
}
if (lockStatus != Item.LockType.UNCHANGED) {
boolean lockStatusBad = false;
if (null != getLabel()) {
log("Neither locked nor unlocked may be true"
+ " when checking out a labeled version.",
Project.MSG_ERR);
lockStatusBad = true;
} else if (null != getAsOfDate()) {
log("Neither locked nor unlocked may be true"
+ " when checking out by date.",
Project.MSG_ERR);
lockStatusBad = true;
}
if (lockStatusBad) {
throw new BuildException(
"Lock status may not be changed"
+ " when checking out a non-current version.");
}
}
if (null != getLabel() && null != getAsOfDate()) {
throw new BuildException(
"Both label and asOfDate specified. "
+ "Unable to process request.");
}
|
| protected void | visit(com.starbase.starteam.Folder starteamFolder, java.io.File targetFolder)Implements base-class abstract function to perform the checkout
operation on the files in each folder of the tree.
try {
if (null != getRootLocalFolder()) {
starteamFolder.setAlternatePathFragment(
targetFolder.getAbsolutePath());
}
if (!targetFolder.exists()) {
if (!this.isUsingRevisionLabel()) {
if (this.createDirs) {
if (targetFolder.mkdirs()) {
log("Creating folder: " + targetFolder);
} else {
throw new BuildException(
"Failed to create local folder " + targetFolder);
}
}
}
}
Folder[] foldersList = starteamFolder.getSubFolders();
Item[] filesList = starteamFolder.getItems(getTypeNames().FILE);
if (this.isUsingRevisionLabel()) {
// prune away any files not belonging to the revision label
// this is one ugly API from Starteam SDK
Hashtable labelItems = new Hashtable(filesList.length);
int s = filesList.length;
int[] ids = new int[s];
for (int i = 0; i < s; i++) {
ids[i] = filesList[i].getItemID();
labelItems.put(new Integer(ids[i]), new Integer(i));
}
int[] foundIds = getLabelInUse().getLabeledItemIDs(ids);
s = foundIds.length;
Item[] labeledFiles = new Item[s];
for (int i = 0; i < s; i++) {
Integer id = new Integer(foundIds[i]);
labeledFiles[i] =
filesList[((Integer) labelItems.get(id)).intValue()];
}
filesList = labeledFiles;
}
// note, it's important to scan the items BEFORE we make the
// Unmatched file map because that creates a bunch of NEW
// folders and files (unattached to repository) and we
// don't want to include those in our traversal.
UnmatchedFileMap ufm =
new CheckoutMap().
init(targetFolder.getAbsoluteFile(), starteamFolder);
for (int i = 0; i < foldersList.length; i++) {
Folder stFolder = foldersList[i];
java.io.File subfolder =
new java.io.File(targetFolder, stFolder.getName());
ufm.removeControlledItem(subfolder);
if (isRecursive()) {
visit(stFolder, subfolder);
}
}
for (int i = 0; i < filesList.length; i++) {
com.starbase.starteam.File stFile =
(com.starbase.starteam.File) filesList[i];
processFile(stFile, targetFolder);
ufm.removeControlledItem(
new java.io.File(targetFolder, stFile.getName()));
}
if (this.deleteUncontrolled) {
ufm.processUncontrolledItems();
}
} catch (IOException e) {
throw new BuildException(e);
}
|
