net.rcarz.jiraclient

Class Field

java.lang.Object

net.rcarz.jiraclient.Field

public final class Field
extends Object

Utility functions for translating between JSON and fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.Meta Field metadata structure.
static class	Field.Operation Field update operation.
static class	Field.ValueTuple Value and value type pair.
static class	Field.ValueType Allowed value types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSIGNEE
static String	ATTACHMENT
static String	CHANGE_LOG
static String	CHANGE_LOG_ENTRIES
static String	CHANGE_LOG_ITEMS
static String	COMMENT
static String	COMPONENTS
static String	CREATED_DATE
static String	DATE_FORMAT
static String	DATETIME_FORMAT
static String	DESCRIPTION
static String	DUE_DATE
static String	FIX_VERSIONS
static String	ISSUE_LINKS
static String	ISSUE_TYPE
static String	LABELS
static String	PARENT
static String	PRIORITY
static String	PROJECT
static String	REPORTER
static String	RESOLUTION
static String	RESOLUTION_DATE
static String	SECURITY
static String	STATUS
static String	SUBTASKS
static String	SUMMARY
static String	TIME_ESTIMATE
static String	TIME_SPENT
static String	TIME_TRACKING
static String	TRANSITION_TO_STATUS
static String	UPDATED_DATE
static String	VERSIONS
static String	VOTES
static String	WATCHES
static String	WORKLOG

Method Summary

Modifier and Type	Method and Description
static boolean	getBoolean(Object b) Gets a boolean value from the given object.
static List<Comment>	getComments(Object c, RestClient restclient, String issueKey) Gets a list of comments from the given object.
static Date	getDate(Object d) Gets a date from the given object.
static Date	getDateTime(Object d) Gets a date with a time from the given object.
static Double	getDouble(Object i) Gets an floating-point number from the given object.
static Field.Meta	getFieldMetadata(String name, net.sf.json.JSONObject editmeta) Extracts field metadata from an editmeta JSON object.
static int	getInteger(Object i) Gets an integer from the given object.
static long	getLong(Object i) + * Gets a long from the given object.
static <TK,TV> Map<TK,TV>	getMap(Class<TK> keytype, Class<TV> valtype, Object m) Gets a generic map from the given object.
static List<RemoteLink>	getRemoteLinks(Object c, RestClient restclient) Gets a list of remote links from the given object.
static <T extends Resource> T	getResource(Class<T> type, Object r, RestClient restclient) Gets a JIRA resource from the given object.
static <T extends Resource> T	getResource(Class<T> type, Object r, RestClient restclient, String parentId) Gets a JIRA resource from the given object.
static <T extends Resource> List<T>	getResourceArray(Class<T> type, Object ra, RestClient restclient) Gets a list of JIRA resources from the given object.
static <T extends Resource> List<T>	getResourceArray(Class<T> type, Object ra, RestClient restclient, String parentId) Gets a list of JIRA resources from the given object.
static String	getString(Object s) Gets a string from the given object.
static List<String>	getStringArray(Object sa) Gets a list of strings from the given object.
static TimeTracking	getTimeTracking(Object tt) Gets a time tracking object from the given object.
static List<WorkLog>	getWorkLogs(Object c, RestClient restclient) Gets a list of work logs from the given object.
static net.sf.json.JSONArray	toArray(Iterable iter, String type, String custom) Converts an iterable type to a JSON array.
static Date	toDate(Object value) Converts the given value to a date.
static Object	toJson(String name, Object value, net.sf.json.JSONObject editmeta) Converts the given value to a JSON object.
static Object	toJsonMap(List list) Converts the given map to a JSON object.
static Field.ValueTuple	valueById(String id) Create a value tuple with value type of ID number.
static Field.ValueTuple	valueByKey(String key) Create a value tuple with value type of key.
static Field.ValueTuple	valueByName(String name) Create a value tuple with value type of name.

Methods inherited from class java.lang.Object

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

Field Detail

ASSIGNEE

public static final String ASSIGNEE

See Also:

Constant Field Values

ATTACHMENT

public static final String ATTACHMENT

See Also:

Constant Field Values

CHANGE_LOG

public static final String CHANGE_LOG

See Also:

Constant Field Values

CHANGE_LOG_ENTRIES

