net.rcarz.jiraclient.agile

Class AgileResource

java.lang.Object

net.rcarz.jiraclient.agile.AgileResource

Direct Known Subclasses:

Board, Comment, Epic, Issue, IssueType, Priority, Project, Resolution, Sprint, Status, TimeTracking, User, Worklog

public abstract class AgileResource
extends Object

A base class for Agile resources.

Author:

pldupont

See Also:

"https://docs.atlassian.com/jira-software/REST/cloud/"

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_ID
static String	ATTR_NAME
static String	ATTR_SELF
static String	RESOURCE_URI

Constructor Summary

Constructors

Constructor and Description
AgileResource(RestClient restclient, net.sf.json.JSONObject json) Creates a new Agile resource.

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String name) Retrieve the specified attribute as a generic object.
long	getId()
String	getName()
protected static <T extends AgileResource> T	getResource(Class<T> type, Object r, RestClient restclient) Gets an Agile resource from the given object.
protected static <T extends AgileResource> List<T>	getResourceArray(Class<T> type, Object ra, RestClient restclient, String listName) Gets a list of GreenHopper resources from the given object.
protected RestClient	getRestclient()
String	getSelfURL()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_ID

public static final String ATTR_ID

See Also:

Constant Field Values

ATTR_NAME

public static final String ATTR_NAME

See Also:

Constant Field Values

ATTR_SELF

public static final String ATTR_SELF

See Also:

Constant Field Values

RESOURCE_URI

public static final String RESOURCE_URI

See Also:

Constant Field Values

Constructor Detail

AgileResource

public AgileResource(RestClient restclient,
                     net.sf.json.JSONObject json)
              throws JiraException

Creates a new Agile resource.

Parameters:

restclient - REST client instance

json - JSON payload

Throws:

JiraException - when the retrieval fails

Method Detail

getResource

protected static <T extends AgileResource> T getResource(Class<T> type,
                                                         Object r,
                                                         RestClient restclient)
                                                  throws JiraException

Gets an Agile resource from the given object.

Parameters:

type - Resource data type

r - a JSONObject instance

restclient - REST client instance

Returns:

a Resource instance or null if r isn't a JSONObject instance

Throws:

JiraException - when the retrieval fails

getResourceArray

protected static <T extends AgileResource> List<T> getResourceArray(Class<T> type,
                                                                    Object ra,
                                                                    RestClient restclient,
                                                                    String listName)
                                                             throws JiraException

Gets a list of GreenHopper resources from the given object.

Parameters:

type - Resource data type

ra - a JSONArray instance

restclient - REST client instance

listName - The name of the list of items from the JSON result.

Returns:

a list of Resources found in ra

Throws:

JiraException - when the retrieval fails

getId

public long getId()

Returns:

Internal JIRA ID.

getName

public String getName()

Returns:

The resource name.

getSelfURL

public String getSelfURL()

Returns:

The resource URL.

getRestclient

protected RestClient getRestclient()

Returns:

The REST client used to access the current resource.

getAttribute

public Object getAttribute(String name)

Retrieve the specified attribute as a generic object.

Parameters:

name - The name of the attribute to retrieve.

Returns:

The value of the attribute.

toString

public String toString()

Overrides:

toString in class Object