Package org.kohsuke.github
Class GHLabel.Updater
java.lang.Object
org.kohsuke.github.GHLabel.Updater
- Enclosing class:
- GHLabel
A
GHLabelBuilder that allows multiple properties to be updated per request.
Consumer must call done() to commit changes.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final org.kohsuke.github.RequesterThe requester.protected booleanThe update in place. -
Method Summary
Modifier and TypeMethodDescriptionColor.protected GHLabel.UpdaterChooses whether to return a continuing builder or an updated data record IfAbstractBuilderis the same asAbstractBuilder, this method will commit changes after the first value change and return aAbstractBuilderfromdone().description(String value) Description.done()Finishes an update, committing changes.getRoot()Deprecated.Name.protected GHLabel.UpdaterApplies a value to a name for this builder.
-
Field Details
-
requester
The requester. -
updateInPlace
protected boolean updateInPlaceThe update in place.
-
-
Method Details
-
name
Name.- Parameters:
value- the value- Returns:
- the s
- Throws:
IOException- Signals that an I/O exception has occurred.
-
color
Color.- Parameters:
value- the value- Returns:
- the s
- Throws:
IOException- Signals that an I/O exception has occurred.
-
description
Description.- Parameters:
value- the value- Returns:
- the s
- Throws:
IOException- Signals that an I/O exception has occurred.
-
done
Finishes an update, committing changes. This method may update-in-place or not. Either way it returns the resulting instance.- 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. IfAbstractBuilderis the same asAbstractBuilder, this method will commit changes after the first value change and return aAbstractBuilderfromdone(). IfAbstractBuilderis not the same asAbstractBuilder, this method will return anAbstractBuilderand letting the caller batch together multiple changes and calldone()when they are ready.- Parameters:
name- the name of the fieldvalue- the value of the field- Returns:
- either a continuing builder or an updated data record
- Throws:
IOException- if an I/O error occurs
-
continueOrDone
Chooses whether to return a continuing builder or an updated data record IfAbstractBuilderis the same asAbstractBuilder, this method will commit changes after the first value change and return aAbstractBuilderfromdone(). IfAbstractBuilderis not the same asAbstractBuilder, this method will return anAbstractBuilderand letting the caller batch together multiple changes and calldone()when they are ready.- Returns:
- either a continuing builder or an updated data record
- Throws:
IOException- if an I/O error occurs
-
getRoot
Deprecated.For access to theGitHubinstance, use a local copy instead of pulling it out of objects.Get the rootGitHubinstance for this object.- Returns:
- the root
GitHubinstance
-
GitHubinstance, use a local copy instead of pulling it out of objects.