Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHRepositoryVariable.Setter

java.lang.Object

org.kohsuke.github.GHRepositoryVariableBuilder<GHRepositoryVariable>

org.kohsuke.github.GHRepositoryVariable.Setter

All Implemented Interfaces:

GitHubRequestBuilderDone<GHRepositoryVariable>

Enclosing class:

GHRepositoryVariable

@BetaApi
public static class GHRepositoryVariable.Setter
extends GHRepositoryVariableBuilder<GHRepositoryVariable>

A GHRepositoryVariableBuilder that updates a single property per request

GitHubRequestBuilderDone.done() is called automatically after the property is set.

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
protected GHRepositoryVariable	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().
GHRepositoryVariable	done()	Finishes a create or update request, committing changes.
protected GHRepositoryVariable	with(String name, Object value)	Applies a value to a name for this builder.

Methods inherited from class org.kohsuke.github.GHRepositoryVariableBuilder

name, value

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

done

@Nonnull
@BetaApi
public GHRepositoryVariable 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 GHRepositoryVariable 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 GHRepositoryVariable 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