public interface AQWorkspace
Modifier and Type | Method and Description |
---|---|
void |
addVC(Object files)
This method adds a file or a folder in the local workspace and marks it for addition.
|
void |
commit(Object files,
String comment)
This method commits specified file or files, adding unversioned files if necessary.
|
void |
deleteVC(Object files)
This method deletes a file or a folder in the local workspace and marks it for deletion.
|
AQRevision[] |
getHistory(String filename)
Returns the file's complete revision history.
|
AQRevision[] |
getHistory(String filename,
String startRevision,
String endRevision)
Returns the change set between two revisions.
|
String |
getProvider()
Returns provider type string.
|
AQRevision |
getRevision(String filename)
Returns the file revision.
|
byte[] |
getRevisionContents(String filename,
Object revision)
Returns the binary contents of the specified revision.
|
String |
getRevisionContentsAsString(String filename,
Object revision,
String encoding)
Returns the contents of the specified revision as text string.
|
boolean |
isVerbose()
Returns the current verbose flag.
|
void |
setPassword(Object password)
Sets the password for subsequent operations.
|
void |
setUsername(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(Object files)
This method updates a file or a folder to the HEAD revision.
|
void |
update(Object files,
String revision)
This method updates selected file(s) to the specified revision, recursively.
|
void setUsername(Object username)
username
- A String
or a AQOpaqueObject
containing the user name.void setPassword(Object password)
password
- A String
password or a AQOpaqueObject
containing the password.String getProvider()
void setVerbose(boolean verbose)
verbose
- turn option on/offboolean isVerbose()
void commit(Object files, String comment) throws Exception
void update(Object files) throws Exception
void update(Object files, String revision) throws Exception
void deleteVC(Object files) throws Exception
void addVC(Object files) throws Exception
AQRevision getRevision(String filename) throws Exception
getHistory(String, String, String)
method
when more detailed information is needed.filename
- Workspace file name.Exception
- On errorAQRevision[] getHistory(String filename) throws Exception
filename
- Workspace file name.Exception
- On errorAQRevision[] getHistory(String filename, String startRevision, String endRevision) throws Exception
getHistory(String)
where individual revision objects may contain additional information
provided by the version control system, such as comments or affected paths.filename
- Workspace file name.startRevision
- Start revision number or tag.endRevision
- End revision number or tag.Exception
- On errorbyte[] getRevisionContents(String filename, Object revision) throws Exception
filename
- Workspace file name.revision
- Revision string, an AQRevision
object, or null for HEAD revision.Exception
- On errorString getRevisionContentsAsString(String filename, Object revision, String encoding) throws Exception
filename
- Workspace file name.revision
- Revision string, an AQRevision
object, or null for HEAD revision.encoding
- Character encodingException
- On error
Copyright © 2017 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.