GitRepository (seuac-git-plugin 2.3.0 API)

de.qaware.seu.as.code.plugins.git.GitRepository

The GitRepository class is the value holder object for named Git domain objects.
Authors:
lreimer

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`branch`
`java.io.File`	`directory`
`java.lang.String`	`name`
`GitOptions`	`options`
`java.lang.String`	`password`
`java.lang.String`	`url`
`java.lang.String`	`username`

Constructor Summary

Constructors
Constructor and description
`GitRepository (java.lang.String name)` Required to construct by name.

Methods Summary

Methods
Type	Name and description
`void`	`branch(java.lang.String aBranch)` Short hand method to set the Git branch to use.
`void`	`directory(java.io.File aDirectory)` Short hand method to set the directory.
`void`	`directory(java.lang.String aDirectory)` Short hand method to set the directory name.
`void`	`options(groovy.lang.Closure closure)` Apply the closure to the GitCommandOptions.
`void`	`password(java.lang.String aPassword)` Short hand method to set the password.
`void`	`setSingleBranch(boolean singleBranch)` Setter method to set the single branch only option.
`void`	`singleBranch(boolean singleBranch)` Shorthand method to set the single branch only option.
`void`	`url(java.lang.String aUrl)` Short hand method to set the Git URL.
`void`	`username(java.lang.String aUsername)` Short hand method to set the username.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.lang.String branch
  - java.io.File directory
  - final java.lang.String name
  - final GitOptions options
  - java.lang.String password
  - java.lang.String url
  - java.lang.String username
- Constructor Detail
  - GitRepository(java.lang.String name)
    
    Required to construct by name.
    Parameters:
    name - the repo name
- Method Detail
  - void branch(java.lang.String aBranch)
    
    Short hand method to set the Git branch to use.
    Parameters:
    aBranch - the Git branch name
  - void directory(java.io.File aDirectory)
    
    Short hand method to set the directory.
    Parameters:
    aDirectory - a local directory
  - void directory(java.lang.String aDirectory)
    
    Short hand method to set the directory name.
    Parameters:
    aDirectory - a local directory
  - void options(groovy.lang.Closure closure)
    
    Apply the closure to the GitCommandOptions.
    Parameters:
    closure - the configuration closure
  - void password(java.lang.String aPassword)
    
    Short hand method to set the password.
    Parameters:
    aDirectory - a local directory
  - @java.lang.Deprecated void setSingleBranch(boolean singleBranch)
    
    Setter method to set the single branch only option.
    deprecated:
    use clone options instead
    
    Parameters:
    singleBranch - only clone the single branch
  - @java.lang.Deprecated void singleBranch(boolean singleBranch)
    
    Shorthand method to set the single branch only option.
    deprecated:
    use clone options instead
    
    Parameters:
    singleBranch - only clone the single branch
  - void url(java.lang.String aUrl)
    
    Short hand method to set the Git URL.
    Parameters:
    aUrl - the Git URL
  - void username(java.lang.String aUsername)
    
    Short hand method to set the username.
    Parameters:
    aUsername - the Git username

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GitRepository

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String branch

java.io.File directory

final java.lang.String name

final GitOptions options

java.lang.String password

java.lang.String url

java.lang.String username

Constructor Detail

GitRepository(java.lang.String name)

Method Detail

void branch(java.lang.String aBranch)

void directory(java.io.File aDirectory)

void directory(java.lang.String aDirectory)

void options(groovy.lang.Closure closure)

void password(java.lang.String aPassword)

@java.lang.Deprecated void setSingleBranch(boolean singleBranch)

@java.lang.Deprecated void singleBranch(boolean singleBranch)

void url(java.lang.String aUrl)

void username(java.lang.String aUsername)