Package org.kohsuke.github

Class GHRepository.Updater

java.lang.Object

org.kohsuke.github.GHRepository.Updater

Enclosing class:

GHRepository

@BetaApi
public static class GHRepository.Updater
extends Object

A GHRepositoryBuilder that allows multiple properties to be updated per request. Consumer must call done() to commit changes.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.kohsuke.github.Requester	requester	The requester.
protected boolean	updateInPlace	The update in place.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Updater(GHRepository repository)	Instantiates a new updater.

Method Summary

Modifier and Type	Method	Description
S	allowMergeCommit(boolean enabled)	Allow or disallow merging pull requests with a merge commit.
S	allowRebaseMerge(boolean enabled)	Allow or disallow rebase-merging pull requests.
S	allowSquashMerge(boolean enabled)	Allow or disallow squash-merging pull requests.
protected S	continueOrDone()	Chooses whether to return a continuing builder or an updated data record If AbstractBuilder is the same as AbstractBuilder, this method will commit changes after the first value change and return a AbstractBuilder from done().
S	defaultBranch(String branch)	Default repository branch.
S	deleteBranchOnMerge(boolean enabled)	After pull requests are merged, you can have head branches deleted automatically.
S	description(String description)	Description for repository.
GHRepository	done()	Done.
S	downloads(boolean enabled)	Enables downloads.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
S	homepage(String homepage)	Homepage for repository.
S	homepage(URL homepage)	Homepage for repository.
S	issues(boolean enabled)	Enables issue tracker.
S	isTemplate(boolean enabled)	Specifies whether the repository is a template.
S	private_(boolean enabled)	Sets the repository to private.
S	projects(boolean enabled)	Enables projects.
S	visibility(GHRepository.Visibility visibility)	Sets the repository visibility.
S	wiki(boolean enabled)	Enables wiki.
protected S	with(String name, Object value)	Applies a value to a name for this builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

requester

@Nonnull
protected final org.kohsuke.github.Requester requester

The requester.

updateInPlace

protected boolean updateInPlace

The update in place.

Constructor Detail

Updater

protected Updater(@Nonnull
                  GHRepository repository)

Instantiates a new updater.

Parameters:

repository - the repository

Method Detail

allowSquashMerge

public S allowSquashMerge(boolean enabled)
                   throws IOException

Allow or disallow squash-merging pull requests.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

allowMergeCommit

public S allowMergeCommit(boolean enabled)
                   throws IOException

Allow or disallow merging pull requests with a merge commit.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

allowRebaseMerge

public S allowRebaseMerge(boolean enabled)
                   throws IOException

Allow or disallow rebase-merging pull requests.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

deleteBranchOnMerge

public S deleteBranchOnMerge(boolean enabled)
                      throws IOException

After pull requests are merged, you can have head branches deleted automatically.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

defaultBranch

public S defaultBranch(String branch)
                throws IOException

Default repository branch.

Parameters:

branch - branch name

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

description

public S description(String description)
              throws IOException

Description for repository.

Parameters:

description - description of repository

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

homepage

public S homepage(URL homepage)
           throws IOException

Homepage for repository.

Parameters:

homepage - homepage of repository

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

homepage

public S homepage(String homepage)
           throws IOException

Homepage for repository.

Parameters:

homepage - homepage of repository

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

private_

public S private_(boolean enabled)
           throws IOException

Sets the repository to private.

Parameters:

enabled - private if true

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

visibility

public S visibility(GHRepository.Visibility visibility)
             throws IOException

Sets the repository visibility.

Parameters:

visibility - visibility of repository

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

issues

public S issues(boolean enabled)
         throws IOException

Enables issue tracker.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

projects

public S projects(boolean enabled)
           throws IOException

Enables projects.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

wiki

public S wiki(boolean enabled)
       throws IOException

Enables wiki.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

downloads

public S downloads(boolean enabled)
            throws IOException

Enables downloads.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

isTemplate

@Preview(BAPTISTE)
public S isTemplate(boolean enabled)
             throws IOException

Specifies whether the repository is a template.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

done

public GHRepository done()
                  throws IOException

Done.

Returns:

the GH repository

Throws:

IOException - Signals that an I/O exception has occurred.

with

@Nonnull
@BetaApi
protected S with(@Nonnull
                 String name,
                 Object value)
          throws IOException

Applies a value to a name for this builder. If AbstractBuilder is the same as AbstractBuilder, this method will commit changes after the first value change and return a AbstractBuilder from done(). If AbstractBuilder is not the same as AbstractBuilder, this method will return an AbstractBuilder and letting the caller batch together multiple changes and call done() when they are ready.

Parameters:

name - the name of the field

value - the value of the field

Returns:

either a continuing builder or an updated data record

Throws:

IOException - if an I/O error occurs

continueOrDone

@Nonnull
@BetaApi
protected S continueOrDone()
                    throws IOException

Chooses whether to return a continuing builder or an updated data record If AbstractBuilder is the same as AbstractBuilder, this method will commit changes after the first value change and return a AbstractBuilder from done(). If AbstractBuilder is not the same as AbstractBuilder, this method will return an AbstractBuilder and letting the caller batch together multiple changes and call done() when they are ready.

Returns:

either a continuing builder or an updated data record

Throws:

IOException - if an I/O error occurs

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance