net.praqma.clearcase.ucm.entities

Class Version

java.lang.Object

net.praqma.clearcase.Cool

net.praqma.clearcase.ClearCase

net.praqma.clearcase.ucm.entities.UCMEntity

net.praqma.clearcase.ucm.entities.Version

All Implemented Interfaces:

Serializable, Comparable<Version>

public class Version
extends UCMEntity
implements Comparable<Version>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Version.Status

Nested classes/interfaces inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

UCMEntity.Kind, UCMEntity.LabelStatus

Field Summary

Fields inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

date, dateFormatter, fqname, kind, labelStatus, loaded, mastership, pattern_std_fqname, pattern_tag_fqname, pattern_version_fqname, pvob, rx_ccdef_allowed, rx_ccdef_cc_name, rx_ccdef_filename, rx_ccdef_vob, shortname, user, vob

Fields inherited from class net.praqma.clearcase.ClearCase

rx_attr_find

Fields inherited from class net.praqma.clearcase.Cool

delim, filesep, filesepChar, linesep, qfs, qfsor

Method Summary

Modifier and Type	Method and Description
static void	addToSourceControl(File file, boolean mkdir, File view)
static void	addToSourceControl(File file, File viewContext, String comment, boolean checkIn) Add a File in ClearCase
String	blame()
void	checkIn()
void	checkIn(boolean identical)
static void	checkIn(File file, boolean identical, File viewContext)
static void	checkIn(File file, boolean identical, File viewContext, String comment)
void	checkInIdentical()
void	checkOut()
static void	checkOut(File file, File context)
static void	checkOut(File file, File context, String comment)
int	compareTo(Version other)
static Version	create(File file, boolean mkdir, SnapshotView view)
static Version	create(File file, File viewContext) Create a ClearCase element from a File, that will be checked in
static Version	get(String name)
Activity	getActivity()
static Activity	getActivity(Version version) Get the Activity for a Version.
static List<Activity>	getBaselineDiff(Diffable d1, Diffable d2, boolean merge, File viewContext) ONLY USED IN TEST
static List<Activity>	getBaselineDiff(Diffable d1, Diffable d2, boolean merge, File viewContext, boolean versions) ONLY USED IN TEST Activity based baseline diff method
String	getBranch() Get the fully qualified branch name.
List<Branch>	getBranches()
static List<Branch>	getBranches(String branchSpecifier)
static ChangeSet2	getChangeset(Diffable e1, Diffable e2, boolean merge, File viewContext)
String	getElementObjectId()
File	getFile()
String	getQualifiedFilename() Get the qualified filename, without any branch and version syntax.
Integer	getRevision()
String	getSFile()
Version.Status	getStatus()
Branch	getUltimateBranch()
static List<File>	getUncheckedIn(File viewContext)
static Version	getUnextendedVersion(File file, File viewroot) Given a file(File) and a view root(File) return the Version from ClearCase
String	getVersion()
static Version	getVersion(String version)
File	getView()
boolean	hijack()
protected void	initialize() initialise the UCM entity.
static boolean	isCheckedout(File element, File viewContext) An exception safe way to determine whether the file is checked out
boolean	isDirectory()
boolean	isFile()
boolean	isMoved()
static boolean	isUnderSourceControl(File element, File viewContext) An exception safe way to determine whether the file is under source control
Version	load() Default load functionality for the entity.
static void	makeDirectory(File directory, File view, String comment) Make a directory in ClearCase
static void	makeElement(File file, File view, String comment) Make an element in ClearCase
void	moveFile(File destination)
static void	moveFile(File file, File destination, File context)
static void	printCheckouts(File viewContext)
static void	recursiveCheckin(File path)
void	removeName()
static void	removeName(File file, File context)
void	removeVersion()
static void	removeVersion(File file, File viewContext) Remove a Version in ClearCase
void	setActivity(Activity activity)
void	setFile(File file)
void	setOldFile(File oldFile)
void	setSFile(String sfile)
void	setStatus(Version.Status status)
void	setView(File view)
void	setView(SnapshotView view)
String	stringify() Returns a string representation of the entity object
void	uncheckout()
void	uncheckout(boolean keep)
static void	uncheckout(File file, boolean keep, File viewContext)