public static final String CHANGE_LOG_ENTRIES

See Also:

Constant Field Values

CHANGE_LOG_ITEMS

public static final String CHANGE_LOG_ITEMS

See Also:

Constant Field Values

COMMENT

public static final String COMMENT

See Also:

Constant Field Values

COMPONENTS

public static final String COMPONENTS

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

DUE_DATE

public static final String DUE_DATE

See Also:

Constant Field Values

FIX_VERSIONS

public static final String FIX_VERSIONS

See Also:

Constant Field Values

ISSUE_LINKS

public static final String ISSUE_LINKS

See Also:

Constant Field Values

ISSUE_TYPE

public static final String ISSUE_TYPE

See Also:

Constant Field Values

LABELS

public static final String LABELS

See Also:

Constant Field Values

PARENT

public static final String PARENT

See Also:

Constant Field Values

PRIORITY

public static final String PRIORITY

See Also:

Constant Field Values

PROJECT

public static final String PROJECT

See Also:

Constant Field Values

REPORTER

public static final String REPORTER

See Also:

Constant Field Values

RESOLUTION

public static final String RESOLUTION

See Also:

Constant Field Values

RESOLUTION_DATE

public static final String RESOLUTION_DATE

See Also:

Constant Field Values

STATUS

public static final String STATUS

See Also:

Constant Field Values

SUBTASKS

public static final String SUBTASKS

See Also:

Constant Field Values

SUMMARY

public static final String SUMMARY

See Also:

Constant Field Values

TIME_TRACKING

public static final String TIME_TRACKING

See Also:

Constant Field Values

VERSIONS

public static final String VERSIONS

See Also:

Constant Field Values

VOTES

public static final String VOTES

See Also:

Constant Field Values

WATCHES

public static final String WATCHES

See Also:

Constant Field Values

WORKLOG

public static final String WORKLOG

See Also:

Constant Field Values

TIME_ESTIMATE

public static final String TIME_ESTIMATE

See Also:

Constant Field Values

TIME_SPENT

public static final String TIME_SPENT

See Also:

Constant Field Values

CREATED_DATE

public static final String CREATED_DATE

See Also:

Constant Field Values

UPDATED_DATE

public static final String UPDATED_DATE

See Also:

Constant Field Values

TRANSITION_TO_STATUS

public static final String TRANSITION_TO_STATUS

See Also:

Constant Field Values

SECURITY

public static final String SECURITY

See Also:

Constant Field Values

DATE_FORMAT

public static final String DATE_FORMAT

See Also:

Constant Field Values

DATETIME_FORMAT

public static final String DATETIME_FORMAT

See Also:

Constant Field Values

Method Detail

getBoolean

public static boolean getBoolean(Object b)

Gets a boolean value from the given object.

Parameters:

b - a Boolean instance

Returns:

a boolean primitive or false if b isn't a Boolean instance

getComments

public static List<Comment> getComments(Object c,
                                        RestClient restclient,
                                        String issueKey)

Gets a list of comments from the given object.

Parameters:

c - a JSONObject instance

restclient - REST client instance

issueKey - key of the parent issue

Returns:

a list of comments found in c

getWorkLogs

public static List<WorkLog> getWorkLogs(Object c,
                                        RestClient restclient)

Gets a list of work logs from the given object.

Parameters:

c - a JSONObject instance

restclient - REST client instance

Returns:

a list of work logs found in c

getRemoteLinks

public static List<RemoteLink> getRemoteLinks(Object c,
                                              RestClient restclient)

Gets a list of remote links from the given object.

Parameters:

c - a JSONObject instance

restclient - REST client instance

Returns:

a list of remote links found in c

getDate

public static Date getDate(Object d)

Gets a date from the given object.

Parameters:

d - a string representation of a date

Returns:

a Date instance or null if d isn't a string

getDateTime

public static Date getDateTime(Object d)

Gets a date with a time from the given object.

Parameters:

d - a string representation of a date

Returns:

a Date instance or null if d isn't a string

getDouble

public static Double getDouble(Object i)

Gets an floating-point number from the given object.

Parameters:

i - an Double instance

Returns:

an floating-point number or null if i isn't a Double instance

getInteger

public static int getInteger(Object i)

Gets an integer from the given object.

Parameters:

i - an Integer instance

Returns:

