com.aquafold.openapi.vcs

Interface AQWorkspace

public interface AQWorkspace

This interface is designed to provide common functionality for a version control workspace.

Method Summary

Modifier and Type	Method and Description
void	addVC(java.lang.Object files) This method adds a file or a folder in the local workspace and marks it for addition.
void	commit(java.lang.Object files, java.lang.String comment) This method commits specified file or files, adding unversioned files if necessary.
void	deleteVC(java.lang.Object files) This method deletes a file or a folder in the local workspace and marks it for deletion.
AQRevision[]	getHistory(java.lang.String filename) Returns the file's complete revision history.
AQRevision[]	getHistory(java.lang.String filename, java.lang.String startRevision, java.lang.String endRevision) Returns the change set between two revisions.
java.lang.String	getProvider() Returns provider type string.
AQRevision	getRevision(java.lang.String filename) Returns the file revision.
byte[]	getRevisionContents(java.lang.String filename, java.lang.Object revision) Returns the binary contents of the specified revision.
java.lang.String	getRevisionContentsAsString(java.lang.String filename, java.lang.Object revision, java.lang.String encoding) Returns the contents of the specified revision as text string.
boolean	isVerbose() Returns the current verbose flag.
void	setPassword(java.lang.Object password) Sets the password for subsequent operations.
void	setUsername(java.lang.Object username) Sets the user name for subsequent operations.
void	setVerbose(boolean verbose) Defines whether the output of version control operations (update, commit) will be displayed in the AquaScript console.
void	update(java.lang.Object files) This method updates a file or a folder to the HEAD revision.
void	update(java.lang.Object files, java.lang.String revision) This method updates selected file(s) to the specified revision, recursively.

Method Detail

setUsername

void setUsername(java.lang.Object username)

Sets the user name for subsequent operations.

Parameters:

username - A String or a AQOpaqueObject containing the user name.

setPassword

void setPassword(java.lang.Object password)

Sets the password for subsequent operations.

Parameters:

password - A String password or a AQOpaqueObject containing the password.

getProvider

java.lang.String getProvider()

Returns provider type string.

Returns:

the provider

setVerbose

void setVerbose(boolean verbose)

Defines whether the output of version control operations (update, commit) will be displayed in the AquaScript console. Default value = true.

Parameters:

verbose - turn option on/off

isVerbose

boolean isVerbose()

Returns the current verbose flag.

Returns:

TRUE if verbose

commit

void commit(java.lang.Object files,
            java.lang.String comment)
     throws java.lang.Exception

This method commits specified file or files, adding unversioned files if necessary.

Parameters:

files - A single file name (String), a single File, a list of files in the form of AQFileSet, or an array of filenames.

comment - Commit comment.

Throws:

java.lang.Exception - On error

update

void update(java.lang.Object files)
     throws java.lang.Exception

This method updates a file or a folder to the HEAD revision. If the specified path is a folder, this method updates the workspace recursively.

Parameters:

files - A single file name (String), a single File, a list of files in the form of AQFileSet, or an array of filenames.

Throws:

java.lang.Exception - On error

update

void update(java.lang.Object files,
            java.lang.String revision)
     throws java.lang.Exception

This method updates selected file(s) to the specified revision, recursively. If the specified path is a folder, this method updates the workspace recursively.

Parameters:

files - A single file name (String), a single File, a list of files in the form of AQFileSet, or an array of filenames.

revision - the revision

Throws:

java.lang.Exception - On error

deleteVC

void deleteVC(java.lang.Object files)
       throws java.lang.Exception

This method deletes a file or a folder in the local workspace and marks it for deletion. If the specified path is a folder, this method deletes the workspace folder recursively.

Parameters:

files - A single file name (String), a single File, a list of files in the form of AQFileSet, or an array of filenames.

Throws:

java.lang.Exception - On error

addVC

void addVC(java.lang.Object files)
    throws java.lang.Exception

This method adds a file or a folder in the local workspace and marks it for addition. If the specified path is a folder, this method adds the workspace folder recursively.

Parameters:

files - A single file name (String), a single File, a list of files in the form of AQFileSet, or an array of filenames.

Throws:

java.lang.Exception - On error

getRevision

AQRevision getRevision(java.lang.String filename)
                throws java.lang.Exception

Returns the file revision. This light-weight method does not typically provide additional information such as comments or affected paths. Please use getHistory(String, String, String) method when more detailed information is needed.

Parameters:

filename - Workspace file name.

Returns:

the revision

Throws:

java.lang.Exception - On error

getHistory

AQRevision[] getHistory(java.lang.String filename)
                 throws java.lang.Exception

Returns the file's complete revision history. Currently, CVS does not support this operation if invoked on a folder.

Parameters:

filename - Workspace file name.

Returns:

the revisions

Throws:

java.lang.Exception - On error

getHistory

AQRevision[] getHistory(java.lang.String filename,
                        java.lang.String startRevision,
                        java.lang.String endRevision)
                 throws java.lang.Exception

Returns the change set between two revisions. This is a more detailed variant of getHistory(String) where individual revision objects may contain additional information provided by the version control system, such as comments or affected paths.

Parameters:

filename - Workspace file name.

startRevision - Start revision number or tag.

endRevision - End revision number or tag.

Returns:

the revisions

Throws:

java.lang.Exception - On error

getRevisionContents

byte[] getRevisionContents(java.lang.String filename,
                           java.lang.Object revision)
                    throws java.lang.Exception

Returns the binary contents of the specified revision.

Parameters:

filename - Workspace file name.

revision - Revision string, an AQRevision object, or null for HEAD revision.

Returns:

the revision content

Throws:

java.lang.Exception - On error

getRevisionContentsAsString

java.lang.String getRevisionContentsAsString(java.lang.String filename,
                                             java.lang.Object revision,
                                             java.lang.String encoding)
                                      throws java.lang.Exception

Returns the contents of the specified revision as text string.

Parameters:

filename - Workspace file name.

revision - Revision string, an AQRevision object, or null for HEAD revision.

encoding - Character encoding

Returns:

the revision content

Throws:

java.lang.Exception - On error