Methods inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

autoLoad, changeOwnership, changeOwnership, equals, getargComment, getargIn, getComment, getDate, getEntity, getEntity, getEntitySelector, getFqname, getFullyQualifiedName, getHyperlinks, getKind, getLabelStatus, getLabelStatusFromString, getMastership, getNamePart, getNormalizedName, getObjectId, getObjectId, getPVob, getShortname, getTag, getUser, hashCode, isCreated, isLoaded, loadDate, setComment, setCreated, setDate, setDate, setFqname, setKind, setLabelStatusFromString, setMastership, setUser, toString

Methods inherited from class net.praqma.clearcase.ClearCase

createSimpleAttributeType, getAttribute, getAttributes, getAttributes, getAttributes, setAttribute, setAttribute

Methods inherited from class net.praqma.clearcase.Cool

getOS

Methods inherited from class java.lang.Object

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

Method Detail

initialize

protected void initialize()

Description copied from class: UCMEntity

initialise the UCM entity. This is a base implementation, storing the short name and PVob.

Overrides:

initialize in class UCMEntity

getQualifiedFilename

public String getQualifiedFilename()

Get the qualified filename, without any branch and version syntax.

Returns:

Fully qualified file name

getBranches

public static List<Branch> getBranches(String branchSpecifier)

getBranches

public List<Branch> getBranches()

getUltimateBranch

public Branch getUltimateBranch()

hijack

public boolean hijack()

getUnextendedVersion

public static Version getUnextendedVersion(File file,
                                           File viewroot)
                                    throws IOException,
                                           CleartoolException,
                                           UnableToLoadEntityException,
                                           UCMEntityNotFoundException,
                                           UnableToInitializeEntityException

Given a file(File) and a view root(File) return the Version from ClearCase

Parameters:

file - The file to get the version from

viewroot - The view root

Returns:

An unextended Version

Throws:

IOException - Thrown on file/io errors

CleartoolException - Thrown on ClearCase error

UnableToLoadEntityException - Thrown on ClearCase error

UCMEntityNotFoundException - Thrown on ClearCase error

UnableToInitializeEntityException - Thrown on ClearCase error

blame

public String blame()
             throws UCMEntityNotFoundException,
                    UnableToCreateEntityException,
                    UnableToGetEntityException,
                    UnableToLoadEntityException

Throws:

UCMEntityNotFoundException

UnableToCreateEntityException

UnableToGetEntityException

UnableToLoadEntityException

getVersion

public String getVersion()
                  throws UnableToLoadEntityException

Throws:

UnableToLoadEntityException

getBranch

public String getBranch()

Get the fully qualified branch name.

Returns:

Fully qualified branch name

load

public Version load()
             throws UnableToLoadEntityException

Description copied from class: UCMEntity

Default load functionality for the entity. Every UCM entity should implement this method itself.

Overrides:

load in class UCMEntity

Returns:

The current UCMEntity

Throws:

UnableToLoadEntityException - Thrown when ClearCase reports errors

getActivity

public static Activity getActivity(Version version)
                            throws CleartoolException,
                                   UnableToInitializeEntityException

Get the Activity for a Version. In base ClearCase the Activity object does not exist, it must therefore be allowed to return null. See FB case 9988.

Parameters:

version - Version

Returns:

An Activity

Throws:

CleartoolException - Thrown on ClearCase error

UnableToInitializeEntityException - Thrown on ClearCase error

getActivity

public Activity getActivity()

setActivity

public void setActivity(Activity activity)

create

public static Version create(File file,
                             boolean mkdir,
                             SnapshotView view)
                      throws CleartoolException,
                             IOException,
                             UnableToCreateEntityException,
                             UCMEntityNotFoundException,
                             UnableToGetEntityException,
                             UnableToLoadEntityException,
                             UnableToInitializeEntityException

