com.aquafold.openapi.vcs

Interface AQGit

public interface AQGit

An interface to GIT distributed revision control system.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.Object files) Adds file or files to the list of files staged for the next commit.
void	add(java.lang.String filePattern, boolean update) Adds file or files to the list of files staged for the next commit.
void	addRemote(java.lang.String name, java.lang.String url) Add a remote.
void	applyStash(java.lang.String ref) Apply a stashed commit on top of the current working tree.
void	checkout(java.lang.String name) Checkout a branch
void	cherryPick(java.lang.Object revision) Integrates an individual commit into the current branch.
java.lang.String[]	clean(java.lang.Object files, boolean dryRun) Remove untracked files from the working tree.
void	clone(java.lang.String folder, java.lang.String url, java.lang.String branch) Clones a repository into a new directory.
void	commit(java.lang.Object files, java.lang.Object username, java.lang.Object email, java.lang.String comment) This method commits changes in the specified file or folder.
void	commit(java.lang.Object username, java.lang.Object email, java.lang.String comment) This method records changes to the repository.
void	createBranch(java.lang.String name, java.lang.String ref) Create a local branch.
void	createStash(java.lang.Object username, java.lang.Object email, java.lang.String indexMessage, java.lang.String workingMessage) Stash all current changes and return working tree to a clean state.
void	deleteBranch(java.lang.String... names) Delete one or more branches.
void	deleteTag(java.lang.String... tags) Delete one or more tags.
void	dropStash(int stashRef) Delete a stashed commit.
void	fetch() Downloads objects and refs from the default remote 'origin'.
void	fetch(java.lang.String remote) Downloads objects and refs from the specified remote repository.
AQRevision[]	getHistory(java.lang.String filename) Returns the file's complete revision history.
AQRevision[]	getHistory(java.lang.String filename, int count) Returns the file's revision history.
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.
void	init(java.lang.String folder, boolean bare) Creates an empty git repository or reinitialize an existing one.
java.lang.String[]	listBranch() Obtain a list of branches
java.lang.String[]	listRemote() List remotes.
AQRevision[]	listStash() Return a list of stash commits
java.lang.String[]	listTag() Obtain a list of tags.
AQRevision[]	log(java.lang.Object start, int count) Obtain the log.
void	merge(java.lang.Object revision) Performs a very basic merge operation, which allows only one argument.
void	pull() Incorporates changes from a remote repository into the current branch.
void	push() Push new branches and data to a remote repository.
void	rebase(java.lang.Object upstream) The Git rebase command.
void	rebaseAbort() Abort the rebase process.
void	rebaseContinue() Continue the rebase process.
void	rebaseSkip() Skip the rebase process.
void	removeRemote(java.lang.String name) Remove a remote.
void	renameBranch(java.lang.String oldName, java.lang.String newName) Rename a branch
void	reset(java.lang.String ref, java.lang.String mode, java.lang.String filename) Undo changes and commits.
void	revert(java.lang.Object commits) Create a commit with the reverse patch to cancel it out.
void	setCredentials(java.lang.String url, java.lang.String identity, java.lang.String password) Register a credentials provider.
void	setVerbose(boolean verbose) Sets the amount of diagnostic messages sent to the debugger console.
void	setWorkspace(java.lang.String path) Sets workspace folder.
AQGitStatus	status() Obtain the Git repo status.
void	tag(java.lang.Object revision, java.lang.String name, java.lang.Object username, java.lang.Object email, java.lang.String comment) Create a tag.
void	trackRemote(java.lang.String localBranch, java.lang.String remoteBranch) Track remote branch.

Method Detail

setVerbose

void setVerbose(boolean verbose)

Sets the amount of diagnostic messages sent to the debugger console.

Parameters:

verbose - (Default value - true).

setWorkspace

void setWorkspace(java.lang.String path)

Sets workspace folder.

Parameters:

path - Workspace path.

setCredentials

void setCredentials(java.lang.String url,
                    java.lang.String identity,
                    java.lang.String password)
             throws java.lang.Exception

Register a credentials provider. Call this method before clone, fetch, pull and push to connect to remote repositories that require authentication.

For public key authentication, Setting identity to null loads known hosts and private keys from $HOME/.ssh.

Parameters:

url - the url, protocol://host/path/to/repo.git

identity - username or public key file

password - password or passphrase

Throws:

java.lang.Exception - On error

commit

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

This method commits changes in the specified file or folder.

Parameters:

files - A file name, or a javascript array of file names

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

email - A String or a AQOpaqueObject containing the user email address.

comment - the comment

Throws:

java.lang.Exception - On error

commit

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

This method records changes to the repository.

Parameters:

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

email - A String or a AQOpaqueObject containing the user email address.

comment - the comment

Throws:

java.lang.Exception - On error

add

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

Adds file or files to the list of files staged for the next commit.

Parameters:

files - A file name, or a javascript array of file names

