Package org.kohsuke.github

Class GHMilestone

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHMilestone

public class GHMilestone
extends GHObject

The type GHMilestone.

Author:

Yusuke Kokubo

Field Summary

Fields

Modifier and Type	Field	Description
protected String	closed_at	The closed at.

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHMilestone()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this milestone.
void	delete()	Deletes this milestone.
protected String	getApiRoute()	Gets api route.
Date	getClosedAt()	When was this milestone closed?.
int	getClosedIssues()	Gets closed issues.
GHUser	getCreator()	Gets creator.
String	getDescription()	Gets description.
Date	getDueOn()	Gets due on.
URL	getHtmlUrl()	Gets the html url.
int	getNumber()	Gets number.
int	getOpenIssues()	Gets open issues.
GHRepository	getOwner()	Gets owner.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHMilestoneState	getState()	Gets state.
String	getTitle()	Gets title.
void	reopen()	Reopens this milestone.
void	setDescription(String description)	Sets description.
void	setDueOn(Date dueOn)	Sets due on.
void	setTitle(String title)	Sets title.
GHMilestone	wrap(GHRepository repo)	Deprecated.

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

closed_at

protected String closed_at

The closed at.

Constructor Detail

GHMilestone

public GHMilestone()

Method Detail

getOwner

public GHRepository getOwner()

Gets owner.

Returns:

the owner

getCreator

public GHUser getCreator()
                  throws IOException

Gets creator.

Returns:

the creator

Throws:

IOException - the io exception

getDueOn

public Date getDueOn()

Gets due on.

Returns:

the due on

getClosedAt

public Date getClosedAt()
                 throws IOException

When was this milestone closed?.

Returns:

the closed at

Throws:

IOException - the io exception

getTitle

public String getTitle()

Gets title.

Returns:

the title

getDescription

public String getDescription()

Gets description.

Returns:

the description

getClosedIssues

public int getClosedIssues()

Gets closed issues.

Returns:

the closed issues

getOpenIssues

public int getOpenIssues()

Gets open issues.

Returns:

the open issues

getNumber

public int getNumber()

Gets number.

Returns:

the number

getHtmlUrl

public URL getHtmlUrl()

Gets the html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

the html url

getState

public GHMilestoneState getState()

Gets state.

Returns:

the state

close

public void close()
           throws IOException

Closes this milestone.

Throws:

IOException - the io exception

reopen

public void reopen()
            throws IOException

Reopens this milestone.

Throws:

IOException - the io exception

delete

public void delete()
            throws IOException

Deletes this milestone.

Throws:

IOException - the io exception

setTitle

public void setTitle(String title)
              throws IOException

Sets title.

Parameters:

title - the title

Throws:

IOException - the io exception

setDescription

public void setDescription(String description)
                    throws IOException

Sets description.

Parameters:

description - the description

Throws:

IOException - the io exception

setDueOn

public void setDueOn(Date dueOn)
              throws IOException

Sets due on.

Parameters:

dueOn - the due on

Throws:

IOException - the io exception

getApiRoute

protected String getApiRoute()

Gets api route.

Returns:

the api route

wrap

@Deprecated
public GHMilestone wrap(GHRepository repo)

Deprecated.

Wrap gh milestone.

Parameters:

repo - the repo

Returns:

the gh milestone

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