Throws:

CleartoolException

IOException

UnableToCreateEntityException

UCMEntityNotFoundException

UnableToGetEntityException

UnableToLoadEntityException

UnableToInitializeEntityException

create

public static Version create(File file,
                             File viewContext)
                      throws ClearCaseException,
                             IOException

Create a ClearCase element from a File, that will be checked in

Parameters:

file - - The relative file

viewContext - - The view root

Returns:

The created Version

Throws:

ClearCaseException - Thrown on ClearCase error

IOException - Thrown when the file does not exits, cannot be created or other non-clearcase related error

makeElement

public static void makeElement(File file,
                               File view,
                               String comment)
                        throws CleartoolException

Make an element in ClearCase

Parameters:

file - File

view - Current view

comment - Comment

Throws:

CleartoolException - Thrown on ClearCase error

makeDirectory

public static void makeDirectory(File directory,
                                 File view,
                                 String comment)
                          throws CleartoolException

Make a directory in ClearCase

Parameters:

directory - The directory to make

view - The current view

comment - Comment

Throws:

CleartoolException - Thrown on ClearCase error

addToSourceControl

public static void addToSourceControl(File file,
                                      File viewContext,
                                      String comment,
                                      boolean checkIn)
                               throws CleartoolException

Add a File in ClearCase

Parameters:

file - File

viewContext - Current view

comment - Check in comment

checkIn - Check in new element

Throws:

CleartoolException - Thrown on ClearCase error

addToSourceControl

public static void addToSourceControl(File file,
                                      boolean mkdir,
                                      File view)
                               throws CleartoolException

Throws:

CleartoolException

checkIn

public void checkIn()
             throws CleartoolException

Throws:

CleartoolException

checkIn

public static void checkIn(File file,
                           boolean identical,
                           File viewContext)
                    throws CleartoolException

Throws:

CleartoolException

checkIn

public static void checkIn(File file,
                           boolean identical,
                           File viewContext,
                           String comment)
                    throws CleartoolException

Throws:

CleartoolException

checkIn

public void checkIn(boolean identical)
             throws CleartoolException

Throws:

CleartoolException

checkInIdentical

public void checkInIdentical()
                      throws CleartoolException

Throws:

CleartoolException

checkOut

public void checkOut()
              throws CleartoolException

Throws:

CleartoolException

checkOut

public static void checkOut(File file,
                            File context)
                     throws CleartoolException

Throws:

CleartoolException

checkOut

public static void checkOut(File file,
                            File context,
                            String comment)
                     throws CleartoolException

Throws:

CleartoolException

removeVersion

public void removeVersion()
                   throws CleartoolException

Throws:

CleartoolException

removeVersion

public static void removeVersion(File file,
                                 File viewContext)
                          throws CleartoolException

Remove a Version in ClearCase

Parameters:

file - The file to remove a version from

viewContext - Current working view

Throws:

CleartoolException - Thrown on ClearCase error

removeName

public void removeName()
                throws CleartoolException

Throws:

CleartoolException

removeName

public static void removeName(File file,
                              File context)
                       throws CleartoolException

Throws:

CleartoolException

moveFile

public static void moveFile(File file,
                            File destination,
                            File context)
                     throws CleartoolException

Throws:

CleartoolException

moveFile

public void moveFile(File destination)
              throws CleartoolException

Throws:

CleartoolException

uncheckout

public void uncheckout()
                throws CleartoolException

Throws:

CleartoolException

uncheckout

public void uncheckout(boolean keep)
                throws CleartoolException

Throws:

CleartoolException

uncheckout

public static void uncheckout(File file,
                              boolean keep,
                              File viewContext)
                       throws CleartoolException

Throws:

CleartoolException

recursiveCheckin

public static void recursiveCheckin(File path)
                             throws CleartoolException

Throws:

CleartoolException