Throws:

java.lang.Exception - On error

add

void add(java.lang.String filePattern,
         boolean update)
  throws java.lang.Exception

Adds file or files to the list of files staged for the next commit.

Parameters:

filePattern - File to add content from. Also a leading directory name (e.g. dir to add dir/file1 and dir/file2) can be given to add all files in the directory, recursively. Fileglobs (e.g. *.c) are not yet supported.

update - If set to true, the command only matches filepattern against already tracked files in the index rather than the working tree. That means that it will never stage new files, but that it will stage modified new contents of tracked files and that it will remove files from the index if the corresponding files in the working tree have been removed. In contrast to the git command line a filepattern must exist also if update is set to true as there is no concept of a working directory here.

Throws:

java.lang.Exception - On error

getRevision

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

Returns the file revision.

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.

Parameters:

filename - Workspace file name

Returns:

the revisions

Throws:

java.lang.Exception - On error

getHistory

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

Returns the file's revision history.

Parameters:

filename - Workspace file name

count - Maximum number of revisions to return

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 - An AQRevision object or a SHA-1 hash of a commit, obtained via AQRevision.getRevision()

Returns:

the revision content

Throws:

java.lang.Exception - On error

merge

void merge(java.lang.Object revision)
    throws java.lang.Exception

Performs a very basic merge operation, which allows only one argument. Currently, this command supports only fast forward merge.

Parameters:

revision - An AQRevision object or a SHA-1 hash of a commit, obtained via AQRevision.getRevision() which is merged with the current head

Throws:

java.lang.Exception - On error

clone

void clone(java.lang.String folder,
           java.lang.String url,
           java.lang.String branch)
    throws java.lang.Exception

Clones a repository into a new directory.

Parameters:

folder - Destination folder

url - Repository URL, protocol://host/path/to/repo.git

branch - (Optional) branch name. An empty branch name (or null) selects the repository HEAD

Throws:

java.lang.Exception - On error

fetch

void fetch()
    throws java.lang.Exception

Downloads objects and refs from the default remote 'origin'.

Throws:

java.lang.Exception - On error

fetch

void fetch(java.lang.String remote)
    throws java.lang.Exception

Downloads objects and refs from the specified remote repository.

Parameters:

remote - the remote to fetch from

Throws:

java.lang.Exception - On error

pull

void pull()
   throws java.lang.Exception

Incorporates changes from a remote repository into the current branch. In its default mode, git pull is shorthand for git fetch followed by git merge FETCH_HEAD.

Throws:

java.lang.Exception - On error

init

void init(java.lang.String folder,
          boolean bare)
   throws java.lang.Exception

Creates an empty git repository or reinitialize an existing one.

Parameters:

folder - the folder

bare - When true, creates a bare repository.

Throws:

java.lang.Exception - On error

push

void push()
   throws java.lang.Exception

Push new branches and data to a remote repository.

Throws:

java.lang.Exception - On error

reset

void reset(java.lang.String ref,
           java.lang.String mode,
           java.lang.String filename)
    throws java.lang.Exception

Undo changes and commits.

Parameters:

ref - A reference to a commit. Points to HEAD if null

mode - The mode. One of "SOFT", "MIXED" or "HARD"

filename - Workspace file name. May be null to indicate all files

Note: the mode and filename parameters cannot be combined.

Throws:

java.lang.Exception - On error

listBranch

java.lang.String[] listBranch()
                       throws java.lang.Exception

Obtain a list of branches

Returns:

a list of branches

Throws:

java.lang.Exception - On error

createBranch

void createBranch(java.lang.String name,
                  java.lang.String ref)
           throws java.lang.Exception

Create a local branch.

Parameters:

name - the name of the new branch

ref - corresponds to the start-point; if null, HEAD will be used

Throws:

java.lang.Exception - On error

checkout

void checkout(java.lang.String name)
       throws java.lang.Exception

Checkout a branch

Parameters:

name - the branch name

Throws:

java.lang.Exception - On error

renameBranch

void renameBranch(java.lang.String oldName,
                  java.lang.String newName)
           throws java.lang.Exception

Rename a branch

Parameters:

oldName - the name of the branch to rename; if not set, the currently checked out branch (if any) will be renamed

newName - the new name

Throws:

java.lang.Exception - On error

deleteBranch

void deleteBranch(java.lang.String... names)
           throws java.lang.Exception

Delete one or more branches.

Parameters:

names - the names of the branches to delete; if not set, this will do nothing; invalid branch names will simply be ignored

Throws:

java.lang.Exception - On error

listTag

java.lang.String[] listTag()
                    throws java.lang.Exception

Obtain a list of tags.

Returns:

the tags

Throws:

java.lang.Exception - On error

tag

void tag(java.lang.Object revision,
         java.lang.String name,
         java.lang.Object username,
         java.lang.Object email,
         java.lang.String comment)
  throws java.lang.Exception

