Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHRepositoryForkBuilder

java.lang.Object

org.kohsuke.github.GHRepositoryForkBuilder

public class GHRepositoryForkBuilder
extends Object

A builder pattern object for creating a fork of a repository.

See Also:

• GHRepository#createFork()GHRepository#createFork()
• Repository fork API

Method Summary

Modifier and Type	Method	Description
GHRepository	create()	Creates the fork with the specified parameters.
GHRepositoryForkBuilder	defaultBranchOnly(boolean defaultBranchOnly)	Sets whether to fork only the default branch.
GHRepositoryForkBuilder	name(String name)	Sets a custom name for the forked repository.
GHRepositoryForkBuilder	organization(GHOrganization organization)	Specifies the target organization for the fork.

Methods inherited from class java.lang.Object

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

Method Details

defaultBranchOnly

public GHRepositoryForkBuilder defaultBranchOnly(boolean defaultBranchOnly)

Sets whether to fork only the default branch.

Parameters:

defaultBranchOnly - the default branch only

Returns:

the gh repository fork builder

organization

public GHRepositoryForkBuilder organization(GHOrganization organization)

Specifies the target organization for the fork.

Parameters:

organization - the organization

Returns:

the gh repository fork builder

name

public GHRepositoryForkBuilder name(String name)

Sets a custom name for the forked repository.

Parameters:

name - the desired repository name

Returns:

the builder

create

public GHRepository create()
                    throws IOException

Creates the fork with the specified parameters.

Returns:

the gh repository

Throws:

IOException - the io exception