Groovy Documentation
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

apply(Project) - Method in GithubPagesPlugin
Applies the plugin to the given project.
author(Closure) - Method in GitCommit
Configures the author for this commit.

B

BasicPasswordCredentials - Class in org.ajoberstar.gradle.git.auth
Basic implementation of PasswordCredentials.
BasicPasswordCredentials(String, String) - Constructor in BasicPasswordCredentials
Constructs credentials with the given arguments.
Branch - Class in org.ajoberstar.gradle.git.api
Represents a Git branch.
branchesToClone(Object) - Method in GitClone
Adds branches to clone if cloneAllBranches is set to false.

C

cloneRepo() - Method in GitClone
Clones a Git repository as configured.
Commit - Class in org.ajoberstar.gradle.git.api
Represents a Git commit.
commit() - Method in GitCommit
Commits changes to the Git repository.
committer(Closure) - Method in GitCommit
Configures the committer for this commit.
credentials(Closure) - Method in GitClone
Configured the credentials to be used when cloning the repo.
credentials(Closure) - Method in GitFetch
Configured the credentials to be used when cloning the repo.
credentials(Closure) - Method in GithubPagesPluginExtension
Configured the credentials to be used when interacting with the repo.
credentials(Closure) - Method in GitPull
Configured the credentials to be used when pulling from the repo.
credentials(Closure) - Method in GitPush
Configures the credentials to use when pushing changes.

D


E

exclude(String) - Method in GitLog
Adds to the list of commits to exclude from the log.
exclude(Closure) - Method in GitSource
{@inheritDoc}

F

fetch() - Method in GitFetch
Fetches remote changes into a local Git repository.

G

getAdded() - Method in GitStatus
Gets all new files added to the index, but not yet commited to HEAD.
getAuthor() - Method in GitCommit
Gets the author for this commit.
getBare() - Method in GitClone
Gets whether the repository will be bare.
getBranch() - Method in GitClone
Gets the branch to checkout if checkout is set to true.
getBranches() - Method in GitBranchList
Gets the branches retrieved by the task.
getBranchesToClone() - Method in GitClone
Gets the branches to clone if cloneAllBranches is set to false.
getBranchName() - Method in GitBranchCreate
Gets the name of the branch to create or update.
getBranchName() - Method in GitCheckout
Gets the branch or commit name to check out.
getBranchType() - Method in GitBranchList
Gets the type of branches to retrieve.
getChanged() - Method in GitStatus
Gets all existing files with changes added to the index, that have not been committed to HEAD.
getCheckFetchedObjects() - Method in GitFetch
Gets whether received objects will be checked for validity.
getCheckout() - Method in GitClone
Gets whether or not to checkout the specified branch.
getCloneAllBranches() - Method in GitClone
Gets whether all branches should be cloned.
getCommitAll() - Method in GitCommit
Gets whether to commit all modified and deleted files.
getCommitter() - Method in GitCommit
Gets the committer to for this commit.
getConflicting() - Method in GitStatus
Gets all files that are in conflict.
getCreateBranch() - Method in GitCheckout
Gets whether the branch being checked out should be created.
getCredentials() - Method in GitClone
Gets the credentials to be used when cloning the repo.
getCredentials() - Method in GitFetch
Gets the credentials to be used when cloning the repo.
getCredentials() - Method in GitPull
Gets the credentials to be used when pulling from the repo.
getCredentials() - Method in GitPush
Gets the credentials to use when pushing changes.
getCredentialsProvider() - Method in JGitCredentialsProviderSupport
Gets a credentials provider.
getDestinationDir() - Method in GitClone
Gets the destination directory the repository will be cloned into.
getDryRun() - Method in GitFetch
Gets whether the fetch operation will be a dry run
getExcludes() - Method in GitLog
Gets the list of commits that will be excluded from the log.
getExcludes() - Method in GitSource
{@inheritDoc}
getFetchTags() - Method in GitFetch
Gets whether tags will be fetched.
getForce() - Method in GitBranchCreate
Gets whether an existing branch will be modified by this task.
getForce() - Method in GitTag
Gets whether or not the tag will be created/updated even if a tag of that name already exists.
getGit() - Method in GitBase
Gets a Git instance for this task's repository.
getIgnored() - Method in GitStatus
Get files that have been ignored and aren't in the index.
getIncludes() - Method in GitLog
Gets the list of commits that will be included in the log.
getIncludes() - Method in GitSource
{@inheritDoc}
getLocalBranch() - Method in GitBranchTrackingStatus
Gets the name of the local branch the status will be retrieved for.
getLog() - Method in GitLog
Gets the resulting log from this task.
getMaxCommits() - Method in GitLog
Gets the maximum number of commits to get from the commit log.
getMessage() - Method in GitCommit
Gets the commit message to use.
getMessage() - Method in GitTag
Gets the tag message to use.
getMissing() - Method in GitStatus
Get files that have been deleted from the filesystem, but have not been removed from the index yet.
getMode() - Method in GitBranchCreate
Gets the tracking mode of the branch.
getMode() - Method in GitReset
Gets the reset mode.
getModified() - Method in GitStatus
Gets all existing files that have been modified, but the changes aren't in the index.
getPassword() - Method in BasicPasswordCredentials
{@inheritDoc}
getPaths() - Method in GitClean
Gets the paths to clean.
getPaths() - Method in GitReset
Gets the paths to reset.
getRef() - Method in GitMerge
Gets the ref that will be merges with the current branch.
getRef() - Method in GitReset
Gets the ref to reset.
getRefspecs() - Method in GitFetch
Gets the refspecs of the fetch command.
getRemote() - Method in GitClone
Gets the name used to track the upstream repository.
getRemote() - Method in GitFetch
Gets the name used to track the upstream repository.
getRemote() - Method in GitPush
Gets the remote to push to.
getRemoved() - Method in GitStatus
Gets all files that have been removed from the index.
getRemoveDeletedRefs() - Method in GitFetch
Gets whether refs which no longer exist in the source will be removed
getRepoDir() - Method in GitBase
Gets the directory of the repository.
getRepoUri() - Method in GithubPagesPluginExtension
Gets the URI of the Github repository.
getSign() - Method in GitTag
Gets whether or not the tag will be signed with the tagger's default key.
getSkipCommits() - Method in GitLog
Gets the number of commits from the log to skip before getting the commit output.
getSource() - Method in GitSource
Gets the source files this task will act on.
getStartPoint() - Method in GitBranchCreate
Gets the starting point of the branch.
getStartPoint() - Method in GitCheckout
Gets the start point for the new branch being created.
getStrategy() - Method in GitMerge
Gets the merge strategy.
getTagger() - Method in GitTag
Gets the tagger.
getTagName() - Method in GitTag
Gets the tag name to use.
getThin() - Method in GitFetch
Gets the thin-pack preference for fetch operation
getTrackingStatus() - Method in GitBranchTrackingStatus
Return remote tracking branch status
getUntracked() - Method in GitStatus
Gets all files that have not been ignored or added to the index.
getUntrackedDirs() - Method in GitStatus
Gets all directories that have not been ignored or added to the index.
getUri() - Method in GitClone
Gets the URI of the repo to clone.
getUsername() - Method in BasicPasswordCredentials
{@inheritDoc}
getWorkingBranch() - Method in GitBranchList
Gets the current working branch of this repository.
getWorkingDir() - Method in GithubPagesPluginExtension
Gets the working directory that the repo will be places in.
GitAdd - Class in org.ajoberstar.gradle.git.tasks
Task to add files to a Git repository's staging area.
GitBase - Class in org.ajoberstar.gradle.git.tasks
Base task for all Git commands that are executed on an existing repository.
GitBranchCreate - Class in org.ajoberstar.gradle.git.tasks
Creates a new branch in a Git repository.
GitBranchCreate.Mode - Enum in org.ajoberstar.gradle.git.tasks
Tracking mode for branches.
GitBranchList - Class in org.ajoberstar.gradle.git.tasks
Lists branches in a Git repository.
GitBranchList.BranchType - Enum in org.ajoberstar.gradle.git.tasks
GitBranchTrackingStatus - Class in org.ajoberstar.gradle.git.tasks
Gets the remote tracking status of branche.
GitCheckout - Class in org.ajoberstar.gradle.git.tasks
Task to checkout files and refs
GitClean - Class in org.ajoberstar.gradle.git.tasks
Task to clean the working tree of a local Git repository.
GitClone - Class in org.ajoberstar.gradle.git.tasks
Task to clone a Git repository.
GitCommit - Class in org.ajoberstar.gradle.git.tasks
Task to commit changes to a Git repository.
GitFetch - Class in org.ajoberstar.gradle.git.tasks
Task to fetch named heads or tags from one or more other repositories, along with the objects necessary to complete them.
GithubPagesPlugin - Class in org.ajoberstar.gradle.git.plugins
Plugin to enable publishing to gh-pages branch of Github.
GithubPagesPluginExtension - Class in org.ajoberstar.gradle.git.plugins
Extension for gh-pages specific properties.
GithubPagesPluginExtension(Project) - Constructor in GithubPagesPluginExtension
Constructs the plugin extension.
GitLog - Class in org.ajoberstar.gradle.git.tasks
Task to get the commit log of a local Git repository.
GitMerge - Class in org.ajoberstar.gradle.git.tasks
Task to join two or more development histories together.
gitNameToBranch(Repository, String) - Method in GitUtil
Build Branch object from git name
GitPull - Class in org.ajoberstar.gradle.git.tasks
Task to incorporate changes from a remote repository into the current branch of a local Git repository.
GitPush - Class in org.ajoberstar.gradle.git.tasks
Task to push changes to a remote repository.
GitReset - Class in org.ajoberstar.gradle.git.tasks
Task to reset the current HEAD of a local Git repository to the specified state.
GitSource - Class in org.ajoberstar.gradle.git.tasks
Base class for Git commands that act upon source files within the repository.
GitStatus - Class in org.ajoberstar.gradle.git.tasks
Gets the status of all files in the repository.
GitTag - Class in org.ajoberstar.gradle.git.tasks
Task to tag a commit in a Git repository.
GitUtil - Class in org.ajoberstar.gradle.git.util
Utility methods for Git objects.

