net.rcarz.jiraclient

Class Component

java.lang.Object

net.rcarz.jiraclient.Resource

net.rcarz.jiraclient.Component

public class Component
extends Resource

Represents an issue component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Component.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	Component(RestClient restclient, net.sf.json.JSONObject json) Creates a component from a JSON payload.

Method Summary

Modifier and Type	Method and Description
static Component.FluentCreate	create(RestClient restclient, String project) Creates a new JIRA component.
void	delete() Deletes a component from a project.
static Component	get(RestClient restclient, String id) Retrieves the given component record.
String	getDescription()
String	getName()
boolean	isAssigneeTypeValid()
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

Component

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

Creates a component from a JSON payload.

Parameters:

restclient - REST client instance

json - JSON payload

Method Detail

get

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

Retrieves the given component record.

Parameters:

restclient - REST client instance

id - Internal JIRA ID of the component

Returns:

a component instance

Throws:

JiraException - when the retrieval fails

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

getDescription

public String getDescription()

isAssigneeTypeValid

public boolean isAssigneeTypeValid()

create

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

Creates a new JIRA component.

Parameters:

restclient - REST client instance

project - Key of the project to create the component in

Returns:

a fluent create instance

delete

public void delete()
            throws JiraException

Deletes a component from a project.

Throws:

JiraException - failed to delete the component