Package org.kohsuke.github

Class GHLabel.Updater

java.lang.Object

org.kohsuke.github.GHLabel.Updater

All Implemented Interfaces:

GitHubRequestBuilderDone<GHLabel>

Enclosing class:

GHLabel

@BetaApi
public static class GHLabel.Updater
extends Object

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
GHLabel.Updater	color(String value)	Color.
protected GHLabel.Updater	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 GitHubRequestBuilderDone.done().
GHLabel.Updater	description(String value)	Description.
GHLabel	done()	Finishes a create or update request, committing changes.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHLabel.Updater	name(String value)	Name.
protected GHLabel.Updater	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 Details

requester

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

The requester.

updateInPlace

protected boolean updateInPlace

The update in place.

Method Details

name

@Nonnull
@BetaApi
public GHLabel.Updater name(String value)
                     throws IOException

Name.

Parameters:

value - the value

Returns:

the s

Throws:

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

color

@Nonnull
@BetaApi
public GHLabel.Updater color(String value)
                      throws IOException

Color.

Parameters:

value - the value

Returns:

the s

Throws:

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

description

@Nonnull
@BetaApi
public GHLabel.Updater description(String value)
                            throws IOException

Description.

Parameters:

value - the value

Returns:

the s

Throws:

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

done

@Nonnull
@BetaApi
public GHLabel done()
             throws IOException

Finishes a create or update request, committing changes. This method may update-in-place or not. Either way it returns the resulting instance.

Specified by:

done in interface GitHubRequestBuilderDone<R>

Returns:

an instance with updated current data

Throws:

IOException - if there is an I/O Exception

with

@Nonnull
@BetaApi
protected GHLabel.Updater 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 GitHubRequestBuilderDone.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 GitHubRequestBuilderDone.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 GHLabel.Updater 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 GitHubRequestBuilderDone.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 GitHubRequestBuilderDone.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