H


I

include(String) - Method in GitLog
Adds to the list of commits to include in the log.
include(Closure) - Method in GitSource
{@inheritDoc}
includeRange(String, String) - Method in GitLog
Adds a range of commits to the include/exclude rules.
isForce() - Method in GitPush
Gets whether to force the push.
isIgnoreUntracked() - Method in GitAdd
Gets whether untracked files should be ignored.
isPushAll() - Method in GitPush
Gets whether to push all branches.
isPushTags() - Method in GitPush
Gets whether tags will also be pushed.

J

JGitCredentialsProviderSupport - Class in org.ajoberstar.gradle.git.auth
Provides support for creating a JGitCredentialsProvider.
JGitCredentialsProviderSupport(AuthenticationSupported) - Constructor in JGitCredentialsProviderSupport

K


L


M

merge() - Method in GitMerge
Merges some changes with the current branch.

N


O

ObjectUtil - Class in org.ajoberstar.gradle.util
Utility class for general Object related operations.

P

pages(Closure) - Method in GithubPagesPluginExtension
Configures the gh-pages copy spec.
paths(Iterable) - Method in GitClean
Adds paths to be cleaned.
paths(Object) - Method in GitReset
Adds paths to be reset.
patternSet - Field in GitSource
Person - Class in org.ajoberstar.gradle.git.api
Represents a Git commit.
pullRepo() - Method in GitPull
Pulls changes from a remote Git repository and merges them into the current branch.
push() - Method in GitPush
Pushes changes to a remote repository.

Q


R

refspecs(Object) - Method in GitFetch
Adds refspecs to fetch from the remote repository.
refToBranch(Repository, Ref) - Method in GitUtil
Converts JGit's Ref to Branch object
reset() - Method in GitClean
Reset the changes as configured.
reset() - Method in GitLog
Gets the commit log and stores it in a project property as configured.
reset() - Method in GitReset
Reset the changes as configured.
revCommitToCommit(RevCommit) - Method in GitUtil
Converts a JGit RevCommit to a Commit.

S