setView

public void setView(SnapshotView view)

setView

public void setView(File view)

getView

public File getView()

setSFile

public void setSFile(String sfile)

getSFile

public String getSFile()

setFile

public void setFile(File file)

getFile

public File getFile()

setStatus

public void setStatus(Version.Status status)

getStatus

public Version.Status getStatus()

getRevision

public Integer getRevision()

getUncheckedIn

public static List<File> getUncheckedIn(File viewContext)
                                 throws CleartoolException

Throws:

CleartoolException

isDirectory

public boolean isDirectory()
                    throws UnableToLoadEntityException

Throws:

UnableToLoadEntityException

isFile

public boolean isFile()
               throws UnableToLoadEntityException

Throws:

UnableToLoadEntityException

isUnderSourceControl

public static boolean isUnderSourceControl(File element,
                                           File viewContext)
                                    throws CleartoolException

An exception safe way to determine whether the file is under source control

Parameters:

element - The File to be checked

viewContext - The view context as a File path

Returns:

True if the File element is under source control

Throws:

CleartoolException - Thrown on ClearCase error

isCheckedout

public static boolean isCheckedout(File element,
                                   File viewContext)
                            throws CleartoolException

An exception safe way to determine whether the file is checked out

Parameters:

element - The File to be checked

viewContext - The view context as a File path

Returns:

True if the File element is checked out

Throws:

CleartoolException - Thrown on ClearCase error

setOldFile

public void setOldFile(File oldFile)

isMoved

public boolean isMoved()

stringify

public String stringify()

Description copied from class: UCMEntity

Returns a string representation of the entity object

Overrides:

stringify in class UCMEntity

Returns:

A String

getChangeset

public static ChangeSet2 getChangeset(Diffable e1,
                                      Diffable e2,
                                      boolean merge,
                                      File viewContext)
                               throws CleartoolException,
                                      UnableToInitializeEntityException

Throws:

CleartoolException

UnableToInitializeEntityException

getBaselineDiff

public static List<Activity> getBaselineDiff(Diffable d1,
                                             Diffable d2,
                                             boolean merge,
                                             File viewContext)
                                      throws CleartoolException,
                                             UnableToLoadEntityException,
                                             UCMEntityNotFoundException,
                                             UnableToInitializeEntityException

ONLY USED IN TEST

Parameters:

d1 - d1

d2 - d2

merge - merge

viewContext - viewContext

Returns:

list of activity

Throws:

CleartoolException - Thrown on ClearCase error

UnableToLoadEntityException - Thrown on ClearCase error

UCMEntityNotFoundException - Thrown on ClearCase error

UnableToInitializeEntityException - Thrown on ClearCase error

getBaselineDiff

public static List<Activity> getBaselineDiff(Diffable d1,
                                             Diffable d2,
                                             boolean merge,
                                             File viewContext,
                                             boolean versions)
                                      throws CleartoolException,
                                             UnableToLoadEntityException,
                                             UCMEntityNotFoundException,
                                             UnableToInitializeEntityException

ONLY USED IN TEST Activity based baseline diff method

Parameters:

d1 - d1

d2 - d2

merge - merge

viewContext - viewContext

versions - version

Returns:

List of activities

Throws:

CleartoolException - Thrown on ClearCase error

UnableToLoadEntityException - Thrown on ClearCase error

UCMEntityNotFoundException - Thrown on ClearCase error

UnableToInitializeEntityException - Thrown on ClearCase error

compareTo

public int compareTo(Version other)

Specified by:

compareTo in interface Comparable<Version>

get

public static Version get(String name)
                   throws UnableToInitializeEntityException

Throws:

UnableToInitializeEntityException

printCheckouts

public static void printCheckouts(File viewContext)

getVersion

public static Version getVersion(String version)
                          throws UnableToInitializeEntityException

Throws:

UnableToInitializeEntityException

getElementObjectId

public String getElementObjectId()
                          throws CleartoolException

Throws:

CleartoolException