net.rcarz.jiraclient

Class Version

java.lang.Object

net.rcarz.jiraclient.Resource

net.rcarz.jiraclient.Version

public class Version
extends Resource

Represents a product version.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Version.FluentCreate Used to chain fields to a create action.

Field Summary

Fields inherited from class net.rcarz.jiraclient.Resource

apirev, DEFAULT_API_REV, id, restclient, self

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Version(RestClient restclient, net.sf.json.JSONObject json) Creates a version from a JSON payload.

Method Summary

Modifier and Type	Method and Description
void	copyTo(Project project) Copies the version to the given project
static Version.FluentCreate	create(RestClient restclient, String project) Creates a new JIRA Version.
static Version	get(RestClient restclient, String id) Retrieves the given version record.
String	getDescription()
String	getName()
String	getReleaseDate()
boolean	isArchived()
boolean	isReleased()
void	mergeWith(Version version) Merges the given version with current version
String	toString()

Methods inherited from class net.rcarz.jiraclient.Resource

getApiRev, getAuthUri, getBaseUri, getId, getSelf, getUrl, setApiRev

Methods inherited from class java.lang.Object

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

Constructor Detail

Version

protected Version(RestClient restclient,
                  net.sf.json.JSONObject json)

Creates a version from a JSON payload.

Parameters:

restclient - REST client instance

json - JSON payload

Method Detail

mergeWith

public void mergeWith(Version version)
               throws JiraException

Merges the given version with current version

Parameters:

version - The version to merge

Throws:

JiraException

copyTo

public void copyTo(Project project)
            throws JiraException

Copies the version to the given project

Parameters:

project - The project the version will be copied to

Throws:

JiraException

get

public static Version get(RestClient restclient,
                          String id)
                   throws JiraException

Retrieves the given version record.

Parameters:

restclient - REST client instance

id - Internal JIRA ID of the version

Returns:

a version instance

Throws:

JiraException - when the retrieval fails

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

isArchived

public boolean isArchived()

isReleased

public boolean isReleased()

getReleaseDate

public String getReleaseDate()

getDescription

public String getDescription()

create

public static Version.FluentCreate create(RestClient restclient,
                                          String project)

Creates a new JIRA Version.

Parameters:

restclient - REST client instance

project - Key of the project to create the version in

Returns:

a fluent create instance