setAuthor(PersonIdent) - Method in GitCommit
Sets the author for this commit.
setBare(boolean) - Method in GitClone
Sets whether the repository will be bare.
setBranch(Object) - Method in GitClone
Sets the branch to checkout if checkout is set to true.
setBranchesToClone(Collection) - Method in GitClone
Sets branches to clone if cloneAllBranches is set to false.
setBranchName(String) - Method in GitBranchCreate
Sets the name of the branch to create or update.
setBranchName(String) - Method in GitCheckout
Specify the name of the branch or commit to check out, or the new branch name.
setBranchType(GitBranchList.BranchType) - Method in GitBranchList
Sets the type of branches to retrieve.
setCheckFetchedObjects(boolean) - Method in GitFetch
If set to true, the received objects will be checked for validity.
setCheckout(boolean) - Method in GitClone
Sets whether or not to checkout the specified branch.
setCloneAllBranches(boolean) - Method in GitClone
Sets whether all branches should be cloned.
setCommitAll(boolean) - Method in GitCommit
Sets whether to commit all modified and deleted files.
setCommitter(PersonIdent) - Method in GitCommit
Sets the committer for this commit.
setCreateBranch(boolean) - Method in GitCheckout
Specify whether to create a new branch.
setCredentials(PasswordCredentials) - Method in GitClone
Sets the credentials to use when cloning the repo.
setCredentials(PasswordCredentials) - Method in GitFetch
Sets the credentials to use when cloning the repo.
setCredentials(PasswordCredentials) - Method in GitPull
Sets the credentials to use when pulling from the repo.
setCredentials(PasswordCredentials) - Method in GitPush
Sets the credentials to use when pushing changes.
setDestinationPath(Object) - Method in GitClone
Sets the path the repository should be clone into.
setDryRun(boolean) - Method in GitFetch
Sets whether the fetch operation should be a dry run.
setExcludes(List) - Method in GitLog
Sets the list of commits to exclude from the log.
setExcludes(Iterable) - Method in GitSource
{@inheritDoc}
setFetchTags(Object) - Method in GitFetch
Sets the specification of annotated tag behavior during fetch.
setForce(boolean) - Method in GitBranchCreate
Sets whether an existing branch will be modified by this task.
setForce(boolean) - Method in GitPush
Sets whether to force the push.
setForce(boolean) - Method in GitTag
Sets whether or not the tag will be created/updated even if a tag of that name already exists.
setIgnoreUntracked(boolean) - Method in GitAdd
Sets whether untracked files should be ignored.
setIncludes(List) - Method in GitLog
Sets the list of commits to incldue in the log.
setIncludes(Iterable) - Method in GitSource
{@inheritDoc}
setLocalBranch(String) - Method in GitBranchTrackingStatus
Set name of local branch to get remote tracking status
setMaxCommits(int) - Method in GitLog
Sets the maximum number of commits to get from the commit log.
setMessage(Object) - Method in GitCommit
Sets the commit message to use.
setMessage(Object) - Method in GitTag
Sets the tag message to use.
setMode(GitBranchCreate.Mode) - Method in GitBranchCreate
Sets the tracking mode of the branch.
setMode(Object) - Method in GitReset
Sets the reset mode
setPassword(String) - Method in BasicPasswordCredentials
{@inheritDoc}
setPaths(Set) - Method in GitClean
Sets the paths for the clean command.
setPaths(List) - Method in GitReset
Sets the paths for the reset command.
setPushAll(boolean) - Method in GitPush
Sets whether to push all branches.
setPushTags(boolean) - Method in GitPush
Sets whether tags will also be pushed.
setRef(Object) - Method in GitMerge
Sets the ref that will be merged with the current branch.
setRef(Object) - Method in GitReset
Sets the ref to reset.
setRefspecs(List) - Method in GitFetch
Sets refspecs for the fetch command.
setRemote(Object) - Method in GitClone
Sets the name used to track the upstream repository.
setRemote(Object) - Method in GitFetch
Sets the name used to track the upstream repository.
setRemote(Object) - Method in GitPush
Sets the remote to push to.
setRemoveDeletedRefs(boolean) - Method in GitFetch
If set to true, refs which no longer exist in the source will be removed.
setRepoPath(Object) - Method in GitBase
Sets the path to the repository.
setSign(boolean) - Method in GitTag
Sets whether or not the tag will be signed by the tagger's default key.
setSkipCommits(int) - Method in GitLog
Sets the number of commits from the log to skip before getting the commit output.
setStartPoint(String) - Method in GitBranchCreate
Sets the starting point of the branch.
setStartPoint(String) - Method in GitCheckout
Set starting point for the new branch being created.
setStrategy(Object) - Method in GitMerge
Sets the merge strategy
setTagger(PersonIdent) - Method in GitTag
Sets the tagger.
setTagName(Object) - Method in GitTag
Sets the tag name to use.
setThin(boolean) - Method in GitFetch
Sets the thin-pack preference for fetch operation.
setUri(Object) - Method in GitClone
Sets the URI of the repo to clone.
setUsername(String) - Method in BasicPasswordCredentials
{@inheritDoc}
status() - Method in GitStatus

T

tag() - Method in GitTag
Tags the HEAD.
tagger(Closure) - Method in GitTag
Configures the tagger.
TrackingStatus - Class in org.ajoberstar.gradle.git.api
trackingStatuses() - Method in GitBranchTrackingStatus
trackingStatusFromGit(Repository, BranchTrackingStatus) - Method in GitUtil
Converts a JGit BranchTrackingStatus to TrackingStatus.

U

unpack(Object) - Method in ObjectUtil
Unpacks the given object by recursively calling the call() method if the object is a Closure or Callable.
unpackString(Object) - Method in ObjectUtil
Unpacks the given object to its String value.

V


W


X


Y


Z


_


Groovy Documentation