an integer primitive or 0 if i isn't an Integer instance

getLong

public static long getLong(Object i)

+ * Gets a long from the given object. + * + * @param i a Long or an Integer instance + * + * @return a long primitive or 0 if i isn't a Long or an Integer instance +

getMap

public static <TK,TV> Map<TK,TV> getMap(Class<TK> keytype,
                                        Class<TV> valtype,
                                        Object m)

Gets a generic map from the given object.

Parameters:

keytype - Map key data type

valtype - Map value data type

m - a JSONObject instance

Returns:

a Map instance with all entries found in m

getResource

public static <T extends Resource> T getResource(Class<T> type,
                                                 Object r,
                                                 RestClient restclient)

Gets a JIRA 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

getResource

public static <T extends Resource> T getResource(Class<T> type,
                                                 Object r,
                                                 RestClient restclient,
                                                 String parentId)

Gets a JIRA resource from the given object.

Parameters:

type - Resource data type

r - a JSONObject instance

restclient - REST client instance

parentId - id/key of the parent resource

Returns:

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

getString

public static String getString(Object s)

Gets a string from the given object.

Parameters:

s - a String instance

Returns:

a String or null if s isn't a String instance

getStringArray

public static List<String> getStringArray(Object sa)

Gets a list of strings from the given object.

Parameters:

sa - a JSONArray instance

Returns:

a list of strings found in sa

getResourceArray

public static <T extends Resource> List<T> getResourceArray(Class<T> type,
                                                            Object ra,
                                                            RestClient restclient)

Gets a list of JIRA resources from the given object.

Parameters:

type - Resource data type

ra - a JSONArray instance

restclient - REST client instance

Returns:

a list of Resources found in ra

getResourceArray

public static <T extends Resource> List<T> getResourceArray(Class<T> type,
                                                            Object ra,
                                                            RestClient restclient,
                                                            String parentId)

Gets a list of JIRA resources from the given object.

Parameters:

type - Resource data type

ra - a JSONArray instance

restclient - REST client instance

parentId - id/key of the parent resource

Returns:

a list of Resources found in ra

getTimeTracking

public static TimeTracking getTimeTracking(Object tt)

Gets a time tracking object from the given object.

Parameters:

tt - a JSONObject instance

Returns:

a TimeTracking instance or null if tt isn't a JSONObject instance

getFieldMetadata

public static Field.Meta getFieldMetadata(String name,
                                          net.sf.json.JSONObject editmeta)
                                   throws JiraException

Extracts field metadata from an editmeta JSON object.

Parameters:

name - Field name

editmeta - Edit metadata JSON object

Returns:

a Meta instance with field metadata

Throws:

JiraException - when the field is missing or metadata is bad

toDate

public static Date toDate(Object value)

Converts the given value to a date.

Parameters:

value - New field value

Returns:

a Date instance or null

toArray

public static net.sf.json.JSONArray toArray(Iterable iter,
                                            String type,
                                            String custom)
                                     throws JiraException

Converts an iterable type to a JSON array.

Parameters:

iter - Iterable type containing field values

type - Name of the item type

custom - Name of the custom type

Returns:

a JSON-encoded array of items

Throws:

JiraException

toJson

public static Object toJson(String name,
                            Object value,
                            net.sf.json.JSONObject editmeta)
                     throws JiraException,
                            UnsupportedOperationException

Converts the given value to a JSON object.

Parameters:

name - Field name

value - New field value

editmeta - Edit metadata JSON object

Returns:

a JSON-encoded field value

Throws:

JiraException - when a value is bad or field has invalid metadata

UnsupportedOperationException - when a field type isn't supported

toJsonMap

public static Object toJsonMap(List list)

Converts the given map to a JSON object.

Parameters:

list - List of values to be converted

Returns:

a JSON-encoded map

valueByKey

public static Field.ValueTuple valueByKey(String key)

Create a value tuple with value type of key.

Parameters:

key - The key value

Returns:

a value tuple

valueByName

public static Field.ValueTuple valueByName(String name)

Create a value tuple with value type of name.

Parameters:

name - The name value

Returns:

a value tuple

valueById

public static Field.ValueTuple valueById(String id)

Create a value tuple with value type of ID number.

Parameters:

id - The ID number value

Returns:

a value tuple