Create a tag.

Parameters:

revision - An AQRevision object or a SHA-1 hash of a commit, obtained via AQRevision.getRevision()

name - the tag name

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

email - A String or a AQOpaqueObject containing the user email address.

comment - the tag message

Throws:

java.lang.Exception - On error

deleteTag

void deleteTag(java.lang.String... tags)
        throws java.lang.Exception

Delete one or more tags.

Parameters:

tags - tags to be deleted

Throws:

java.lang.Exception - On error

rebase

void rebase(java.lang.Object upstream)
     throws java.lang.Exception

The Git rebase command. The current branch is reset to <upstream>.

Parameters:

upstream - A branch name, an AQRevision object or a SHA-1 hash of a commit, obtained via AQRevision.getRevision()

If the operation fails (i.e. due to a merge conflict), a RuntimeException will be thrown.

Throws:

java.lang.Exception - On error

rebaseContinue

void rebaseContinue()
             throws java.lang.Exception

Continue the rebase process.

Throws:

java.lang.Exception - On error

rebaseSkip

void rebaseSkip()
         throws java.lang.Exception

Skip the rebase process.

Throws:

java.lang.Exception - On error

rebaseAbort

void rebaseAbort()
          throws java.lang.Exception

Abort the rebase process.

Throws:

java.lang.Exception - On error

listRemote

java.lang.String[] listRemote()
                       throws java.lang.Exception

List remotes.

Returns:

the remotes

Throws:

java.lang.Exception - On error

addRemote

void addRemote(java.lang.String name,
               java.lang.String url)
        throws java.lang.Exception

Add a remote.

Parameters:

name - the remote name

url - the remote url, protocol://host/path/to/repo.git

Throws:

java.lang.Exception - On error

removeRemote

void removeRemote(java.lang.String name)
           throws java.lang.Exception

Remove a remote.

Parameters:

name - the remote name

Throws:

java.lang.Exception - On error

trackRemote

void trackRemote(java.lang.String localBranch,
                 java.lang.String remoteBranch)
          throws java.lang.Exception

Track remote branch.

Parameters:

localBranch - the local branch

remoteBranch - the remote branch. Use null to remove remote branch tracking from local branch

Throws:

java.lang.Exception - On error

cherryPick

void cherryPick(java.lang.Object revision)
         throws java.lang.Exception

Integrates an individual commit into the current branch.

Parameters:

revision - An AQRevision object or a SHA-1 hash of a commit, obtained via AQRevision.getRevision()

If the operation fails (i.e. due to a merge conflict), a RuntimeException will be thrown.

Throws:

java.lang.Exception - On error

listStash

AQRevision[] listStash()
                throws java.lang.Exception

Return a list of stash commits

Returns:

the revisions

Throws:

java.lang.Exception - On error

createStash

void createStash(java.lang.Object username,
                 java.lang.Object email,
                 java.lang.String indexMessage,
                 java.lang.String workingMessage)
          throws java.lang.Exception

Stash all current changes and return working tree to a clean state. Changes can be either in staging area or working copy.

Parameters:

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

email - A String or a AQOpaqueObject containing the user email address.

indexMessage - the message used when committing index changes

workingMessage - the message used when committing working directory changes

Throws:

java.lang.Exception - On error

applyStash

void applyStash(java.lang.String ref)
         throws java.lang.Exception

Apply a stashed commit on top of the current working tree.

Parameters:

ref - the reference (stash@{x}) to update with the stashed commit id. Use null for all stashes

Throws:

java.lang.Exception - On error

dropStash

void dropStash(int stashRef)
        throws java.lang.Exception

Delete a stashed commit.

Parameters:

stashRef - Set the stash reference to drop (0-based)

Throws:

java.lang.Exception - On error

log

AQRevision[] log(java.lang.Object start,
                 int count)
          throws java.lang.Exception

Obtain the log.

Parameters:

start - a commit to start graph traversal from. Use null for HEAD

count - the number of commits to obtain. Use -1 for all

Returns:

the logs

Throws:

java.lang.Exception - On error

status

AQGitStatus status()
            throws java.lang.Exception

Obtain the Git repo status.

Returns:

the status

Throws:

java.lang.Exception - On error

revert

void revert(java.lang.Object commits)
     throws java.lang.Exception

Create a commit with the reverse patch to cancel it out.

Parameters:

commits - an AQRevision object or a SHA-1 hash of a commit, obtained via AQRevision.getRevision(), or a list of such objects.

Throws:

java.lang.Exception - On error

clean

java.lang.String[] clean(java.lang.Object files,
                         boolean dryRun)
                  throws java.lang.Exception

Remove untracked files from the working tree.

Parameters:

files - a file name, or a javascript array of file names, or null for all untracked files

dryRun - if it is set, the files in question will not actually be deleted

Returns:

a set of strings representing each file cleaned.

Throws:

java.lang.Exception - On error