public interface AQWorkspace
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.
|
void setUsername(java.lang.Object username)
username
- A String
or a AQOpaqueObject
containing the user name.void setPassword(java.lang.Object password)
password
- A String
password or a AQOpaqueObject
containing the password.java.lang.String getProvider()
void setVerbose(boolean verbose)
verbose
- turn option on/offboolean isVerbose()
void commit(java.lang.Object files, java.lang.String comment) throws java.lang.Exception
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.java.lang.Exception
- On errorvoid update(java.lang.Object files) throws java.lang.Exception
files
- A single file name (String
), a single File
,
a list of files in the form of AQFileSet
, or an
array of filenames.java.lang.Exception
- On errorvoid update(java.lang.Object files, java.lang.String revision) throws java.lang.Exception
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 revisionjava.lang.Exception
- On errorvoid deleteVC(java.lang.Object files) throws java.lang.Exception
files
- A single file name (String
), a single File
,
a list of files in the form of AQFileSet
, or an
array of filenames.java.lang.Exception
- On errorvoid addVC(java.lang.Object files) throws java.lang.Exception
files
- A single file name (String
), a single File
,
a list of files in the form of AQFileSet
, or an
array of filenames.java.lang.Exception
- On errorAQRevision getRevision(java.lang.String filename) throws java.lang.Exception
getHistory(String, String, String)
method
when more detailed information is needed.filename
- Workspace file name.java.lang.Exception
- On errorAQRevision[] getHistory(java.lang.String filename) throws java.lang.Exception
filename
- Workspace file name.java.lang.Exception
- On errorAQRevision[] getHistory(java.lang.String filename, java.lang.String startRevision, java.lang.String endRevision) throws java.lang.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.java.lang.Exception
- On errorbyte[] getRevisionContents(java.lang.String filename, java.lang.Object revision) throws java.lang.Exception
filename
- Workspace file name.revision
- Revision string, an AQRevision
object, or null for HEAD revision.java.lang.Exception
- On errorjava.lang.String getRevisionContentsAsString(java.lang.String filename, java.lang.Object revision, java.lang.String encoding) throws java.lang.Exception
filename
- Workspace file name.revision
- Revision string, an AQRevision
object, or null for HEAD revision.encoding
- Character encodingjava.lang.Exception
- On error
Copyright © 2017 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.