Package org.kohsuke.github
Class GHLabel.Setter
- java.lang.Object
-
- org.kohsuke.github.GHLabel.Setter
-
-
Field Summary
Fields Modifier and Type Field Description protected org.kohsuke.github.Requester
requester
The requester.protected boolean
updateInPlace
The update in place.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description S
color(String value)
Color.protected S
continueOrDone()
Chooses whether to return a continuing builder or an updated data record IfAbstractBuilder
is the same asAbstractBuilder
, this method will commit changes after the first value change and return aAbstractBuilder
fromdone()
.S
description(String value)
Description.R
done()
Finishes an update, committing changes.GitHub
getRoot()
Deprecated.For access to theGitHub
instance, use a local copy instead of pulling it out of objects.S
name(String value)
Name.protected S
with(String name, Object value)
Applies a value to a name for this builder.
-
-
-
Field Detail
-
requester
@Nonnull protected final org.kohsuke.github.Requester requester
The requester.
-
updateInPlace
protected boolean updateInPlace
The update in place.
-
-
Method Detail
-
name
@Nonnull @BetaApi public S 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 S 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 S 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 R done() throws IOException
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 S with(@Nonnull String name, Object value) throws IOException
Applies a value to a name for this builder. IfAbstractBuilder
is the same asAbstractBuilder
, this method will commit changes after the first value change and return aAbstractBuilder
fromdone()
. IfAbstractBuilder
is not the same asAbstractBuilder
, this method will return anAbstractBuilder
and 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
@Nonnull @BetaApi protected S continueOrDone() throws IOException
Chooses whether to return a continuing builder or an updated data record IfAbstractBuilder
is the same asAbstractBuilder
, this method will commit changes after the first value change and return aAbstractBuilder
fromdone()
. IfAbstractBuilder
is not the same asAbstractBuilder
, this method will return anAbstractBuilder
and 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 public GitHub getRoot()
Deprecated.For access to theGitHub
instance, use a local copy instead of pulling it out of objects.Get the rootGitHub
instance for this object.- Returns:
- the root
GitHub
instance
-
-