Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHGistBuilder

java.lang.Object

org.kohsuke.github.GHGistBuilder

public class GHGistBuilder
extends Object

Builder pattern for creating a new Gist.

Author:

Kohsuke Kawaguchi

See Also:

• GitHub#createGist()

Constructor Summary

Constructors

Constructor	Description
GHGistBuilder(GitHub root)	Instantiates a new Gh gist builder.

Method Summary

Modifier and Type	Method	Description
GHGist	create()	Creates a Gist based on the parameters specified thus far.
GHGistBuilder	description(String desc)	Description gh gist builder.
GHGistBuilder	file(String fileName, String content)	File gh gist builder.
GHGistBuilder	public_(boolean v)	Public gh gist builder.

Methods inherited from class java.lang.Object

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

Constructor Details

GHGistBuilder

public GHGistBuilder(GitHub root)

Instantiates a new Gh gist builder.

Parameters:

root - the root

Method Details

description

public GHGistBuilder description(String desc)

Description gh gist builder.

Parameters:

desc - the desc

Returns:

the gh gist builder

public_

public GHGistBuilder public_(boolean v)

Public gh gist builder.

Parameters:

v - the v

Returns:

the gh gist builder

file

public GHGistBuilder file(@Nonnull
 String fileName,
 @Nonnull
 String content)

File gh gist builder.

Parameters:

fileName - the file name

content - the content

Returns:

Adds a new file.

create

public GHGist create()
              throws IOException

Creates a Gist based on the parameters specified thus far.

Returns:

created Gist

Throws:

IOException - if Gist cannot be created.