Package org.kohsuke.github

Class GHLabel

java.lang.Object

org.kohsuke.github.GHLabel

public class GHLabel
extends Object

The type GHLabel.

Author:

Kohsuke Kawaguchi

See Also:

Labels, GHIssue#getLabels(), GHRepository#listLabels()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHLabel.Creator	A GHLabelBuilder that creates a new GHLabel Consumer must call done() to create the new instance.
static class	GHLabel.Setter	A GHLabelBuilder that updates a single property per request done() is called automatically after the property is set.
static class	GHLabel.Updater	A GHLabelBuilder that allows multiple properties to be updated per request.

Method Summary

Modifier and Type	Method	Description
void	delete()	Delete this label from the repository.
boolean	equals(Object o)	Equals.
String	getColor()	Color code without leading '#', such as 'f29513'.
String	getDescription()	Purpose of Label.
long	getId()	Gets id.
String	getName()	Gets name.
String	getNodeId()	Gets node id.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
String	getUrl()	Gets url.
int	hashCode()	Hash code.
boolean	isDefault()	If the label is one of the default labels created by GitHub automatically.
GHLabel.Setter	set()	Begins a single property update.
void	setColor(String newColor)	Deprecated. use set() or update() instead
void	setDescription(String newDescription)	Deprecated. use set() or update() instead
GHLabel.Updater	update()	Begins a batch update Consumer must call AbstractBuilder.done() to commit changes.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public long getId()

Gets id.

Returns:

the id

getNodeId

public String getNodeId()

Gets node id.

Returns:

the node id.

getUrl

@Nonnull
public String getUrl()

Gets url.

Returns:

the url

getName

@Nonnull
public String getName()

Gets name.

Returns:

the name

getColor

@Nonnull
public String getColor()

Color code without leading '#', such as 'f29513'.

Returns:

the color

getDescription

@CheckForNull
public String getDescription()

Purpose of Label.

Returns:

the description

isDefault

public boolean isDefault()

If the label is one of the default labels created by GitHub automatically.

Returns:

true if the label is a default one

setColor

@Deprecated
public void setColor(String newColor)
              throws IOException

Deprecated.

use set() or update() instead

Sets color.

Parameters:

newColor - 6-letter hex color code, like "f29513"

Throws:

IOException - the io exception

setDescription

@Deprecated
public void setDescription(String newDescription)
                    throws IOException

Deprecated.

use set() or update() instead

Sets description.

Parameters:

newDescription - Description of label

Throws:

IOException - the io exception

update

@BetaApi
public GHLabel.Updater update()

Begins a batch update Consumer must call AbstractBuilder.done() to commit changes.

Returns:

a GHLabel.Updater

set

@BetaApi
public GHLabel.Setter set()

Begins a single property update.

Returns:

a GHLabel.Setter

delete

public void delete()
            throws IOException

Delete this label from the repository.

Throws:

IOException - the io exception

equals

public boolean equals(Object o)

Equals.

Overrides:

equals in class Object

Parameters:

o - the o

Returns:

true, if successful

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class Object

Returns:

the int

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